你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Named Value - Get
获取由其标识符指定的命名值的详细信息。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}?api-version=2022-08-01
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
named
|
path | True |
string |
NamedValue 的标识符。 正则表达式模式: |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
service
|
path | True |
string |
API 管理服务的名称。 正则表达式模式: |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
名称 | 类型 | 说明 |
---|---|---|
200 OK |
响应正文包含指定的命名值实体。 不包含机密 标头 ETag: string |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
Azure Active Directory OAuth2 流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例请求
示例响应
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2",
"type": "Microsoft.ApiManagement/service/namedValues",
"name": "testarmTemplateproperties2",
"properties": {
"displayName": "propName",
"value": "propValue",
"tags": [
"foo",
"bar"
],
"secret": false
}
}
示例请求
示例响应
{
"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://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
"identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31",
"lastStatus": {
"code": "Success",
"timeStampUtc": "2020-09-11T00:54:31.8024882Z"
}
},
"tags": [
"foo",
"bar"
],
"secret": true
}
}
名称 | 说明 |
---|---|
Error |
错误字段协定。 |
Error |
错误响应。 |
Key |
KeyVault 合同详细信息。 |
Key |
发出协定更新属性。 |
Named |
NamedValue 详细信息。 |
错误字段协定。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
属性级错误代码。 |
message |
string |
属性级错误的可读表示形式。 |
target |
string |
属性名称。 |
错误响应。
名称 | 类型 | 说明 |
---|---|---|
error.code |
string |
服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。 |
error.details |
在发生验证错误时,请求中发送的无效字段列表。 |
|
error.message |
string |
错误的用户可读表示形式。 |
KeyVault 合同详细信息。
名称 | 类型 | 说明 |
---|---|---|
identityClientId |
string |
对于 SystemAssignedIdentity,或 UserAssignedIdentity 的客户端 ID 为 Null,这将用于访问密钥保管库机密。 |
lastStatus |
上次从密钥保管库同步和刷新机密的状态。 |
|
secretIdentifier |
string |
用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi |
发出协定更新属性。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
用于从密钥保管库同步和刷新机密的最后状态代码。 |
message |
string |
错误的详细信息,否则为空。 |
timeStampUtc |
string |
上次访问机密的时间。 日期符合以下格式: |
NamedValue 详细信息。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties.displayName |
string |
NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。 |
properties.keyVault |
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” |