Communication Services - Update
Операция обновления существующего CommunicationService.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}?api-version=2026-03-18
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
communication
|
path | True |
string minLength: 1maxLength: 63 pattern: ^[-\w]+$ |
Имя ресурса CommunicationService. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя регистронезависимо. |
|
subscription
|
path | True |
string (uuid) |
Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID). |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| identity |
Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения |
|
| properties.disableLocalAuth |
boolean |
Отключите локальную проверку подлинности для CommunicationService. |
| properties.linkedDomains |
string[] |
Список идентификаторов ресурса домена электронной почты. |
| properties.publicNetworkAccess |
Разрешить, запретить или разрешить конфигурации периметра безопасности сети управлять общедоступным доступом к защищенному ресурсу. Значение является необязательным, но если оно передано, оно должно быть 'Enabled', 'Disabled' или 'SecuredByPerimeter'. |
|
| tags |
object |
Теги службы, которая представляет собой список пар ключевых значений, описывающих ресурс. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Операция Azure успешно завершена. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Azure Active Directory OAuth2 Flow.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
Update resource
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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"
}
}
Определения
| Имя | Описание |
|---|---|
|
Communication |
Класс, представляющий ресурс CommunicationService. |
|
Communication |
Класс, представляющий параметры обновления ресурса CommunicationService. |
|
Communication |
Состояние подготовки ресурса. |
|
created |
Тип удостоверения, создавшего ресурс. |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Ответ на ошибку |
|
Managed |
Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения |
|
Managed |
Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). |
|
Public |
Разрешить, запретить или разрешить конфигурации периметра безопасности сети управлять общедоступным доступом к защищенному ресурсу. Значение является необязательным, но если оно передано, оно должно быть 'Enabled', 'Disabled' или 'SecuredByPerimeter'. |
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
|
User |
Свойства назначаемого пользователем удостоверения |
CommunicationServiceResource
Класс, представляющий ресурс CommunicationService.
| Имя | Тип | Описание |
|---|---|---|
| id |
string (arm-id) |
Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| identity |
Удостоверения управляемой службы, назначенные этому ресурсу. |
|
| location |
string |
Географическое расположение, в котором находится ресурс |
| name |
string |
Имя ресурса |
| properties.dataLocation |
string |
Расположение, в котором служба коммуникации хранит неактивные данные. |
| properties.disableLocalAuth |
boolean |
Отключите локальную проверку подлинности для CommunicationService. |
| properties.hostName |
string |
FQDN экземпляра CommunicationService. |
| properties.immutableResourceId |
string |
Идентификатор неизменного ресурса коммуникационной службы. |
| properties.linkedDomains |
string[] |
Список идентификаторов ресурса домена электронной почты. |
| properties.notificationHubId |
string |
Идентификатор ресурса Azure Notification Hub, связанный с этим ресурсом. |
| properties.provisioningState |
Состояние подготовки ресурса. |
|
| properties.publicNetworkAccess |
Разрешить, запретить или разрешить конфигурации периметра безопасности сети управлять общедоступным доступом к защищенному ресурсу. Значение является необязательным, но если оно передано, оно должно быть 'Enabled', 'Disabled' или 'SecuredByPerimeter'. |
|
| properties.version |
string |
Версия ресурса CommunicationService. Возможно, вам нужна та же или более поздняя версия клиентских пакетов SDK. |
| systemData |
Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. |
|
| tags |
object |
Теги ресурсов. |
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
CommunicationServiceResourceUpdate
Класс, представляющий параметры обновления ресурса CommunicationService.
| Имя | Тип | Описание |
|---|---|---|
| identity |
Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения |
|
| properties.disableLocalAuth |
boolean |
Отключите локальную проверку подлинности для CommunicationService. |
| properties.linkedDomains |
string[] |
Список идентификаторов ресурса домена электронной почты. |
| properties.publicNetworkAccess |
Разрешить, запретить или разрешить конфигурации периметра безопасности сети управлять общедоступным доступом к защищенному ресурсу. Значение является необязательным, но если оно передано, оно должно быть 'Enabled', 'Disabled' или 'SecuredByPerimeter'. |
|
| tags |
object |
Теги службы, которая представляет собой список пар ключевых значений, описывающих ресурс. |
CommunicationServices_ProvisioningState
Состояние подготовки ресурса.
| Значение | Описание |
|---|---|
| Unknown |
Неизвестно |
| Succeeded |
Succeeded |
| Failed |
Неудача |
| Canceled |
Отменено |
| Running |
Бег |
| Creating |
Создавать |
| Updating |
Обновление |
| Deleting |
Удаление |
| Moving |
Трогательный |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения. |
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
ManagedServiceIdentity
Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
| Имя | Тип | Описание |
|---|---|---|
| principalId |
string (uuid) |
Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения. |
| tenantId |
string (uuid) |
Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения. |
| type |
Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). |
|
| userAssignedIdentities |
<string,
User |
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. |
ManagedServiceIdentityType
Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
| Значение | Описание |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned,UserAssigned |
PublicNetworkAccess
Разрешить, запретить или разрешить конфигурации периметра безопасности сети управлять общедоступным доступом к защищенному ресурсу. Значение является необязательным, но если оно передано, оно должно быть 'Enabled', 'Disabled' или 'SecuredByPerimeter'.
| Значение | Описание |
|---|---|
| Enabled |
Обеспечивает публичный сетевой access к ресурсу |
| Disabled |
Запрещает публичный сетевой access к ресурсу |
| SecuredByPerimeter |
Правила конфигурации сетевого периметра разрешают или запрещают публичный сетевой access к ресурсу. Требуется соответствующий сетевой периметр безопасности. |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
UserAssignedIdentity
Свойства назначаемого пользователем удостоверения
| Имя | Тип | Описание |
|---|---|---|
| clientId |
string (uuid) |
Идентификатор клиента назначенного удостоверения. |
| principalId |
string (uuid) |
Основной идентификатор назначенного удостоверения. |