次の方法で共有


Accounts - Update

Cognitive Services アカウントを更新する

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

URI パラメーター

名前 / 必須 説明
accountName
path True

string

Cognitive Services アカウントの名前。

正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

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

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する 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=2023-05-01

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

応答のサンプル

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-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"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-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 プロパティ。

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
RegionSetting

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

RequestMatchPattern
ResourceIdentityType

ID の種類。

RoutingMethods

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

Sku

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

SkuCapability

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

SkuChangeInfo

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

SkuTier

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

systemData

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

ThrottlingRule
UserAssignedIdentity

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

UserOwnedStorage

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

VirtualNetworkRule

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

AbusePenalty

虐待の罰則。

名前 説明
action

AbusePenaltyAction

AbusePenalty のアクション。

expiration

string

AbusePenalty の有効期限の datetime。

rateLimitPercentage

number

レート制限の割合。

AbusePenaltyAction

AbusePenalty のアクション。

名前 説明
Block

string

Throttle

string

Account

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

Cognitive Services アカウントのプロパティ。

名前 説明
abusePenalty

AbusePenalty

虐待の罰則。

allowedFqdnList

string[]

apiProperties

ApiProperties

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

callRateLimit

CallRateLimit

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

capabilities

SkuCapability[]

コグニティブ サービス アカウントの機能を取得します。 各項目は、特定の機能の機能を示します。 値は読み取り専用であり、参照専用です。

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

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

publicNetworkAccess

PublicNetworkAccess

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

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

スケジュールされた消去日。削除されたアカウントでのみ使用できます。

skuChangeInfo

SkuChangeInfo

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

userOwnedStorage

UserOwnedStorage[]

このリソースのストレージ アカウント。

ApiProperties

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

名前 説明
aadClientId

string

(Metrics Advisor のみ)Azure AD クライアント ID (アプリケーション ID)。

aadTenantId

string

(Metrics Advisor のみ)Azure AD テナント ID。

eventHubConnectionString

string

(パーソナル化のみ)Bing 検索の統計を有効にするフラグ。

qnaAzureSearchEndpointId

string

(QnAMaker のみ)QnAMaker の Azure Search エンドポイント ID。

qnaAzureSearchEndpointKey

string

(QnAMaker のみ)QnAMaker の Azure Search エンドポイント キー。

qnaRuntimeEndpoint

string

(QnAMaker のみ)QnAMaker のランタイム エンドポイント。

statisticsEnabled

boolean

(Bing 検索のみ) Bing 検索の統計情報を有効にするフラグ。

storageAccountConnectionString

string

(パーソナル化のみ)ストレージ アカウント接続文字列。

superUser

string

(Metrics Advisor のみ)Metrics Advisor のスーパー ユーザー。

websiteName

string

(Metrics Advisor のみ)Metrics Advisor の Web サイト名。

CallRateLimit

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

名前 説明
count

number

呼び出しレート制限のカウント値。

renewalPeriod

number

通話レート制限の更新期間 (秒単位)。

rules

ThrottlingRule[]

CommitmentPlanAssociation

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

名前 説明
commitmentPlanId

string

コミットメント プランの Azure リソース ID。

commitmentPlanLocation

string

コミットメント 計画の場所。

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

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

error オブジェクト。

Identity

リソースの 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

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

名前 説明
value

string

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

keySource

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

名前 説明
Microsoft.CognitiveServices

string

Microsoft.KeyVault

string

KeyVaultProperties

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

名前 説明
identityClientId

string

keyName

string

KeyVault からのキーの名前

keyVaultUri

string

KeyVault の URI

keyVersion

string

KeyVault からのキーのバージョン

MultiRegionSettings

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

名前 説明
regions

RegionSetting[]

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

routingMethod

RoutingMethods

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

NetworkRuleAction

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

名前 説明
Allow

string

Deny

string

NetworkRuleSet

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

名前 説明
defaultAction

NetworkRuleAction

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

ipRules

IpRule[]

IP アドレス規則の一覧。

virtualNetworkRules

VirtualNetworkRule[]

仮想ネットワーク規則の一覧。

PrivateEndpoint

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

名前 説明
id

string

プライベート エンドポイントの ARM 識別子

PrivateEndpointConnection

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

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

PrivateEndpointConnectProperties のプロパティ。

名前 説明
groupIds

string[]

プライベート リンク リソース グループ ID。

privateEndpoint

PrivateEndpoint

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

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

provisioningState

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続リソースのプロビジョニング状態。

PrivateEndpointConnectionProvisioningState

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

名前 説明
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

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

名前 説明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

名前 説明
actionsRequired

string

サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。

description

string

接続の承認/拒否の理由。

status

PrivateEndpointServiceConnectionStatus

サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。

ProvisioningState

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

名前 説明
Accepted

string

Creating

string

Deleting

string

Failed

string

Moving

string

ResolvingDNS

string

Succeeded

string

PublicNetworkAccess

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

名前 説明
Disabled

string

Enabled

string

QuotaLimit

名前 説明
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RegionSetting

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

名前 説明
customsubdomain

string

リージョンをリージョン カスタム サブドメインにマップします。

name

string

リージョンの名前。

value

number

優先度または重み付けされたルーティング方法の値。

RequestMatchPattern

名前 説明
method

string

path

string

ResourceIdentityType

ID の種類。

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RoutingMethods

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

名前 説明
Performance

string

Priority

string

Weighted

string

Sku

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

名前 説明
capacity

integer

SKU でスケールアウト/インがサポートされている場合は、容量整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。

family

string

サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。

name

string

SKU の名前。 例 - P3。 通常は文字 +数字のコードです

size

string

SKU サイズ。 name フィールドがレベルと他の値の組み合わせである場合、これはスタンドアロン コードになります。

tier

SkuTier

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

SkuCapability

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

名前 説明
name

string

SkuCapability の名前。

value

string

SkuCapability の値。

SkuChangeInfo

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

名前 説明
countOfDowngrades

number

ダウングレードの数を取得します。

countOfUpgradesAfterDowngrades

number

ダウングレード後のアップグレードの数を取得します。

lastChangeDate

string

最後の変更日を取得します。

SkuTier

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

名前 説明
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

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

名前 説明
createdAt

string

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

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

ThrottlingRule

名前 説明
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

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

名前 説明
clientId

string

この ID に関連付けられているクライアント アプリ ID。

principalId

string

この ID に関連付けられている Azure Active Directory プリンシパル ID。

UserOwnedStorage

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

名前 説明
identityClientId

string

resourceId

string

Microsoft.Storage リソースの完全なリソース ID。

VirtualNetworkRule

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

名前 説明
id

string

'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。

ignoreMissingVnetServiceEndpoint

boolean

見つからない vnet サービス エンドポイントを無視するかどうか。

state

string

仮想ネットワーク 規則の状態を取得します。