你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 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=2022-08-01

URI 参数

名称 必需 类型 说明
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

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
If-Match

string

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

请求正文

名称 必需 类型 说明
properties.displayName True

string

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

properties.keyVault

KeyVaultContractCreateProperties

namedValue 的 KeyVault 位置详细信息。

properties.secret

boolean

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

properties.tags

string[]

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

properties.value

string

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

响应

名称 类型 说明
200 OK

NamedValueContract

已成功更新命名值。

Headers

ETag: string

201 Created

NamedValueContract

已成功创建命名值。

Headers

ETag: string

202 Accepted

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

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称 说明
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=2022-08-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=2022-08-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=2022-08-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=2022-08-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

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

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

KeyVaultContractCreateProperties

创建 keyVault 协定详细信息。

名称 类型 说明
identityClientId

string

SystemAssignedIdentity 为 Null,或 UserAssignedIdentity 的客户端 ID,用于访问密钥保管库机密。

secretIdentifier

string

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

KeyVaultContractProperties

KeyVault 合同详细信息。

名称 类型 说明
identityClientId

string

SystemAssignedIdentity 为 Null,或 UserAssignedIdentity 的客户端 ID,用于访问密钥保管库机密。

lastStatus

KeyVaultLastAccessStatusContractProperties

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

secretIdentifier

string

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

KeyVaultLastAccessStatusContractProperties

颁发合同更新属性。

名称 类型 说明
code

string

用于从密钥保管库同步和刷新机密的最后状态代码。

message

string

错误的详细信息为空。

timeStampUtc

string

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

NamedValueContract

NamedValue 详细信息。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.displayName

string

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

properties.keyVault

KeyVaultContractProperties

namedValue 的 KeyVault 位置详细信息。

properties.secret

boolean

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

properties.tags

string[]

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

properties.value

string

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

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

NamedValueCreateContract

NamedValue 详细信息。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.displayName

string

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

properties.keyVault

KeyVaultContractCreateProperties

namedValue 的 KeyVault 位置详细信息。

properties.secret

boolean

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

properties.tags

string[]

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

properties.value

string

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

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”