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	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	Identity	リソースの ID。
kind	string	リソースの種類。
location	string	リソースが存在する地理的な場所
properties	AccountProperties	Cognitive Services アカウントのプロパティ。
sku	Sku	SKU を表すリソースモデル定義
tags	object	リソースタグ。

応答

名前	型	説明
200 OK	Account	リソースプロバイダーは、操作が正常に完了したことを示す 200 (OK) を返す必要があります。
202 Accepted	Account	操作が正常に開始され、非同期的に完了する場合は HTTP 202 (Accepted)。
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	リソースを作成した ID の種類。
Encryption	暗号化を構成するプロパティ
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Identity	リソースの ID。
IpRule	特定の IP アドレスまたは IP 範囲からのアクセシビリティを制御する規則。
keySource	暗号化の keySource の使用可能な値を列挙します。
KeyVaultProperties	keyVault プロパティを構成するプロパティ
MultiRegionSettings	マルチリージョン設定 Cognitive Services アカウント。
NetworkRuleAction	ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。
NetworkRuleSet	ネットワークアクセシビリティを管理する一連の規則。
PrivateEndpoint	プライベートエンドポイントリソース。
PrivateEndpointConnection	プライベートエンドポイント接続リソース。
PrivateEndpointConnectionProperties	PrivateEndpointConnectProperties のプロパティ。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ProvisioningState	操作が呼び出されたときのコグニティブサービスアカウントの状態を取得します。
PublicNetworkAccess	このアカウントに対してパブリックエンドポイントアクセスが許可されているかどうか。
QuotaLimit
RaiMonitorConfig	Cognitive Services Rai Monitor 構成。
RegionSetting	呼び出しレート制限 Cognitive Services アカウント。
RequestMatchPattern
ResourceIdentityType	ID の種類。
RoutingMethods	マルチリージョンルーティング方法。
Sku	SKU を表すリソースモデル定義
SkuCapability	SkuCapability は、特定の機能の機能を示します。
SkuChangeInfo	アカウントの SKU 変更情報。
SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。
systemData	リソースの作成と最後の変更に関連するメタデータ。
ThrottlingRule
UserAssignedIdentity	ユーザー割り当てマネージド ID。
UserOwnedAmlWorkspace	Cognitive Services アカウント用の AML ワークスペースを所有しているユーザー。
UserOwnedStorage	Cognitive Services アカウントのユーザー所有ストレージ。
VirtualNetworkRule	特定の仮想ネットワークからのアクセシビリティを制御するルール。

AbusePenalty

Object

不正使用のペナルティ。

名前	型	説明
action	AbusePenaltyAction	AbusePenalty のアクション。
expiration	string (date-time)	AbusePenalty の有効期限の日時。
rateLimitPercentage	number	レート制限の割合。

AbusePenaltyAction

列挙

AbusePenalty のアクション。

値	説明
Block
Throttle

Account

Object

Cognitive Services アカウントは、プロビジョニングされたアカウントを表す Azure リソースであり、種類、場所、SKU です。

名前	型	説明
etag	string	リソース Etag。
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	リソースの ID。
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

Object

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	コグニティブサービスアカウントの作成日を取得します。
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	操作が呼び出されたときのコグニティブサービスアカウントの状態を取得します。
publicNetworkAccess	PublicNetworkAccess	このアカウントに対してパブリックエンドポイントアクセスが許可されているかどうか。
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	Cognitive Services Rai Monitor 構成。
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	スケジュールされた消去日。削除されたアカウントでのみ使用できます。
skuChangeInfo	SkuChangeInfo	アカウントの SKU 変更情報。
userOwnedStorage	UserOwnedStorage[]	このリソースのストレージアカウント。

ApiProperties

Object

特殊な API の API プロパティ。

名前	型	説明
aadClientId	string maxLength: 500	(Metrics Advisor のみ)Azure AD クライアント ID (アプリケーション ID)。
aadTenantId	string maxLength: 500	(Metrics Advisor のみ)Azure AD テナント ID。
eventHubConnectionString	string maxLength: 1000 pattern: ^( )Endpoint=sb://(.);( )SharedAccessKeyName=(.);( )SharedAccessKey=(.)$	(パーソナル化のみ)Bing Search の統計情報を有効にするフラグ。
qnaAzureSearchEndpointId	string	(QnAMaker のみ)QnAMaker の Azure Search エンドポイント ID。
qnaAzureSearchEndpointKey	string	(QnAMaker のみ)QnAMaker の Azure Search エンドポイントキー。
qnaRuntimeEndpoint	string	(QnAMaker のみ)QnAMaker のランタイムエンドポイント。
statisticsEnabled	boolean	(Bing検索のみ)Bing Search の統計情報を有効にするフラグ。
storageAccountConnectionString	string maxLength: 1000 pattern: ^(( )DefaultEndpointsProtocol=(http\|https)( );( ))?AccountName=(.)AccountKey=(.)EndpointSuffix=(.)$	(パーソナル化のみ)ストレージアカウントの接続文字列。
superUser	string maxLength: 500	(Metrics Advisor のみ)Metrics Advisor のスーパーユーザー。
websiteName	string maxLength: 500	(Metrics Advisor のみ)Metrics Advisor の Web サイト名。

ByPassSelection

列挙

信頼できるサービスの設定。

値	説明
AzureServices
None

CallRateLimit

Object

呼び出しレート制限 Cognitive Services アカウント。

名前	型	説明
count	number	呼び出しレート制限のカウント値。
renewalPeriod	number	通話レート制限の更新期間 (秒)。
rules	ThrottlingRule[]

CommitmentPlanAssociation

Object

コミットメント計画の関連付け。

