Deployments - Create Or Update
Cognitive Services アカウントに関連付けられている指定されたデプロイの状態を更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}?api-version=2023-05-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
account
|
path | True |
string |
Cognitive Services アカウントの名前。 正規表現パターン: |
deployment
|
path | True |
string |
Cognitive Services アカウントに関連付けられているデプロイの名前 |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties |
Cognitive Services アカウントの展開のプロパティ。 |
|
sku |
SKU を表すリソース モデル定義 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
デプロイを正常に作成/更新します。 |
|
201 Created |
デプロイを正常に作成します。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
例
PutDeployment
要求のサンプル
PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName?api-version=2023-05-01
{
"sku": {
"name": "Standard",
"capacity": 1
},
"properties": {
"model": {
"format": "OpenAI",
"name": "ada",
"version": "1"
}
}
}
応答のサンプル
{
"id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
"name": "deploymentName",
"type": "Microsoft.CognitiveServices/accounts/deployments",
"sku": {
"name": "Standard",
"capacity": 1
},
"properties": {
"model": {
"format": "OpenAI",
"name": "ada",
"version": "1"
},
"provisioningState": "Succeeded"
}
}
{
"id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
"name": "deploymentName",
"type": "Microsoft.CognitiveServices/accounts/deployments",
"sku": {
"name": "Standard",
"capacity": 1
},
"properties": {
"model": {
"format": "OpenAI",
"name": "ada",
"version": "1"
},
"provisioningState": "Accepted"
}
}
定義
名前 | 説明 |
---|---|
Call |
呼び出しレート制限 Cognitive Services アカウント。 |
created |
リソースを作成した ID の種類。 |
Deployment |
Cognitive Services アカウントのデプロイ。 |
Deployment |
Cognitive Services アカウントデプロイ モデルのプロパティ。 |
Deployment |
デプロイ モデルのバージョン アップグレード オプション。 |
Deployment |
Cognitive Services アカウントの展開のプロパティ。 |
Deployment |
操作が呼び出されたときのリソースの状態を取得します。 |
Deployment |
Cognitive Services アカウントデプロイ モデルのプロパティ。 |
Deployment |
デプロイ スケールの種類。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Request |
|
Sku |
SKU を表すリソース モデル定義 |
Sku |
このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合は、リソース プロバイダーによって実装される必要があります。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Throttling |
CallRateLimit
呼び出しレート制限 Cognitive Services アカウント。
名前 | 型 | 説明 |
---|---|---|
count |
number |
呼び出しレート制限のカウント値。 |
renewalPeriod |
number |
通話レート制限の更新期間 (秒単位)。 |
rules |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Deployment
Cognitive Services アカウントのデプロイ。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
リソース Etag。 |
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties |
Cognitive Services アカウントの展開のプロパティ。 |
|
sku |
SKU を表すリソース モデル定義 |
|
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
DeploymentModel
Cognitive Services アカウントデプロイ モデルのプロパティ。
名前 | 型 | 説明 |
---|---|---|
callRateLimit |
呼び出しレート制限 Cognitive Services アカウント。 |
|
format |
string |
デプロイ モデルの形式。 |
name |
string |
デプロイ モデル名。 |
source |
string |
省略可能。 デプロイ モデルのソース ARM リソース ID。 |
version |
string |
省略可能。 デプロイ モデルのバージョン。 version が指定されていない場合は、既定のバージョンが割り当てられます。 既定のバージョンはモデルごとに異なり、モデルに新しいバージョンが使用可能な場合は変更される可能性があります。 モデルの既定のバージョンは、リスト モデル API から見つけることができます。 |
DeploymentModelVersionUpgradeOption
デプロイ モデルのバージョン アップグレード オプション。
名前 | 型 | 説明 |
---|---|---|
NoAutoUpgrade |
string |
|
OnceCurrentVersionExpired |
string |
|
OnceNewDefaultVersionAvailable |
string |
DeploymentProperties
Cognitive Services アカウントの展開のプロパティ。
名前 | 型 | 説明 |
---|---|---|
callRateLimit |
呼び出しレート制限 Cognitive Services アカウント。 |
|
capabilities |
object |
機能。 |
model |
Cognitive Services アカウントデプロイ モデルのプロパティ。 |
|
provisioningState |
操作が呼び出されたときのリソースの状態を取得します。 |
|
raiPolicyName |
string |
RAI ポリシーの名前。 |
rateLimits | ||
scaleSettings |
Cognitive Services アカウントデプロイ モデルのプロパティ。 |
|
versionUpgradeOption |
デプロイ モデルのバージョン アップグレード オプション。 |
DeploymentProvisioningState
操作が呼び出されたときのリソースの状態を取得します。
名前 | 型 | 説明 |
---|---|---|
Accepted |
string |
|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
Failed |
string |
|
Moving |
string |
|
Succeeded |
string |
DeploymentScaleSettings
Cognitive Services アカウントデプロイ モデルのプロパティ。
名前 | 型 | 説明 |
---|---|---|
activeCapacity |
integer |
デプロイのアクティブな容量。 この値は、お客様が 最近 を更新 |
capacity |
integer |
デプロイ容量。 |
scaleType |
デプロイ スケールの種類。 |
DeploymentScaleType
デプロイ スケールの種類。
名前 | 型 | 説明 |
---|---|---|
Manual |
string |
|
Standard |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
RequestMatchPattern
名前 | 型 | 説明 |
---|---|---|
method |
string |
|
path |
string |
Sku
SKU を表すリソース モデル定義
名前 | 型 | 説明 |
---|---|---|
capacity |
integer |
SKU でスケールアウト/インがサポートされている場合は、容量整数を含める必要があります。 リソースに対してスケールアウト/インができない場合は、これを省略できます。 |
family |
string |
同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。 |
name |
string |
SKU の名前。 例 - P3。 通常は文字 +数値コードです |
size |
string |
SKU サイズ。 name フィールドがレベルと他の値の組み合わせである場合、これはスタンドアロン コードになります。 |
tier |
このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合は、リソース プロバイダーによって実装される必要があります。 |
SkuTier
このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合は、リソース プロバイダーによって実装される必要があります。
名前 | 型 | 説明 |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
ThrottlingRule
名前 | 型 | 説明 |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |