Dela via


Communication Services - Update

Åtgärd för att uppdatera en befintlig CommunicationService.

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

URI-parametrar

Name I Obligatorisk Typ Description
communicationServiceName
path True

string

Namnet på CommunicationService-resursen.

Reguljärt uttrycksmönster: ^[-\w]+$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

uuid

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Typ Description
identity

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

properties.linkedDomains

string[]

Lista över resurs-ID:t för e-postdomäner.

tags

object

Taggar för tjänsten som är en lista över nyckelvärdepar som beskriver resursen.

Svar

Name Typ Description
200 OK

CommunicationServiceResource

Uppdateringsbegäran lyckades

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
CommunicationServiceResource

En klass som representerar en CommunicationService-resurs.

CommunicationServiceResourceUpdate

En klass som representerar uppdateringsparametrar för CommunicationService-resursen.

CommunicationServices_ProvisioningState

Etableringstillstånd för resursen.

createdByType

Den typ av identitet som skapade resursen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

systemData

Metadata som rör skapande och senaste ändring av resursen.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

CommunicationServiceResource

En klass som representerar en CommunicationService-resurs.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.dataLocation

string

Platsen där kommunikationstjänsten lagrar sina vilande data.

properties.hostName

string

FQDN för CommunicationService-instansen.

properties.immutableResourceId

string

Det oföränderliga resurs-ID:t för kommunikationstjänsten.

properties.linkedDomains

string[]

Lista över resurs-ID:t för e-postdomäner.

properties.notificationHubId

string

Resurs-ID för en Azure Notification Hub som är länkad till den här resursen.

properties.provisioningState

CommunicationServices_ProvisioningState

Etableringstillstånd för resursen.

properties.version

string

Version av CommunicationService-resursen. Förmodligen behöver du samma eller högre version av klient-SDK:er.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

CommunicationServiceResourceUpdate

En klass som representerar uppdateringsparametrar för CommunicationService-resursen.

Name Typ Description
identity

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

properties.linkedDomains

string[]

Lista över resurs-ID:t för e-postdomäner.

tags

object

Taggar för tjänsten som är en lista över nyckelvärdepar som beskriver resursen.

CommunicationServices_ProvisioningState

Etableringstillstånd för resursen.

Name Typ Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Moving

string

Running

string

Succeeded

string

Unknown

string

Updating

string

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name Typ Description
principalId

string

Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

tenantId

string

Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

type

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned identiteter
Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Name Typ Description
clientId

string

Klient-ID för den tilldelade identiteten.

principalId

string

Huvud-ID för den tilldelade identiteten.