共用方式為


Communication Services - Update

更新現有 CommunicationService 的作業。

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

URI 參數

名稱 位於 必要 類型 Description
communicationServiceName
path True

string

CommunicationService 資源的名稱。

Regex 模式: ^[-\w]+$

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

uuid

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

要用於這項作業的 API 版本。

要求本文

名稱 類型 Description
identity

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

properties.linkedDomains

string[]

電子郵件網域資源標識碼的清單。

tags

object

服務的標記,這是描述資源的索引鍵值組清單。

回應

名稱 類型 Description
200 OK

CommunicationServiceResource

更新要求成功

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

範例

Update resource
Update resource to add a System Assigned managed identity
Update resource to add a User Assigned managed identity
Update resource to add System and User managed identities
Update resource to remove identity

Update resource

範例要求

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

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

範例回覆

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

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=2023-04-01

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

範例回覆

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

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=2023-04-01

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

範例回覆

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

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=2023-04-01

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

範例回覆

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

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=2023-04-01

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

範例回覆

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

定義

名稱 Description
CommunicationServiceResource

代表 CommunicationService 資源的類別。

CommunicationServiceResourceUpdate

類別,表示 CommunicationService 資源的更新參數。

CommunicationServices_ProvisioningState

資源布建狀態。

createdByType

建立資源的身分識別類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

systemData

與建立和上次修改資源相關的元數據。

UserAssignedIdentity

使用者指派的身分識別屬性

CommunicationServiceResource

代表 CommunicationService 資源的類別。

名稱 類型 Description
id

string

資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

identity

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

location

string

資源所在的地理位置

name

string

資源的名稱

properties.dataLocation

string

通訊服務儲存待用數據的位置。

properties.hostName

string

CommunicationService 實例的 FQDN。

properties.immutableResourceId

string

通訊服務的不可變資源標識碼。

properties.linkedDomains

string[]

電子郵件網域資源標識碼的清單。

properties.notificationHubId

string

連結至此資源的 Azure 通知中樞資源識別碼。

properties.provisioningState

CommunicationServices_ProvisioningState

資源布建狀態。

properties.version

string

CommunicationService 資源的版本。 您可能需要相同或更新版本的用戶端 SDK。

systemData

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

tags

object

資源標籤。

type

string

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

CommunicationServiceResourceUpdate

類別,表示 CommunicationService 資源的更新參數。

名稱 類型 Description
identity

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

properties.linkedDomains

string[]

電子郵件網域資源標識碼的清單。

tags

object

服務的標記,這是描述資源的索引鍵值組清單。

CommunicationServices_ProvisioningState

資源布建狀態。

名稱 類型 Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Moving

string

Running

string

Succeeded

string

Unknown

string

Updating

string

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細數據。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

名稱 類型 Description
principalId

string

系統指派身分識別的服務主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string

系統指派身分識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。

type

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 身分識別
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件({})。

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳(UTC)。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

UserAssignedIdentity

使用者指派的身分識別屬性

名稱 類型 Description
clientId

string

指派之身分識別的用戶端標識碼。

principalId

string

指派之身分識別的主體標識碼。