Accounts - Update

Служба:: Azure AI Services

Версия API:: 2024-10-01

Обновляет учетную запись Cognitive Services

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2024-10-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Имя учетной записи Cognitive Services.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Тип	Описание
identity	Identity	Удостоверение ресурса.
kind	string	Тип ресурса.
location	string	Географическое расположение, в котором находится ресурс
properties	AccountProperties	Свойства учетной записи Cognitive Services.
sku	Sku	Определение модели ресурсов, представляющее номер SKU
tags	object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	Account	Поставщик ресурсов должен вернуть 200 (ОК), чтобы указать, что операция выполнена успешно.
202 Accepted	Account	HTTP 202 (принято), если операция успешно запущена и завершится асинхронно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции. Если группа ресурсов или ресурса не существует, 404 (NotFound) следует вернуть.

Примеры

Update Account

Образец запроса

PATCH https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch?api-version=2024-10-01

{
  "location": "global",
  "sku": {
    "name": "S2"
  }
}


import com.azure.resourcemanager.cognitiveservices.models.Account;
import com.azure.resourcemanager.cognitiveservices.models.Sku;

/**
 * Samples for Accounts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * UpdateAccount.json
     */
    /**
     * Sample code: Update Account.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void updateAccount(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        Account resource = manager.accounts()
            .getByResourceGroupWithResponse("bvttest", "bingSearch", com.azure.core.util.Context.NONE).getValue();
        resource.update().withSku(new Sku().withName("S2")).apply();
    }
}

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.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python update_account.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 = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    )

    response = client.accounts.begin_update(
        resource_group_name="bvttest",
        account_name="bingSearch",
        account={"location": "global", "sku": {"name": "S2"}},
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.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 armcognitiveservices_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/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json
func ExampleAccountsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginUpdate(ctx, "bvttest", "bingSearch", armcognitiveservices.Account{
		Location: to.Ptr("global"),
		SKU: &armcognitiveservices.SKU{
			Name: to.Ptr("S2"),
		},
	}, 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.Account = armcognitiveservices.Account{
	// 	Name: to.Ptr("bingSearch"),
	// 	Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
	// 	ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch"),
	// 	Etag: to.Ptr("W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\""),
	// 	Kind: to.Ptr("Bing.Search"),
	// 	Location: to.Ptr("global"),
	// 	Properties: &armcognitiveservices.AccountProperties{
	// 		Endpoint: to.Ptr("https://api.cognitive.microsoft.com/bing/v5.0"),
	// 		ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
	// 	},
	// 	SKU: &armcognitiveservices.SKU{
	// 		Name: to.Ptr("S2"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates a Cognitive Services account
 *
 * @summary Updates a Cognitive Services account
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json
 */
async function updateAccount() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "bvttest";
  const accountName = "bingSearch";
  const account = { location: "global", sku: { name: "S2" } };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.accounts.beginUpdateAndWait(resourceGroupName, accountName, account);
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/UpdateAccount.json
// this example is just showing the usage of "Accounts_Update" 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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "bvttest";
string accountName = "bingSearch";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// invoke the operation
CognitiveServicesAccountData data = new CognitiveServicesAccountData(new AzureLocation("global"))
{
    Sku = new CognitiveServicesSku("S2"),
};
ArmOperation<CognitiveServicesAccountResource> lro = await cognitiveServicesAccount.UpdateAsync(WaitUntil.Completed, data);
CognitiveServicesAccountResource 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
CognitiveServicesAccountData 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

Пример ответа

Код состояния:: 200

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01
azure-AsyncOperation: http://azure.async.operation/status

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
  "name": "bingSearch",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "global",
  "sku": {
    "name": "S2"
  },
  "kind": "Bing.Search",
  "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"",
  "properties": {
    "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
    "provisioningState": "Succeeded"
  }
}

Код состояния:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01
azure-AsyncOperation: http://azure.async.operation/status

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
  "name": "bingSearch",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "global",
  "sku": {
    "name": "S2"
  },
  "kind": "Bing.Search",
  "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"",
  "properties": {
    "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
    "provisioningState": "Succeeded"
  }
}

Определения

