Communication Services - Update

Layanan:: Communication

Versi API:: 2026-03-18

Operasi untuk memperbarui CommunicationService yang ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
communicationServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[-\w]+$	Nama sumber daya CommunicationService.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
identity	ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
properties.disableLocalAuth	boolean	Nonaktifkan autentikasi lokal untuk CommunicationService.
properties.linkedDomains	string[]	Daftar Id sumber daya Domain email.
properties.publicNetworkAccess	PublicNetworkAccess	Izinkan, larang, atau biarkan konfigurasi perimeter keamanan jaringan mengontrol akses jaringan publik ke sumber daya yang dilindungi. Nilai bersifat opsional tetapi jika diteruskan, nilai tersebut harus 'Diaktifkan', 'Dinonaktifkan' atau 'SecuredByPerimeter'.
tags	object	Tag layanan yang merupakan daftar pasangan nilai kunci yang menjelaskan sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	CommunicationServiceResource	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:: 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"
  }
}

Definisi

Nama	Deskripsi
CommunicationServiceResource	Kelas yang mewakili sumber daya CommunicationService.
CommunicationServiceResourceUpdate	Kelas yang mewakili parameter pembaruan untuk sumber daya CommunicationService.
CommunicationServices_ProvisioningState	Status provisi sumber daya.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
ManagedServiceIdentityType	Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
PublicNetworkAccess	Izinkan, larang, atau biarkan konfigurasi perimeter keamanan jaringan mengontrol akses jaringan publik ke sumber daya yang dilindungi. Nilai bersifat opsional tetapi jika diteruskan, nilai tersebut harus 'Diaktifkan', 'Dinonaktifkan' atau 'SecuredByPerimeter'.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentity	Properti identitas yang ditetapkan pengguna

CommunicationServiceResource

Objek

Kelas yang mewakili sumber daya CommunicationService.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identitas layanan terkelola yang ditetapkan ke sumber daya ini.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.dataLocation	string	Lokasi tempat layanan komunikasi menyimpan datanya saat tidak aktif.
properties.disableLocalAuth	boolean	Nonaktifkan autentikasi lokal untuk CommunicationService.
properties.hostName	string	FQDN instans CommunicationService.
properties.immutableResourceId	string	Id sumber daya yang tidak dapat diubah dari layanan komunikasi.
properties.linkedDomains	string[]	Daftar Id sumber daya Domain email.
properties.notificationHubId	string	ID Sumber Daya Azure Notification Hub yang ditautkan ke sumber daya ini.
properties.provisioningState	CommunicationServices_ProvisioningState	Status provisi sumber daya.
properties.publicNetworkAccess	PublicNetworkAccess	Izinkan, larang, atau biarkan konfigurasi perimeter keamanan jaringan mengontrol akses jaringan publik ke sumber daya yang dilindungi. Nilai bersifat opsional tetapi jika diteruskan, nilai tersebut harus 'Diaktifkan', 'Dinonaktifkan' atau 'SecuredByPerimeter'.
properties.version	string	Versi sumber daya CommunicationService. Mungkin Anda memerlukan SDK klien versi yang sama atau lebih tinggi.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

CommunicationServiceResourceUpdate

Objek

Kelas yang mewakili parameter pembaruan untuk sumber daya CommunicationService.

Nama	Jenis	Deskripsi
identity	ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
properties.disableLocalAuth	boolean	Nonaktifkan autentikasi lokal untuk CommunicationService.
properties.linkedDomains	string[]	Daftar Id sumber daya Domain email.
properties.publicNetworkAccess	PublicNetworkAccess	Izinkan, larang, atau biarkan konfigurasi perimeter keamanan jaringan mengontrol akses jaringan publik ke sumber daya yang dilindungi. Nilai bersifat opsional tetapi jika diteruskan, nilai tersebut harus 'Diaktifkan', 'Dinonaktifkan' atau 'SecuredByPerimeter'.
tags	object	Tag layanan yang merupakan daftar pasangan nilai kunci yang menjelaskan sumber daya.

CommunicationServices_ProvisioningState

Enumerasi

Status provisi sumber daya.

Nilai	Deskripsi
Unknown	Unknown
Succeeded	Berhasil
Failed	Kegagalan
Canceled	Dibatalkan
Running	Berjalan
Creating	Membuat
Updating	Memperbarui
Deleting	Menghapus
Moving	Bergerak

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ManagedServiceIdentity

Objek

Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)

Nama	Jenis	Deskripsi
principalId	string (uuid)	ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
tenantId	string (uuid)	ID penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
type	ManagedServiceIdentityType	Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
userAssignedIdentities	<string, UserAssignedIdentity>	Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan.

ManagedServiceIdentityType

Enumerasi

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).

Nilai	Deskripsi
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PublicNetworkAccess

Enumerasi

Izinkan, larang, atau biarkan konfigurasi perimeter keamanan jaringan mengontrol akses jaringan publik ke sumber daya yang dilindungi. Nilai bersifat opsional tetapi jika diteruskan, nilai tersebut harus 'Diaktifkan', 'Dinonaktifkan' atau 'SecuredByPerimeter'.

Nilai	Deskripsi
Enabled	Memungkinkan access jaringan publik ke sumber daya
Disabled	Melarang access jaringan publik ke sumber daya
SecuredByPerimeter	Aturan konfigurasi perimeter keamanan jaringan mengizinkan atau tidak mengizinkan access jaringan publik ke sumber daya. Memerlukan perimeter keamanan jaringan terkait.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UserAssignedIdentity

Objek

Properti identitas yang ditetapkan pengguna

Nama	Jenis	Deskripsi
clientId	string (uuid)	ID klien dari identitas yang ditetapkan.
principalId	string (uuid)	ID utama identitas yang ditetapkan.

Bagikan melalui

Communication Services - Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

Update resource

Permintaan sampel

Respon sampel

Update resource to add a System Assigned managed identity

Permintaan sampel

Respon sampel

Update resource to add a User Assigned managed identity

Permintaan sampel

Respon sampel

Update resource to add DisableLocalAuth

Permintaan sampel

Respon sampel

Update resource to add PublicNetworkAccess

Permintaan sampel

Respon sampel

Update resource to add System and User managed identities

Permintaan sampel

Respon sampel

Update resource to remove identity

Permintaan sampel

Respon sampel

Definisi

CommunicationServiceResource

CommunicationServiceResourceUpdate

CommunicationServices_ProvisioningState

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

PublicNetworkAccess

systemData

UserAssignedIdentity