Named Value - Create Or Update

Membuat atau memperbarui nilai bernama.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
namedValueId
path True

string

Pengidentifikasi NamedValue.

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

resourceGroupName
path True

string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

serviceName
path True

string

Nama layanan API Management.

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

subscriptionId
path True

string

ID langganan target.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
If-Match

string

ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
properties.displayName True

string

Nama unik NamedValue. Ini hanya boleh berisi huruf, digit, titik, tanda hubung, dan karakter garis bawah.

properties.keyVault

KeyVaultContractCreateProperties

Detail lokasi KeyVault dari namedValue.

properties.secret

boolean

Menentukan apakah nilainya adalah rahasia dan harus dienkripsi atau tidak. Nilai defaultnya adalah salah.

properties.tags

string[]

Tag opsional yang ketika disediakan dapat digunakan untuk memfilter daftar NamedValue.

properties.value

string

Nilai NamedValue. Dapat berisi ekspresi kebijakan. Mungkin tidak kosong atau hanya terdiri dari spasi kosong. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

Respons

Nama Jenis Deskripsi
200 OK

NamedValueContract

Nilai bernama berhasil diperbarui.

Headers

ETag: string

201 Created

NamedValueContract

Nilai bernama berhasil dibuat.

Headers

ETag: string

202 Accepted

Permintaan untuk membuat atau memperbarui nilai bernama diterima.

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

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
  }
}

Definisi

Nama Deskripsi
ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

KeyVaultContractCreateProperties

Buat detail kontrak keyVault.

KeyVaultContractProperties

Detail kontrak KeyVault.

KeyVaultLastAccessStatusContractProperties

Terbitkan Kontrak Perbarui Properti.

NamedValueContract

Detail NamedValue.

NamedValueCreateContract

Detail NamedValue.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan tingkat properti.

message

string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target

string

Nama properti.

ErrorResponse

Respons Kesalahan.

Nama Jenis Deskripsi
error.code

string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

ErrorFieldContract[]

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message

string

Representasi kesalahan yang dapat dibaca manusia.

KeyVaultContractCreateProperties

Buat detail kontrak keyVault.

Nama Jenis Deskripsi
identityClientId

string

Null untuk SystemAssignedIdentity atau Id Klien untuk UserAssignedIdentity , yang akan digunakan untuk mengakses rahasia brankas kunci.

secretIdentifier

string

Pengidentifikasi rahasia brankas kunci untuk mengambil rahasia. Memberikan rahasia versi akan mencegah refresh otomatis. Ini mengharuskan layanan API Management dikonfigurasi dengan aka.ms/apimmsi

KeyVaultContractProperties

Detail kontrak KeyVault.

Nama Jenis Deskripsi
identityClientId

string

Null untuk SystemAssignedIdentity atau Id Klien untuk UserAssignedIdentity , yang akan digunakan untuk mengakses rahasia brankas kunci.

lastStatus

KeyVaultLastAccessStatusContractProperties

Terakhir kali sinkronkan dan refresh status rahasia dari brankas kunci.

secretIdentifier

string

Pengidentifikasi rahasia brankas kunci untuk mengambil rahasia. Memberikan rahasia versi akan mencegah refresh otomatis. Ini mengharuskan layanan API Management dikonfigurasi dengan aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Terbitkan Kontrak Perbarui Properti.

Nama Jenis Deskripsi
code

string

Kode status terakhir untuk sinkronisasi dan refresh rahasia dari brankas kunci.

message

string

Detail kesalahan lainnya kosong.

timeStampUtc

string

Terakhir kali rahasia diakses. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

NamedValueContract

Detail NamedValue.

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nama sumber daya.

properties.displayName

string

Nama unik NamedValue. Ini hanya boleh berisi huruf, digit, titik, tanda hubung, dan karakter garis bawah.

properties.keyVault

KeyVaultContractProperties

Detail lokasi KeyVault dari namedValue.

properties.secret

boolean

Menentukan apakah nilainya adalah rahasia dan harus dienkripsi atau tidak. Nilai defaultnya adalah salah.

properties.tags

string[]

Tag opsional yang ketika disediakan dapat digunakan untuk memfilter daftar NamedValue.

properties.value

string

Nilai NamedValue. Dapat berisi ekspresi kebijakan. Mungkin tidak kosong atau hanya terdiri dari spasi kosong. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

Detail NamedValue.

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nama sumber daya.

properties.displayName

string

Nama unik NamedValue. Ini hanya boleh berisi huruf, digit, titik, tanda hubung, dan karakter garis bawah.

properties.keyVault

KeyVaultContractCreateProperties

Detail lokasi KeyVault dari namedValue.

properties.secret

boolean

Menentukan apakah nilainya adalah rahasia dan harus dienkripsi atau tidak. Nilai defaultnya adalah salah.

properties.tags

string[]

Tag opsional yang ketika disediakan dapat digunakan untuk memfilter daftar NamedValue.

properties.value

string

Nilai NamedValue. Dapat berisi ekspresi kebijakan. Mungkin tidak kosong atau hanya terdiri dari spasi kosong. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"