Named Value - Create Or Update

Tworzy lub aktualizuje nazwaną wartość.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
namedValueId
path True

string

Identyfikator nazwanej wartości.

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

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName
path True

string

Nazwa usługi API Management.

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

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

ETag jednostki. Nie jest wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa Wymagane Typ Opis
properties.displayName True

string

Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia.

properties.keyVault

KeyVaultContractCreateProperties

Szczegóły lokalizacji magazynu kluczy o nazwieValue.

properties.secret

boolean

Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false.

properties.tags

string[]

Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue.

properties.value

string

Wartość elementu NamedValue. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona w operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

Odpowiedzi

Nazwa Typ Opis
200 OK

NamedValueContract

Nazwana wartość została pomyślnie zaktualizowana.

Headers

ETag: string

201 Created

NamedValueContract

Nazwana wartość została pomyślnie utworzona.

Headers

ETag: string

202 Accepted

Żądanie utworzenia lub zaktualizowania nazwanej wartości zostało zaakceptowane.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

KeyVaultContractCreateProperties

Utwórz szczegóły kontraktu usługi KeyVault.

KeyVaultContractProperties

Szczegóły kontraktu usługi KeyVault.

KeyVaultLastAccessStatusContractProperties

Właściwości aktualizacji kontraktu problemu.

NamedValueContract

Szczegóły namedValue.

NamedValueCreateContract

Szczegóły namedValue.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.

message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.

target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.

error.details

ErrorFieldContract[]

Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.

error.message

string

Czytelna dla człowieka reprezentacja błędu.

KeyVaultContractCreateProperties

Utwórz szczegóły kontraktu usługi KeyVault.

Nazwa Typ Opis
identityClientId

string

Wartość null dla elementu SystemAssignedIdentity lub identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy.

secretIdentifier

string

Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi

KeyVaultContractProperties

Szczegóły kontraktu usługi KeyVault.

Nazwa Typ Opis
identityClientId

string

Wartość null dla elementu SystemAssignedIdentity lub identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy.

lastStatus

KeyVaultLastAccessStatusContractProperties

Czas ostatniej synchronizacji i odświeżania stanu wpisu tajnego z magazynu kluczy.

secretIdentifier

string

Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Właściwości aktualizacji kontraktu problemu.

Nazwa Typ Opis
code

string

Ostatni kod stanu na potrzeby synchronizacji i odświeżania wpisu tajnego z magazynu kluczy.

message

string

Szczegóły błędu inne puste.

timeStampUtc

string

Czas ostatniego uzyskania dostępu do wpisu tajnego. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

NamedValueContract

Szczegóły namedValue.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.displayName

string

Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia.

properties.keyVault

KeyVaultContractProperties

Szczegóły lokalizacji magazynu kluczy o nazwieValue.

properties.secret

boolean

Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false.

properties.tags

string[]

Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue.

properties.value

string

Wartość elementu NamedValue. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona w operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

Szczegóły namedValue.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.displayName

string

Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia.

properties.keyVault

KeyVaultContractCreateProperties

Szczegóły lokalizacji magazynu kluczy o nazwieValue.

properties.secret

boolean

Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false.

properties.tags

string[]

Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue.

properties.value

string

Wartość elementu NamedValue. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona w operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"