您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Named Value - Create Or Update

创建或更新命名值。

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

URI 参数

Name In Required Type Description
namedValueId
path True
  • string

NamedValue 的标识符。

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。

请求头

Name Required Type Description
If-Match
  • string

实体的 ETag。 在创建实体时不需要,但在更新实体时是必需的。

请求正文

Name Required Type Description
properties.displayName True
  • string

NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。

properties.keyVault

NamedValue 的 KeyVault 位置详细信息。

properties.secret
  • boolean

确定值是否为密钥以及是否应加密。 默认值为 false。

properties.tags
  • string[]

提供的可选标记可用于筛选 NamedValue 列表。

properties.value
  • string

NamedValue 的值。 可以包含策略表达式。 不能为空或只由空格组成。 此属性不会在 "获取" 操作上填充! 使用 "/listSecrets" POST 请求获取值。

响应

Name Type Description
200 OK

已成功更新命名值。

Headers

  • ETag: string
201 Created

已成功创建命名值。

Headers

  • ETag: string
202 Accepted

已接受创建或更新已命名值的请求。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active DirectoryOAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementCreateNamedValue
ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2020-12-01
{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2020-12-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop2",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop2",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

ApiManagementCreateNamedValueWithKeyVault

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2020-12-01
{
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret"
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2020-12-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

定义

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

KeyVaultContractCreateProperties

创建 keyVault 合同详细信息。

KeyVaultContractProperties

KeyVault 合同详细信息。

KeyVaultLastAccessStatusContractProperties

发出协定更新属性。

NamedValueContract

NamedValue 详细信息。

NamedValueCreateContract

NamedValue 详细信息。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

属性级别错误的可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

如果出现验证错误,则发送请求中的无效字段列表。

error.message
  • string

错误的用户可读表示形式。

KeyVaultContractCreateProperties

创建 keyVault 合同详细信息。

Name Type Description
identityClientId
  • string

将用于访问密钥保管库机密的 SystemAssignedIdentity 或 UserAssignedIdentity 客户端 Id。

secretIdentifier
  • string

用于获取密钥的密钥保管库机密标识符。 提供版本的机密将阻止自动刷新。 这需要通过 aka.ms/apimmsi 配置 Api 管理服务

KeyVaultContractProperties

KeyVault 合同详细信息。

Name Type Description
identityClientId
  • string

将用于访问密钥保管库机密的 SystemAssignedIdentity 或 UserAssignedIdentity 客户端 Id。

lastStatus

上次从密钥保管库同步和刷新密钥的状态。

secretIdentifier
  • string

用于获取密钥的密钥保管库机密标识符。 提供版本的机密将阻止自动刷新。 这需要通过 aka.ms/apimmsi 配置 Api 管理服务

KeyVaultLastAccessStatusContractProperties

发出协定更新属性。

Name Type Description
code
  • string

用于从密钥保管库同步和刷新密钥的上一个状态代码。

message
  • string

错误的详细信息为空。

timeStampUtc
  • string

上次访问密钥的时间。 日期符合以下格式: yyyy-MM-ddTHH:mm:ssZ 由 ISO 8601 标准指定。

NamedValueContract

NamedValue 详细信息。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.displayName
  • string

NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。

properties.keyVault

NamedValue 的 KeyVault 位置详细信息。

properties.secret
  • boolean

确定值是否为密钥以及是否应加密。 默认值为 false。

properties.tags
  • string[]

提供的可选标记可用于筛选 NamedValue 列表。

properties.value
  • string

NamedValue 的值。 可以包含策略表达式。 不能为空或只由空格组成。 此属性不会在 "获取" 操作上填充! 使用 "/listSecrets" POST 请求获取值。

type
  • string

API 管理资源的资源类型。

NamedValueCreateContract

NamedValue 详细信息。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.displayName
  • string

NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。

properties.keyVault

NamedValue 的 KeyVault 位置详细信息。

properties.secret
  • boolean

确定值是否为密钥以及是否应加密。 默认值为 false。

properties.tags
  • string[]

提供的可选标记可用于筛选 NamedValue 列表。

properties.value
  • string

NamedValue 的值。 可以包含策略表达式。 不能为空或只由空格组成。 此属性不会在 "获取" 操作上填充! 使用 "/listSecrets" POST 请求获取值。

type
  • string

API 管理资源的资源类型。