Deployments - Create Or Update
更新與認知服務帳戶相關聯的指定部署狀態。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}?api-version=2023-05-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
account
|
path | True |
string |
認知服務帳戶的名稱。 Regex 模式: |
deployment
|
path | True |
string |
與認知服務帳戶相關聯的部署名稱 |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties |
認知服務帳戶部署的屬性。 |
|
sku |
代表 SKU 的資源模型定義 |
回應
名稱 | 類型 | Description |
---|---|---|
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"
}
}
定義
名稱 | Description |
---|---|
Call |
通話速率限制認知服務帳戶。 |
created |
建立資源的身分識別類型。 |
Deployment |
認知服務帳戶部署。 |
Deployment |
認知服務帳戶部署模型的屬性。 |
Deployment |
部署模型版本升級選項。 |
Deployment |
認知服務帳戶部署的屬性。 |
Deployment |
取得呼叫作業時的資源狀態。 |
Deployment |
認知服務帳戶部署模型的屬性。 |
Deployment |
部署調整類型。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Request |
|
Sku |
代表 SKU 的資源模型定義 |
Sku |
如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。 |
system |
與建立和上次修改資源相關的元數據。 |
Throttling |
CallRateLimit
通話速率限制認知服務帳戶。
名稱 | 類型 | Description |
---|---|---|
count |
number |
通話速率限制的計數值。 |
renewalPeriod |
number |
呼叫率限制的續約期間,以秒為單位。 |
rules |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Deployment
認知服務帳戶部署。
名稱 | 類型 | Description |
---|---|---|
etag |
string |
資源 Etag。 |
id |
string |
資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties |
認知服務帳戶部署的屬性。 |
|
sku |
代表 SKU 的資源模型定義 |
|
systemData |
與建立和上次修改資源相關的元數據。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
DeploymentModel
認知服務帳戶部署模型的屬性。
名稱 | 類型 | Description |
---|---|---|
callRateLimit |
通話速率限制認知服務帳戶。 |
|
format |
string |
部署模型格式。 |
name |
string |
部署模型名稱。 |
source |
string |
選擇性。 部署模型來源 ARM 資源識別碼。 |
version |
string |
選擇性。 部署模型版本。 如果未指定版本,則會指派預設版本。 不同模型的預設版本不同,當有新版本可供模型使用時可能會變更。 您可以從清單模型 API 找到模型的預設版本。 |
DeploymentModelVersionUpgradeOption
部署模型版本升級選項。
名稱 | 類型 | Description |
---|---|---|
NoAutoUpgrade |
string |
|
OnceCurrentVersionExpired |
string |
|
OnceNewDefaultVersionAvailable |
string |
DeploymentProperties
認知服務帳戶部署的屬性。
名稱 | 類型 | Description |
---|---|---|
callRateLimit |
通話速率限制認知服務帳戶。 |
|
capabilities |
object |
功能。 |
model |
認知服務帳戶部署模型的屬性。 |
|
provisioningState |
取得呼叫作業時的資源狀態。 |
|
raiPolicyName |
string |
RAI 原則的名稱。 |
rateLimits | ||
scaleSettings |
認知服務帳戶部署模型的屬性。 |
|
versionUpgradeOption |
部署模型版本升級選項。 |
DeploymentProvisioningState
取得呼叫作業時的資源狀態。
名稱 | 類型 | Description |
---|---|---|
Accepted |
string |
|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
Failed |
string |
|
Moving |
string |
|
Succeeded |
string |
DeploymentScaleSettings
認知服務帳戶部署模型的屬性。
名稱 | 類型 | Description |
---|---|---|
activeCapacity |
integer |
部署作用中容量。 如果客戶最近更新 |
capacity |
integer |
部署容量。 |
scaleType |
部署調整類型。 |
DeploymentScaleType
部署調整類型。
名稱 | 類型 | Description |
---|---|---|
Manual |
string |
|
Standard |
string |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
錯誤物件。 |
RequestMatchPattern
名稱 | 類型 | Description |
---|---|---|
method |
string |
|
path |
string |
Sku
代表 SKU 的資源模型定義
名稱 | 類型 | Description |
---|---|---|
capacity |
integer |
如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,可能會省略此專案。 |
family |
string |
如果服務有不同的硬體世代,則針對相同的 SKU,則可以在這裡擷取。 |
name |
string |
SKU 的名稱。 例如 - P3。 通常是字母+數位碼 |
size |
string |
SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程序代碼。 |
tier |
如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。 |
SkuTier
如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。
名稱 | 類型 | Description |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |
ThrottlingRule
名稱 | 類型 | Description |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |