你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Named Value - Update

服务:

API Management

API 版本:

2024-05-01

更新特定的命名值。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}?api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
namedValueId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	NamedValue 的标识符。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
If-Match	True	string	实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

请求正文

名称	类型	说明
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	NamedValue 的唯一名称。 它只能包含字母、数字、句点、短划线和下划线字符。
properties.keyVault	KeyVaultContractCreateProperties	namedValue 的 KeyVault 位置详细信息。
properties.secret	boolean	确定该值是否为机密，是否应加密。 默认值为 false。
properties.tags	string[]	提供时可用于筛选 NamedValue 列表的可选标记。
properties.value	string minLength: 1 maxLength: 4096	NamedValue 的值。 可以包含策略表达式。 它可能不是空的，也可能只包含空格。

响应

名称	类型	说明
200 OK	NamedValueContract	命名值已成功更新。 标头 ETag: string
202 Accepted		已接受创建或更新命名值的请求。 标头 location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementUpdateNamedValue

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01


{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

示例响应

状态代码:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

状态代码:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
KeyVaultContractCreateProperties	创建 keyVault 合同详细信息。
KeyVaultContractProperties	KeyVault 合同详细信息。
KeyVaultLastAccessStatusContractProperties	发出协定更新属性。
NamedValueContract	NamedValue 详细信息。
NamedValueUpdateParameters	NamedValue 更新参数。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

KeyVaultContractCreateProperties

Object

创建 keyVault 合同详细信息。

名称	类型	说明
identityClientId	string	SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的客户端 ID，用于访问密钥保管库机密。
secretIdentifier	string	用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求使用 aka.ms/apimmsi 配置 API 管理服务

KeyVaultContractProperties

Object

KeyVault 合同详细信息。

名称	类型	说明
identityClientId	string	SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的客户端 ID，用于访问密钥保管库机密。
lastStatus	KeyVaultLastAccessStatusContractProperties	上次从密钥保管库同步和刷新机密的状态。
secretIdentifier	string	用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求使用 aka.ms/apimmsi 配置 API 管理服务

KeyVaultLastAccessStatusContractProperties

Object

发出协定更新属性。

名称	类型	说明
code	string	用于从密钥保管库同步和刷新机密的最后状态代码。
message	string	错误的详细信息，否则为空。
timeStampUtc	string (date-time)	上次访问机密的时间。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

NamedValueContract

Object

NamedValue 详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	NamedValue 的唯一名称。 它只能包含字母、数字、句点、短划线和下划线字符。
properties.keyVault	KeyVaultContractProperties	namedValue 的 KeyVault 位置详细信息。
properties.provisioningState	string	预配状态
properties.secret	boolean	确定该值是否为机密，是否应加密。 默认值为 false。
properties.tags	string[]	提供时可用于筛选 NamedValue 列表的可选标记。
properties.value	string maxLength: 4096	NamedValue 的值。 可以包含策略表达式。 它可能不是空的，也可能只包含空格。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

NamedValueUpdateParameters

Object

NamedValue 更新参数。

名称	类型	说明
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	NamedValue 的唯一名称。 它只能包含字母、数字、句点、短划线和下划线字符。
properties.keyVault	KeyVaultContractCreateProperties	namedValue 的 KeyVault 位置详细信息。
properties.secret	boolean	确定该值是否为机密，是否应加密。 默认值为 false。
properties.tags	string[]	提供时可用于筛选 NamedValue 列表的可选标记。
properties.value	string minLength: 1 maxLength: 4096	NamedValue 的值。 可以包含策略表达式。 它可能不是空的，也可能只包含空格。