Communication Services - Update

Serviço:: Communication

Versão da API:: 2026-03-18

Operação para atualizar um Serviço de Comunicação existente.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}?api-version=2026-03-18

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
communicationServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[-\w]+$	O nome do recurso CommunicationService.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
identity	ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
properties.disableLocalAuth	boolean	Desative a autenticação local para o CommunicationService.
properties.linkedDomains	string[]	Lista de IDs de recursos de domínio de e-mail.
properties.publicNetworkAccess	PublicNetworkAccess	Permitir, não permitir ou permitir que a configuração do perímetro de segurança da rede controle o acesso da rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Enabled', 'Disabled' ou 'SecuredByPerimeter'.
tags	object	Tags do serviço, que é uma lista de pares de valores de chave que descrevem o recurso.

Respostas

Name	Tipo	Description
200 OK	CommunicationServiceResource	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Update resource

Update resource to add a System Assigned managed identity

Update resource to add a User Assigned managed identity

Update resource to add DisableLocalAuth

Update resource to add PublicNetworkAccess

Update resource to add System and User managed identities

Update resource to remove identity

Update resource

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "identity": {
    "type": "None"
  },
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "hostName": "mycommunicationresource.communications.azure.com",
    "provisioningState": "Succeeded",
    "version": "0.2.0"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Update resource to add a System Assigned managed identity

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "identity": {
    "type": "SystemAssigned"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "11111111-1111-1111-1111-111111111111",
    "tenantId": "22222222-2222-2222-2222-222222222222"
  },
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "hostName": "mycommunicationresource.communications.azure.com",
    "provisioningState": "Succeeded",
    "version": "0.2.0"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Update resource to add a User Assigned managed identity

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/user/assigned/resource/id": {}
    }
  },
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/user/assigned/resource/id": {
        "clientId": "11112222-3333-4444-5555-666677778888",
        "principalId": "11112222-3333-4444-5555-666677778888"
      }
    }
  },
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "hostName": "mycommunicationresource.communications.azure.com",
    "provisioningState": "Succeeded",
    "version": "0.2.0"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Update resource to add DisableLocalAuth

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "properties": {
    "disableLocalAuth": true
  },
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "disableLocalAuth": true,
    "hostName": "mycommunicationresource.communications.azure.com",
    "provisioningState": "Succeeded",
    "version": "0.2.0"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Update resource to add PublicNetworkAccess

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "properties": {
    "publicNetworkAccess": "Enabled"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "hostName": "mycommunicationresource.communications.azure.com",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "version": "0.2.0"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Update resource to add System and User managed identities

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/user/assigned/resource/id": {}
    }
  },
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "11111111-1111-1111-1111-111111111111",
    "tenantId": "22222222-2222-2222-2222-222222222222",
    "userAssignedIdentities": {
      "/user/assigned/resource/id": {
        "clientId": "11112222-3333-4444-5555-666677778888",
        "principalId": "11112222-3333-4444-5555-666677778888"
      }
    }
  },
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "hostName": "mycommunicationresource.communications.azure.com",
    "provisioningState": "Succeeded",
    "version": "0.2.0"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Update resource to remove identity

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2026-03-18