Имя	Описание
AbusePenalty	Наказание за злоупотребление.
AbusePenaltyAction	Действие AbusePenalty.
Account	Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, тип, расположение и номер SKU.
AccountProperties	Свойства учетной записи Cognitive Services.
ApiProperties	Свойства API для специальных API.
ByPassSelection	Настройка доверенных служб.
CallRateLimit	Учетная запись Ограничения частоты вызовов Cognitive Services.
CommitmentPlanAssociation	Ассоциация плана обязательств.
createdByType	Тип удостоверения, создавшего ресурс.
Encryption	Свойства для настройки шифрования
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
Identity	Удостоверение ресурса.
IpRule	Правило, которое управляет специальными возможностями из определенного IP-адреса или диапазона IP-адресов.
keySource	Перечисляет возможное значение keySource для шифрования
KeyVaultProperties	Свойства для настройки свойств keyVault
MultiRegionSettings	Учетная запись Cognitive Services с несколькими агрегатами.
NetworkRuleAction	Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.
NetworkRuleSet	Набор правил, определяющих доступность сети.
PrivateEndpoint	Ресурс частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionProperties	Свойства PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
ProvisioningState	Получает состояние учетной записи cognitive services во время вызова операции.
PublicNetworkAccess	Разрешен доступ к общедоступной конечной точке для этой учетной записи.
QuotaLimit
RaiMonitorConfig	Конфигурация монитора Rai в Cognitive Services.
RegionSetting	Учетная запись Ограничения частоты вызовов Cognitive Services.
RequestMatchPattern
ResourceIdentityType	Тип удостоверения.
RoutingMethods	Методы многорегионной маршрутизации.
Sku	Определение модели ресурсов, представляющее номер SKU
SkuCapability	SkuCapability указывает на возможность определенной функции.
SkuChangeInfo	Сведения об изменении номера Sku учетной записи.
SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
ThrottlingRule
UserAssignedIdentity	Назначаемое пользователем управляемое удостоверение.
UserOwnedAmlWorkspace	Пользователь владеет рабочей областью AML для учетной записи Cognitive Services.
UserOwnedStorage	Хранилище, принадлежаемое пользователю для учетной записи Cognitive Services.
VirtualNetworkRule	Правило, которое управляет специальными возможностями из определенной виртуальной сети.

AbusePenalty

Объект

Наказание за злоупотребление.

Имя	Тип	Описание
action	AbusePenaltyAction	Действие AbusePenalty.
expiration	string (date-time)	Дата окончания срока действия приложения AbusePenalty.
rateLimitPercentage	number	Процент ограничения скорости.

AbusePenaltyAction

Перечисление

Действие AbusePenalty.

Значение	Описание
Throttle
Block

Account

Объект

Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, тип, расположение и номер SKU.

Имя	Тип	Описание
etag	string	Etag ресурса.
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Удостоверение ресурса.
kind	string	Тип ресурса.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties	AccountProperties	Свойства учетной записи Cognitive Services.
sku	Sku	Определение модели ресурсов, представляющее номер SKU
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AccountProperties

Объект

Свойства учетной записи Cognitive Services.

Имя	Тип	Описание
abusePenalty	AbusePenalty	Наказание за злоупотребление.
allowedFqdnList	string[]
amlWorkspace	UserOwnedAmlWorkspace	Свойства рабочей области AML, принадлежащие пользователю.
apiProperties	ApiProperties	Свойства API для специальных API.
callRateLimit	CallRateLimit	Учетная запись Ограничения частоты вызовов Cognitive Services.
capabilities	SkuCapability[]	Возвращает возможности учетной записи cognitive services. Каждый элемент указывает на возможность определенной функции. Значения доступны только для чтения и только для ссылок.
commitmentPlanAssociations	CommitmentPlanAssociation[]	Сопоставления планов обязательств учетной записи Cognitive Services.
customSubDomainName	string	Необязательное имя поддомена, используемое для проверки подлинности на основе маркеров.
dateCreated	string	Возвращает дату создания учетной записи Cognitive Services.
deletionDate	string	Дата удаления доступна только для удаленной учетной записи.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	Флаг для включения динамического регулирования.
encryption	Encryption	Свойства шифрования для этого ресурса.
endpoint	string	Конечная точка созданной учетной записи.
endpoints	object
internalId	string	Внутренний идентификатор (не рекомендуется использовать это свойство).
isMigrated	boolean	Если ресурс переносится из существующего ключа.
locations	MultiRegionSettings	Параметры мультирегионирования учетной записи Cognitive Services.
migrationToken	string	Маркер миграции ресурсов.
networkAcls	NetworkRuleSet	Коллекция правил, регулирующих специальные возможности из определенных сетевых расположений.
privateEndpointConnections	PrivateEndpointConnection[]	Подключение частной конечной точки, связанное с учетной записью Cognitive Services.
provisioningState	ProvisioningState	Получает состояние учетной записи cognitive services во время вызова операции.
publicNetworkAccess	PublicNetworkAccess	Разрешен доступ к общедоступной конечной точке для этой учетной записи.
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	Конфигурация монитора Rai в Cognitive Services.
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	Дата запланированной очистки, доступная только для удаленной учетной записи.
skuChangeInfo	SkuChangeInfo	Сведения об изменении номера Sku учетной записи.
userOwnedStorage	UserOwnedStorage[]	Учетные записи хранения для этого ресурса.

