Named Value - Create Or Update

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

Crea o aggiorna il valore denominato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namedValueId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificatore di NamedValue.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.displayName	True	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura.
properties.keyVault		KeyVaultContractCreateProperties	Dettagli della posizione dell'insieme di credenziali delle chiavi di namedValue.
properties.secret		boolean	Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false.
properties.tags		string[]	Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue.
properties.value		string maxLength: 4096	Valore di NamedValue. Può contenere espressioni di criteri. Potrebbe non essere vuoto o costituito solo da spazi vuoti. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.

Risposte

Nome	Tipo	Descrizione
200 OK	NamedValueContract	Il valore denominato è stato aggiornato correttamente. Intestazioni ETag: string location: string Azure-AsyncOperation: string
201 Created	NamedValueContract	Il valore denominato è stato creato correttamente. Intestazioni ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

NamedValueContract

Il valore denominato è stato aggiornato correttamente.

Intestazioni

ETag: string
location: string
Azure-AsyncOperation: string

201 Created

NamedValueContract

Il valore denominato è stato creato correttamente.

Intestazioni

ETag: string
location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateNamedValue

ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Esempio di richiesta

HTTP

PUT 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",
      "bar"
    ],
    "secret": false
  }
}

Risposta di esempio

Codice di stato:: 201

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=201
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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}

Codice di stato:: 200

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}

ApiManagementCreateNamedValueWithKeyVault

Esempio di richiesta

HTTP

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

{
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret"
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Risposta di esempio

Codice di stato:: 201

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}

Codice di stato:: 200

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
KeyVaultContractCreateProperties	Creare i dettagli del contratto keyVault.
KeyVaultContractProperties	Dettagli del contratto KeyVault.
KeyVaultLastAccessStatusContractProperties	Rilasciare le proprietà di aggiornamento del contratto.
NamedValueContract	Dettagli namedValue.
NamedValueCreateContract	Dettagli namedValue.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

KeyVaultContractCreateProperties

Object

Creare i dettagli del contratto keyVault.

Nome	Tipo	Descrizione
identityClientId	string	Null per SystemAssignedIdentity o ID client per UserAssignedIdentity, che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi.
secretIdentifier	string	Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi

KeyVaultContractProperties

Object

Dettagli del contratto KeyVault.

Nome	Tipo	Descrizione
identityClientId	string	Null per SystemAssignedIdentity o ID client per UserAssignedIdentity, che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi.
lastStatus	KeyVaultLastAccessStatusContractProperties	Ultima sincronizzazione e aggiornamento dello stato del segreto dall'insieme di credenziali delle chiavi.
secretIdentifier	string	Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Object

Rilasciare le proprietà di aggiornamento del contratto.

Nome	Tipo	Descrizione
code	string	Ultimo codice di stato per la sincronizzazione e l'aggiornamento del segreto dall'insieme di credenziali delle chiavi.
message	string	Dettagli dell'errore else vuoto.
timeStampUtc	string (date-time)	Ultima volta a cui è stato eseguito l'accesso al segreto. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.

NamedValueContract

Object

Dettagli namedValue.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura.
properties.keyVault	KeyVaultContractProperties	Dettagli della posizione dell'insieme di credenziali delle chiavi di namedValue.
properties.provisioningState	string	Stato del provisioning
properties.secret	boolean	Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false.
properties.tags	string[]	Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue.
properties.value	string maxLength: 4096	Valore di NamedValue. Può contenere espressioni di criteri. Potrebbe non essere vuoto o costituito solo da spazi vuoti. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

Object

Dettagli namedValue.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura.
properties.keyVault	KeyVaultContractCreateProperties	Dettagli della posizione dell'insieme di credenziali delle chiavi di namedValue.
properties.secret	boolean	Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false.
properties.tags	string[]	Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue.
properties.value	string maxLength: 4096	Valore di NamedValue. Può contenere espressioni di criteri. Potrebbe non essere vuoto o costituito solo da spazi vuoti. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Condividi tramite

Named Value - Create Or Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreateNamedValue

Esempio di richiesta

Risposta di esempio

ApiManagementCreateNamedValueWithKeyVault

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

NamedValueContract

NamedValueCreateContract

Risorse aggiuntive