次の方法で共有


Communication Services - Update

既存の CommunicationService を更新する操作。

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

URI パラメーター

名前 / 必須 説明
communicationServiceName
path True

string

CommunicationService リソースの名前。

正規表現パターン: ^[-\w]+$

resourceGroupName
path True

string

リソース グループの名前。 名前では大文字と小文字が区別されません。

subscriptionId
path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
identity

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

properties.linkedDomains

string[]

電子メール ドメイン リソース ID の一覧。

tags

object

リソースを記述するキー値ペアの一覧であるサービスのタグ。

応答

名前 説明
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"
  }
}

定義

名前 説明
CommunicationServiceResource

CommunicationService リソースを表すクラス。

CommunicationServiceResourceUpdate

CommunicationService リソースの更新パラメーターを表すクラス。

CommunicationServices_ProvisioningState

リソースのプロビジョニング状態。

createdByType

リソースを作成した ID の種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

ManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

systemData

リソースの作成と最後の変更に関連するメタデータ。

UserAssignedIdentity

ユーザー割り当て ID プロパティ

CommunicationServiceResource

CommunicationService リソースを表すクラス。

名前 説明
id

string

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

location

string

リソースが存在する地理的な場所

name

string

リソースの名前

properties.dataLocation

string

通信サービスが保存データを格納する場所。

properties.hostName

string

CommunicationService インスタンスの FQDN。

properties.immutableResourceId

string

通信サービスの変更できないリソース ID。

properties.linkedDomains

string[]

電子メール ドメイン リソース ID の一覧。

properties.notificationHubId

string

このリソースにリンクされている Azure Notification Hub のリソース ID。

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 リソースの更新パラメーターを表すクラス。

名前 説明
identity

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

properties.linkedDomains

string[]

電子メール ドメイン リソース ID の一覧。

tags

object

リソースを記述するキー値ペアの一覧であるサービスのタグ。

CommunicationServices_ProvisioningState

リソースのプロビジョニング状態。

名前 説明
Canceled

string

Creating

string

Deleting

string

Failed

string

Moving

string

Running

string

Succeeded

string

Unknown

string

Updating

string

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

名前 説明
principalId

string

システム割り当て ID のサービス プリンシパル ID。 このプロパティは、システム割り当て ID にのみ提供されます。

tenantId

string

システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID にのみ提供されます。

type

ManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned ID
リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

名前 説明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

UserAssignedIdentity

ユーザー割り当て ID プロパティ

名前 説明
clientId

string

割り当てられた ID のクライアント ID。

principalId

string

割り当てられた ID のプリンシパル ID。