ApiProperties

Объект

Свойства API для специальных API.

Имя	Тип	Описание
aadClientId	string maxLength: 500	(Только помощник по метрикам) Идентификатор клиента Azure AD (идентификатор приложения).
aadTenantId	string maxLength: 500	(Только помощник по метрикам) Идентификатор клиента Azure AD.
eventHubConnectionString	string maxLength: 1000 pattern: ^( )Endpoint=sb://(.);( )SharedAccessKeyName=(.);( )SharedAccessKey=(.)$	(Только персонализация) Флаг для включения статистики поиска Bing.
qnaAzureSearchEndpointId	string	(только QnAMaker) Идентификатор конечной точки поиска Azure qnAMaker.
qnaAzureSearchEndpointKey	string	(только QnAMaker) Ключ конечной точки поиска Azure в QnAMaker.
qnaRuntimeEndpoint	string	(только QnAMaker) Конечная точка среды выполнения QnAMaker.
statisticsEnabled	boolean	(Только поиск Bing) Флаг для включения статистики поиска Bing.
storageAccountConnectionString	string maxLength: 1000 pattern: ^(( )DefaultEndpointsProtocol=(http\|https)( );( ))?AccountName=(.)AccountKey=(.)EndpointSuffix=(.)$	(Только персонализация) Строка подключения учетной записи хранения.
superUser	string maxLength: 500	(Только помощник по метрикам) Супер пользователь помощника по метрикам.
websiteName	string maxLength: 500	(Только помощник по метрикам) Имя веб-сайта помощника по метрикам.

ByPassSelection

Перечисление

Настройка доверенных служб.

Значение	Описание
None
AzureServices

CallRateLimit

Объект

Учетная запись Ограничения частоты вызовов Cognitive Services.

Имя	Тип	Описание
count	number	Значение счетчика ограничения частоты звонков.
renewalPeriod	number	Период продления в секундах ограничения частоты звонков.
rules	ThrottlingRule[]

CommitmentPlanAssociation

Объект

Ассоциация плана обязательств.

Имя	Тип	Описание
commitmentPlanId	string	Идентификатор ресурса Azure плана обязательств.
commitmentPlanLocation	string	Расположение плана обязательств.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

Encryption

Объект

Свойства для настройки шифрования

Имя	Тип	Значение по умолчанию	Описание
keySource	keySource	Microsoft.KeyVault	Перечисляет возможное значение keySource для шифрования
keyVaultProperties	KeyVaultProperties		Свойства KeyVault

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

Identity

Объект

Удостоверение ресурса.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта удостоверения ресурса.
tenantId	string	Идентификатор клиента ресурса.
type	ResourceIdentityType	Тип удостоверения.
userAssignedIdentities	<string, UserAssignedIdentity>	Список назначенных пользователем удостоверений, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Объект

Правило, которое управляет специальными возможностями из определенного IP-адреса или диапазона IP-адресов.

Имя	Тип	Описание
value	string	Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78).

keySource

Перечисление

Перечисляет возможное значение keySource для шифрования

Значение	Описание
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Объект

Свойства для настройки свойств keyVault

Имя	Тип	Описание
identityClientId	string
keyName	string	Имя ключа из KeyVault
keyVaultUri	string	Универсальный код ресурса (URI) keyVault
keyVersion	string	Версия ключа из KeyVault

MultiRegionSettings

Объект

Учетная запись Cognitive Services с несколькими агрегатами.

Имя	Тип	Описание
regions	RegionSetting[]	Учетная запись Ограничения частоты вызовов Cognitive Services.
routingMethod	RoutingMethods	Методы многорегионной маршрутизации.

NetworkRuleAction

Перечисление

Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.

Значение	Описание
Allow
Deny

NetworkRuleSet

Объект

Набор правил, определяющих доступность сети.