名前	型	説明
commitmentPlanId	string	コミットメントプランの Azure リソース ID。
commitmentPlanLocation	string	コミットメント計画の場所。

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

Encryption

Object

暗号化を構成するプロパティ

名前	型	規定値	説明
keySource	keySource	Microsoft.KeyVault	暗号化の keySource の使用可能な値を列挙します。
keyVaultProperties	KeyVaultProperties		KeyVault のプロパティ

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

Identity

Object

リソースの ID。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	ResourceIdentityType	ID の種類。
userAssignedIdentities	<string, UserAssignedIdentity>	リソースに関連付けられているユーザー割り当て ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。

IpRule

Object

特定の IP アドレスまたは IP 範囲からのアクセシビリティを制御する規則。

名前	型	説明
value	string	CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純な IP アドレス) や '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。

keySource

列挙

暗号化の keySource の使用可能な値を列挙します。

値	説明
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Object

keyVault プロパティを構成するプロパティ

名前	型	説明
identityClientId	string
keyName	string	KeyVault からのキーの名前
keyVaultUri	string	KeyVault の URI
keyVersion	string	KeyVault からのキーのバージョン

MultiRegionSettings

Object

マルチリージョン設定 Cognitive Services アカウント。

名前	型	説明
regions	RegionSetting[]	呼び出しレート制限 Cognitive Services アカウント。
routingMethod	RoutingMethods	マルチリージョンルーティング方法。

NetworkRuleAction

列挙

ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。

値	説明
Allow
Deny

NetworkRuleSet

Object

ネットワークアクセシビリティを管理する一連の規則。

名前	型	説明
bypass	ByPassSelection	信頼できるサービスの設定。
defaultAction	NetworkRuleAction	ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。
ipRules	IpRule[]	IP アドレス規則の一覧。
virtualNetworkRules	VirtualNetworkRule[]	仮想ネットワーク規則の一覧。

PrivateEndpoint

Object

プライベートエンドポイントリソース。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子

PrivateEndpointConnection

Object

プライベートエンドポイント接続リソース。

名前	型	説明
etag	string	リソース Etag。
id	string	リソースの完全修飾リソース ID。例 - /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

Object

PrivateEndpointConnectProperties のプロパティ。

名前	型	説明
groupIds	string[]	プライベートリンクリソースグループ ID。
privateEndpoint	PrivateEndpoint	プライベートエンドポイントのリソース。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続リソースのプロビジョニング状態。

PrivateEndpointConnectionProvisioningState

列挙

現在のプロビジョニング状態。

値	説明
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

列挙

プライベートエンドポイント接続の状態。

値	説明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

ProvisioningState

列挙

操作が呼び出されたときのコグニティブサービスアカウントの状態を取得します。

値	説明
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

列挙

このアカウントに対してパブリックエンドポイントアクセスが許可されているかどうか。

値	説明
Disabled
Enabled

QuotaLimit

Object

名前	型	説明
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Object

Cognitive Services Rai Monitor 構成。

名前	型	説明
adxStorageResourceId	string	ストレージリソース ID。
identityClientId	string	ストレージにアクセスするための ID クライアント ID。

RegionSetting

Object

呼び出しレート制限 Cognitive Services アカウント。

名前	型	説明
customsubdomain	string	リージョンをリージョンカスタムサブドメインにマップします。
name	string	リージョンの名前。
value	number	優先順位または重み付けルーティング方法の値。

RequestMatchPattern

Object

名前	型	説明
method	string
path	string

ResourceIdentityType

列挙

ID の種類。

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

列挙

マルチリージョンルーティング方法。

値	説明
Performance
Priority
Weighted

Sku

Object

SKU を表すリソースモデル定義

名前	型	説明
capacity	integer (int32)	SKU でスケールアウト/インがサポートされている場合は、容量の整数を含める必要があります。リソースに対してスケールアウト/インができない場合は、これを省略できます。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前。例 - P3。通常は文字 + 数字のコードです
size	string	SKU サイズ。名前フィールドが層と他の値の組み合わせである場合、これはスタンドアロンコードになります。
tier	SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。

SkuCapability

Object

SkuCapability は、特定の機能の機能を示します。

名前	型	説明
name	string	SkuCapability の名前。
value	string	SkuCapability の値。

SkuChangeInfo

Object

アカウントの SKU 変更情報。

名前	型	説明
countOfDowngrades	number	ダウングレードの数を取得します。
countOfUpgradesAfterDowngrades	number	ダウングレード後のアップグレードの数を取得します。
lastChangeDate	string	最後の変更日を取得します。

SkuTier

列挙

このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。

値	説明
Basic
Enterprise
Free
Premium
Standard

systemData

Object

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

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

ThrottlingRule

Object

名前	型	説明
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Object

ユーザー割り当てマネージド ID。

名前	型	説明
clientId	string	この ID に関連付けられているクライアントアプリ ID。
principalId	string	この ID に関連付けられている Azure Active Directory プリンシパル ID。

UserOwnedAmlWorkspace

Object

Cognitive Services アカウント用の AML ワークスペースを所有しているユーザー。

名前	型	説明
identityClientId	string	AML ワークスペースリソースの ID クライアント ID。
resourceId	string	AML ワークスペースリソースの完全なリソース ID。

UserOwnedStorage

Object

Cognitive Services アカウントのユーザー所有ストレージ。

名前	型	説明
identityClientId	string
resourceId	string	Microsoft.Storage リソースの完全なリソース ID。

VirtualNetworkRule

Object

特定の仮想ネットワークからのアクセシビリティを制御するルール。

名前	型	説明
id	string	'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。
ignoreMissingVnetServiceEndpoint	boolean	不足している vnet サービスエンドポイントを無視します。
state	string	仮想ネットワーク規則の状態を取得します。