你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Encryption Scopes - Create Or Update
更新与认知服务帐户关联的指定 encryptionScope 的状态。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}?api-version=2024-04-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
认知服务帐户的名称。 正则表达式模式: |
encryption
|
path | True |
string |
与认知服务帐户关联的 encryptionScope 的名称 正则表达式模式: |
resource
|
path | True |
string |
资源组的名称。 名称不区分大小写。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
用于此操作的 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties |
认知服务 EncryptionScope 的属性。 |
|
tags |
object |
资源标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功创建/更新 EncryptionScope。 |
|
201 Created |
成功创建 EncryptionScope。 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
示例
PutEncryptionScope
示例请求
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName?api-version=2024-04-01-preview
{
"properties": {
"state": "Enabled",
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": {
"keyName": "DevKeyWestUS2",
"keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95",
"keyVaultUri": "https://devkvwestus2.vault.azure.net/",
"identityClientId": "00000000-0000-0000-0000-000000000000"
}
}
}
示例响应
{
"name": "encryptionScopeName",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName",
"type": "Microsoft.CognitiveServices/accounts/encryptionScopes",
"systemData": {
"createdBy": "xxx@microsoft.com",
"createdByType": "User",
"createdAt": "2023-06-08T06:35:08.0662558Z",
"lastModifiedBy": "xxx@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2023-06-08T06:35:08.0662558Z"
},
"etag": "\"00000000-0000-0000-0000-000000000000\"",
"properties": {
"provisioningState": "Succeeded",
"state": "Enabled",
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": {
"keyName": "DevKeyWestUS2",
"keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95",
"keyVaultUri": "https://devkvwestus2.vault.azure.net/",
"identityClientId": "00000000-0000-0000-0000-000000000000"
}
}
}
{
"name": "encryptionScopeName",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName",
"type": "Microsoft.CognitiveServices/accounts/encryptionScopes",
"systemData": {
"createdBy": "xxx@microsoft.com",
"createdByType": "User",
"createdAt": "2023-06-08T06:35:08.0662558Z",
"lastModifiedBy": "xxx@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2023-06-08T06:35:08.0662558Z"
},
"etag": "\"00000000-0000-0000-0000-000000000000\"",
"properties": {
"provisioningState": "Succeeded",
"state": "Enabled",
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": {
"keyName": "DevKeyWestUS2",
"keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95",
"keyVaultUri": "https://devkvwestus2.vault.azure.net/",
"identityClientId": "00000000-0000-0000-0000-000000000000"
}
}
}
定义
名称 | 说明 |
---|---|
created |
创建资源的标识的类型。 |
Encryption |
认知服务 EncryptionScope |
Encryption |
EncryptionScope 的属性 |
Encryption |
获取调用操作时资源的状态。 |
Encryption |
encryptionScope 状态。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
key |
枚举 KeySource for Encryption 的可能值 |
Key |
用于配置 keyVault 属性的属性 |
system |
与创建和上次修改资源相关的元数据。 |
createdByType
创建资源的标识的类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EncryptionScope
认知服务 EncryptionScope
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
资源 Etag。 |
id |
string |
资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties |
认知服务 EncryptionScope 的属性。 |
|
systemData |
与创建和上次修改资源相关的元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
EncryptionScopeProperties
EncryptionScope 的属性
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
keySource | Microsoft.KeyVault |
枚举 KeySource for Encryption 的可能值 |
|
keyVaultProperties |
KeyVault 的属性 |
||
provisioningState |
获取调用操作时资源的状态。 |
||
state |
encryptionScope 状态。 |
EncryptionScopeProvisioningState
获取调用操作时资源的状态。
名称 | 类型 | 说明 |
---|---|---|
Accepted |
string |
|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
Succeeded |
string |
EncryptionScopeState
encryptionScope 状态。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
keySource
枚举 KeySource for Encryption 的可能值
名称 | 类型 | 说明 |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
用于配置 keyVault 属性的属性
名称 | 类型 | 说明 |
---|---|---|
identityClientId |
string |
|
keyName |
string |
KeyVault 中密钥的名称 |
keyVaultUri |
string |
KeyVault 的 URI |
keyVersion |
string |
KeyVault 中密钥的版本 |
systemData
与创建和上次修改资源相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳(UTC)。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识的类型。 |
|
lastModifiedAt |
string |
上次修改的资源时间戳(UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识的类型。 |