Named Value - Update

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Aktualizuje określoną nazwaną wartość.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namedValueId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identyfikator nazwanej wartości.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match	True	string	Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

Treść żądania

Nazwa	Typ	Opis
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia.
properties.keyVault	KeyVaultContractCreateProperties	Szczegóły lokalizacji usługi KeyVault 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 minLength: 1 maxLength: 4096	Wartość nazwanej wartości. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NamedValueContract	Nazwana wartość została pomyślnie zaktualizowana. Nagłówki ETag: string
202 Accepted		Żądanie utworzenia lub zaktualizowania nazwanej wartości zostało zaakceptowane. Nagłówki location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

NamedValueContract

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

Nagłówki

ETag: string

202 Accepted

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

Nagłówki

location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

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

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateNamedValue

Przykładowe żądanie

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01


{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

Przykładowa odpowiedź

Kod stanu:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

Kod stanu:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
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	NazwaneSzczegóły wartości.
NamedValueUpdateParameters	Nazwane parametry aktualizacji wartości.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

KeyVaultContractCreateProperties

Objekt

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

Objekt

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

Objekt

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 (date-time)	Ostatni raz dostęp do wpisu tajnego. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` określony przez standard ISO 8601.

NamedValueContract

Objekt

NazwaneSzczegóły wartości.

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 minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia.
properties.keyVault	KeyVaultContractProperties	Szczegóły lokalizacji usługi KeyVault o nazwieValue.
properties.provisioningState	string	Stan aprowizacji
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 maxLength: 4096	Wartość nazwanej wartości. 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 na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"