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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
named
|
path | True |
string |
NamedValue の識別子。 Regex pattern: |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
If-Match |
string |
エンティティの ETag。 エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.displayName | True |
string |
NamedValue の一意の名前。 文字、数字、ピリオド、ダッシュ、下線のみを使用できます。 |
properties.keyVault |
namedValue の KeyVault の場所の詳細。 |
||
properties.secret |
boolean |
値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 既定値は false です。 |
|
properties.tags |
string[] |
指定した場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 |
|
properties.value |
string |
NamedValue の値。 ポリシー式を含めることができます。 空にすることはできません。スペースのみで構成することはできません。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
名前付き値が正常に更新されました。 Headers ETag: string |
|
201 Created |
名前付き値が正常に作成されました。 Headers ETag: string |
|
202 Accepted |
名前付き値の作成または更新の要求が受け入れられました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Api |
Api |
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
}
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Key |
keyVault コントラクトの詳細を作成します。 |
Key |
KeyVault コントラクトの詳細。 |
Key |
コントラクトの更新プロパティを発行します。 |
Named |
NamedValue の詳細。 |
Named |
NamedValue の詳細。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
KeyVaultContractCreateProperties
keyVault コントラクトの詳細を作成します。
名前 | 型 | 説明 |
---|---|---|
identityClientId |
string |
Key Vault シークレットへのアクセスに使用される、SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID。 |
secretIdentifier |
string |
シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新ができなくなります。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります |
KeyVaultContractProperties
KeyVault コントラクトの詳細。
名前 | 型 | 説明 |
---|---|---|
identityClientId |
string |
Key Vault シークレットへのアクセスに使用される、SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID。 |
lastStatus |
キー コンテナーからのシークレットの前回の同期と更新の状態。 |
|
secretIdentifier |
string |
シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新ができなくなります。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります |
KeyVaultLastAccessStatusContractProperties
コントラクトの更新プロパティを発行します。
名前 | 型 | 説明 |
---|---|---|
code |
string |
キー コンテナーからのシークレットの同期と更新の最後の状態コード。 |
message |
string |
エラーの詳細は空です。 |
timeStampUtc |
string |
シークレットが最後にアクセスされた時刻。 日付は、ISO 8601 標準で指定されている形式 |
NamedValueContract
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" |
NamedValueCreateContract
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" |