Имя	Тип	Описание
bypass	ByPassSelection	Настройка доверенных служб.
defaultAction	NetworkRuleAction	Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.
ipRules	IpRule[]	Список правил IP-адресов.
virtualNetworkRules	VirtualNetworkRule[]	Список правил виртуальной сети.

PrivateEndpoint

Объект

Ресурс частной конечной точки.

Имя	Тип	Описание
id	string	Идентификатор ARM для частной конечной точки

PrivateEndpointConnection

Объект

Ресурс подключения к частной конечной точке.

Имя	Тип	Описание
etag	string	Etag ресурса.
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Расположение подключения частной конечной точки
name	string	Имя ресурса
properties	PrivateEndpointConnectionProperties	Свойства ресурса.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Объект

Свойства PrivateEndpointConnectProperties.

Имя	Тип	Описание
groupIds	string[]	Идентификаторы группы ресурсов приватного канала.
privateEndpoint	PrivateEndpoint	Ресурс частной конечной точки.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки ресурса подключения частной конечной точки.

PrivateEndpointConnectionProvisioningState

Перечисление

Текущее состояние подготовки.

Значение	Описание
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Перечисление

Состояние подключения к частной конечной точке.

Значение	Описание
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Объект

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

Имя	Тип	Описание
actionsRequired	string	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения подключения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

ProvisioningState

Перечисление

Получает состояние учетной записи cognitive services во время вызова операции.

Значение	Описание
Accepted
Creating
Deleting
Moving
Failed
Succeeded
ResolvingDNS

PublicNetworkAccess

Перечисление

Разрешен доступ к общедоступной конечной точке для этой учетной записи.

Значение	Описание
Enabled
Disabled

QuotaLimit

Объект

Имя	Тип	Описание
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Объект

Конфигурация монитора Rai в Cognitive Services.

Имя	Тип	Описание
adxStorageResourceId	string	Идентификатор ресурса хранилища.
identityClientId	string	Идентификатор клиента удостоверений для доступа к хранилищу.

RegionSetting

Объект

Учетная запись Ограничения частоты вызовов Cognitive Services.

Имя	Тип	Описание
customsubdomain	string	Сопоставляет регион с региональным пользовательским поддоменом.
name	string	Имя региона.
value	number	Значение для методов маршрутизации с приоритетом или весовым значением.

RequestMatchPattern

Объект

Имя	Тип	Описание
method	string
path	string

ResourceIdentityType

Перечисление

Тип удостоверения.

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

RoutingMethods

Перечисление

Методы многорегионной маршрутизации.

Значение	Описание
Priority
Weighted
Performance

Sku

Объект

Определение модели ресурсов, представляющее номер SKU

Имя	Тип	Описание
capacity	integer (int32)	Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU. Пример - П3. Обычно это код буквы и числа
size	string	Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код.
tier	SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

SkuCapability

Объект

SkuCapability указывает на возможность определенной функции.

Имя	Тип	Описание
name	string	Имя SkuCapability.
value	string	Значение SkuCapability.

SkuChangeInfo

Объект

Сведения об изменении номера Sku учетной записи.

Имя	Тип	Описание
countOfDowngrades	number	Возвращает количество понижений.
countOfUpgradesAfterDowngrades	number	Возвращает количество обновлений после понижения.
lastChangeDate	string	Возвращает дату последнего изменения.

SkuTier

Перечисление

Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

Значение	Описание
Free
Basic
Standard
Premium
Enterprise

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

ThrottlingRule

Объект

Имя	Тип	Описание
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Объект

Назначаемое пользователем управляемое удостоверение.

Имя	Тип	Описание
clientId	string	Идентификатор клиентского приложения, связанный с этим удостоверением.
principalId	string	Идентификатор субъекта Azure Active Directory, связанный с этим удостоверением.

UserOwnedAmlWorkspace

Объект

Пользователь владеет рабочей областью AML для учетной записи Cognitive Services.

Имя	Тип	Описание
identityClientId	string	Идентификатор клиента удостоверения ресурса рабочей области AML.
resourceId	string	Полный идентификатор ресурса рабочей области AML.

UserOwnedStorage

Объект

Хранилище, принадлежаемое пользователю для учетной записи Cognitive Services.

Имя	Тип	Описание
identityClientId	string
resourceId	string	Полный идентификатор ресурса Microsoft.Storage.

VirtualNetworkRule

Объект

Правило, которое управляет специальными возможностями из определенной виртуальной сети.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Игнорировать недостающую конечную точку службы виртуальной сети или нет.
state	string	Возвращает состояние правила виртуальной сети.