Создание или обновление
Создайте службу коммуникации или обновите существующую.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}?api-version=2023-03-31
Параметры URI
| Имя |
В |
Обязательно |
Тип |
Описание |
|
communicationServiceName
|
path |
True
|
string
|
Имя ресурса CommunicationService.
Regex pattern: ^[-\w]+$
|
|
resourceGroupName
|
path |
True
|
string
|
Имя группы ресурсов. Регистр букв в имени не учитывается.
|
|
subscriptionId
|
path |
True
|
string
uuid
|
Идентификатор целевой подписки. Значение должно быть UUID.
|
|
api-version
|
query |
True
|
string
|
Версия API, используемая для данной операции.
|
Текст запроса
| Имя |
Обязательно |
Тип |
Описание |
|
location
|
True
|
string
|
Географическое расположение, в котором находится ресурс
|
|
properties.dataLocation
|
True
|
string
|
Расположение, в котором служба связи хранит неактивные данные.
|
|
properties.linkedDomains
|
|
string[]
|
Список идентификаторов ресурсов домена электронной почты.
|
|
tags
|
|
object
|
Теги ресурсов.
|
Ответы
Примеры
Create or update resource
Sample Request
PUT https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource?api-version=2023-03-31
{
"location": "Global",
"properties": {
"dataLocation": "United States"
}
}
/** Samples for CommunicationServices CreateOrUpdate. */
public final class Main {
/*
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/createOrUpdate.json
*/
/**
* Sample code: Create or update resource.
*
* @param manager Entry point to CommunicationManager.
*/
public static void createOrUpdateResource(com.azure.resourcemanager.communication.CommunicationManager manager) {
manager
.communicationServices()
.define("MyCommunicationResource")
.withRegion("Global")
.withExistingResourceGroup("MyResourceGroup")
.withDataLocation("United States")
.create();
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.communication import CommunicationServiceManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-communication
# USAGE
python create_or_update.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = CommunicationServiceManagementClient(
credential=DefaultAzureCredential(),
subscription_id="11112222-3333-4444-5555-666677778888",
)
response = client.communication_services.begin_create_or_update(
resource_group_name="MyResourceGroup",
communication_service_name="MyCommunicationResource",
parameters={"location": "Global", "properties": {"dataLocation": "United States"}},
).result()
print(response)
# x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/createOrUpdate.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcommunication_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/06042d4ffed6a1ea8319c39cd07ea21efe5d49f7/specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/createOrUpdate.json
func ExampleServicesClient_BeginCreateOrUpdate() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcommunication.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginCreateOrUpdate(ctx, "MyResourceGroup", "MyCommunicationResource", armcommunication.ServiceResource{
Location: to.Ptr("Global"),
Properties: &armcommunication.ServiceProperties{
DataLocation: to.Ptr("United States"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ServiceResource = armcommunication.ServiceResource{
// Name: to.Ptr("MyCommunicationResource"),
// Type: to.Ptr("Microsoft.Communication/CommunicationServices"),
// ID: to.Ptr("/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource"),
// Location: to.Ptr("Global"),
// Properties: &armcommunication.ServiceProperties{
// DataLocation: to.Ptr("United States"),
// HostName: to.Ptr("mycommunicationresource.communications.azure.com"),
// ProvisioningState: to.Ptr(armcommunication.CommunicationServicesProvisioningStateSucceeded),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Create a new CommunicationService or update an existing CommunicationService.
*
* @summary Create a new CommunicationService or update an existing CommunicationService.
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/createOrUpdate.json
*/
async function createOrUpdateResource() {
const subscriptionId =
process.env["COMMUNICATION_SUBSCRIPTION_ID"] || "11112222-3333-4444-5555-666677778888";
const resourceGroupName = process.env["COMMUNICATION_RESOURCE_GROUP"] || "MyResourceGroup";
const communicationServiceName = "MyCommunicationResource";
const parameters = {
dataLocation: "United States",
location: "Global",
};
const credential = new DefaultAzureCredential();
const client = new CommunicationServiceManagementClient(credential, subscriptionId);
const result = await client.communicationServices.beginCreateOrUpdateAndWait(
resourceGroupName,
communicationServiceName,
parameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/createOrUpdate.json
// this example is just showing the usage of "CommunicationServices_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);
// get the collection of this CommunicationServiceResource
CommunicationServiceResourceCollection collection = resourceGroupResource.GetCommunicationServiceResources();
// invoke the operation
string communicationServiceName = "MyCommunicationResource";
CommunicationServiceResourceData data = new CommunicationServiceResourceData(new AzureLocation("Global"))
{
DataLocation = "United States",
};
ArmOperation<CommunicationServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, communicationServiceName, data);
CommunicationServiceResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CommunicationServiceResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
"name": "MyCommunicationResource",
"type": "Microsoft.Communication/CommunicationServices",
"location": "Global",
"properties": {
"dataLocation": "United States",
"provisioningState": "Succeeded",
"hostName": "mycommunicationresource.communications.azure.com"
}
}
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.Communication/locations/westus/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d
{
"id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
"name": "MyCommunicationResource",
"type": "Microsoft.Communication/CommunicationServices",
"location": "Global",
"properties": {
"dataLocation": "United States",
"provisioningState": "Accepted"
}
}
Определения
CommunicationServiceResource
Класс, представляющий ресурс CommunicationService.
| Имя |
Тип |
Описание |
|
id
|
string
|
Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
|
|
location
|
string
|
Географическое расположение, в котором находится ресурс
|
|
name
|
string
|
Имя ресурса.
|
|
properties.dataLocation
|
string
|
Расположение, в котором служба связи хранит неактивные данные.
|
|
properties.hostName
|
string
|
Полное доменное имя экземпляра CommunicationService.
|
|
properties.immutableResourceId
|
string
|
Неизменяемый идентификатор ресурса службы связи.
|
|
properties.linkedDomains
|
string[]
|
Список идентификаторов ресурсов домена электронной почты.
|
|
properties.notificationHubId
|
string
|
Идентификатор ресурса центра уведомлений Azure, связанного с этим ресурсом.
|
|
properties.provisioningState
|
CommunicationServices_ProvisioningState
|
Состояние подготовки ресурса.
|
|
properties.version
|
string
|
Версия ресурса CommunicationService. Возможно, вам нужна та же или более поздняя версия клиентских пакетов SDK.
|
|
systemData
|
systemData
|
Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
|
|
tags
|
object
|
Теги ресурсов.
|
|
type
|
string
|
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.
|
CommunicationServices_ProvisioningState
Состояние подготовки ресурса.
| Имя |
Тип |
Описание |
|
Canceled
|
string
|
|
|
Creating
|
string
|
|
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Moving
|
string
|
|
|
Running
|
string
|
|
|
Succeeded
|
string
|
|
|
Unknown
|
string
|
|
|
Updating
|
string
|
|
createdByType
Тип удостоверения, создавшего ресурс.
| Имя |
Тип |
Описание |
|
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
Сообщение об ошибке
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
| Имя |
Тип |
Описание |
|
createdAt
|
string
|
Метка времени создания ресурса (UTC).
|
|
createdBy
|
string
|
Удостоверение, создающее ресурс.
|
|
createdByType
|
createdByType
|
Тип удостоверения, создавшего ресурс.
|
|
lastModifiedAt
|
string
|
Метка времени последнего изменения ресурса (UTC)
|
|
lastModifiedBy
|
string
|
Удостоверение, которое последним изменял ресурс.
|
|
lastModifiedByType
|
createdByType
|
Тип удостоверения, которое последним изменял ресурс.
|