Share via


Communication Service - Get

Get the CommunicationService and its properties.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}?api-version=2020-08-20

URI Parameters

Name In Required Type Description
communicationServiceName
path True

string

minLength: 1
maxLength: 63
pattern: ^[-\w]+$

The name of the CommunicationService resource.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

CommunicationServiceResource

Success. The response describe the corresponding CommunicationService service.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

Get resource

Sample request

GET https://management.azure.com/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2020-08-20

Sample response

{
  "id": "/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "provisioningState": "Running",
    "hostName": "mycommunicationservice.comms.azure.net",
    "version": "0.2.0"
  }
}
{
  "error": {
    "code": "ResourceNotFound",
    "message": "The requested resource was not found"
  }
}

Definitions

Name Description
CommunicationServiceResource

A class representing a CommunicationService resource.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ProvisioningState

Provisioning state of the resource.

systemData

Metadata pertaining to creation and last modification of the resource.

CommunicationServiceResource

A class representing a CommunicationService resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

The Azure location where the CommunicationService is running.

name

string

The name of the resource

properties.dataLocation

string

The location where the communication service stores its data at rest.

properties.hostName

string

FQDN of the CommunicationService instance.

properties.immutableResourceId

string

The immutable resource Id of the communication service.

properties.notificationHubId

string

Resource ID of an Azure Notification Hub linked to this resource.

properties.provisioningState

ProvisioningState

Provisioning state of the resource.

properties.version

string

Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

tags

object

Tags of the service which is a list of key value pairs that describe the resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ProvisioningState

Provisioning state of the resource.

Value Description
Unknown
Succeeded
Failed
Canceled
Running
Creating
Updating
Deleting
Moving

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.