{
  "identity": {
    "type": "None"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "name": "MyCommunicationResource",
  "type": "Microsoft.Communication/CommunicationServices",
  "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
  "location": "Global",
  "properties": {
    "dataLocation": "United States",
    "hostName": "mycommunicationresource.communication.azure.com",
    "provisioningState": "Succeeded"
  },
  "tags": {
    "newTag": "newVal"
  }
}

Definições

Name	Description
CommunicationServiceResource	Uma classe que representa um recurso de Serviços de Comunicação.
CommunicationServiceResourceUpdate	Uma classe que representa parâmetros de atualização para o recurso CommunicationService.
CommunicationServices_ProvisioningState	Estado de provisionamento do recurso.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
PublicNetworkAccess	Permitir, não permitir ou permitir que a configuração do perímetro de segurança da rede controle o acesso da rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Enabled', 'Disabled' ou 'SecuredByPerimeter'.
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

CommunicationServiceResource

Object

Uma classe que representa um recurso de Serviços de Comunicação.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	As identidades de serviço gerenciado atribuídas a este recurso.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.dataLocation	string	O local onde o serviço de comunicação armazena seus dados em repouso.
properties.disableLocalAuth	boolean	Desative a autenticação local para o CommunicationService.
properties.hostName	string	FQDN da instância CommunicationService.
properties.immutableResourceId	string	O ID de recurso imutável do serviço de comunicação.
properties.linkedDomains	string[]	Lista de IDs de recursos de domínio de e-mail.
properties.notificationHubId	string	ID de recurso de um Azure Notification Hub ligado a este recurso.
properties.provisioningState	CommunicationServices_ProvisioningState	Estado de provisionamento do recurso.
properties.publicNetworkAccess	PublicNetworkAccess	Permitir, não permitir ou permitir que a configuração do perímetro de segurança da rede controle o acesso da rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Enabled', 'Disabled' ou 'SecuredByPerimeter'.
properties.version	string	Versão do recurso CommunicationService. Provavelmente você precisa da mesma versão ou superior dos SDKs de cliente.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CommunicationServiceResourceUpdate

Object

Uma classe que representa parâmetros de atualização para o recurso CommunicationService.

Name	Tipo	Description
identity	ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
properties.disableLocalAuth	boolean	Desative a autenticação local para o CommunicationService.
properties.linkedDomains	string[]	Lista de IDs de recursos de domínio de e-mail.
properties.publicNetworkAccess	PublicNetworkAccess	Permitir, não permitir ou permitir que a configuração do perímetro de segurança da rede controle o acesso da rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Enabled', 'Disabled' ou 'SecuredByPerimeter'.
tags	object	Tags do serviço, que é uma lista de pares de valores de chave que descrevem o recurso.

CommunicationServices_ProvisioningState

Enumeração

Estado de provisionamento do recurso.

Valor	Description
Unknown	Desconhecido
Succeeded	Succeeded
Failed	Falha
Canceled	Cancelado
Running	Em Execução
Creating	Criação
Updating	Atualização
Deleting	Apagar
Moving	Mudança

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedServiceIdentity

Object

Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

Name	Tipo	Description
principalId	string (uuid)	O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string (uuid)	O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PublicNetworkAccess

Enumeração

Permitir, não permitir ou permitir que a configuração do perímetro de segurança da rede controle o acesso da rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Enabled', 'Disabled' ou 'SecuredByPerimeter'.

Valor	Description
Enabled	Permite o acesso da rede pública ao recurso
Disabled	Impede o acesso à rede pública ao recurso
SecuredByPerimeter	As regras de configuração do perímetro de segurança da rede permitem ou não o acesso público à rede ao recurso. Requer um perímetro de segurança de rede associado.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Object

Propriedades de identidade atribuídas pelo usuário

Name	Tipo	Description
clientId	string (uuid)	O ID do cliente da identidade atribuída.
principalId	string (uuid)	O ID principal da identidade atribuída.

Partilhar via

Communication Services - Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Update resource

Pedido de amostra

Resposta da amostra

Update resource to add a System Assigned managed identity

Pedido de amostra

Resposta da amostra

Update resource to add a User Assigned managed identity

Pedido de amostra

Resposta da amostra

Update resource to add DisableLocalAuth

Pedido de amostra

Resposta da amostra

Update resource to add PublicNetworkAccess

Pedido de amostra

Resposta da amostra

Update resource to add System and User managed identities

Pedido de amostra

Resposta da amostra

Update resource to remove identity

Pedido de amostra

Resposta da amostra

Definições

CommunicationServiceResource

CommunicationServiceResourceUpdate

CommunicationServices_ProvisioningState

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

PublicNetworkAccess

systemData

UserAssignedIdentity