Named Value - List By Service
Elenca una raccolta di valori denominati definiti all'interno di un'istanza del servizio.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
$filter
|
query |
string |
| Campo | Utilizzo | Operatori supportati | Funzioni supportate | |
|
$skip
|
query |
integer int32 |
Numero di record da ignorare. |
|
$top
|
query |
integer int32 |
Numero di record da restituire. |
|
is
|
query |
boolean |
Se impostato su true, la risposta contiene solo entità valore denominate che non sono riuscite ad aggiornare. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Raccolta delle entità valore denominate per l'istanza del servizio Gestione API specificata. |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementListNamedValues
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686",
"type": "Microsoft.ApiManagement/service/namedValues",
"name": "592f1174cc83890dc4f32686",
"properties": {
"displayName": "Logger-Credentials-592f1174cc83890dc4f32687",
"value": "propValue",
"secret": false
}
},
{
"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": "2d2df842-44d8-4885-8dec-77cc1a984a31",
"lastStatus": {
"code": "Success",
"timeStampUtc": "2020-09-11T00:54:31.8024882Z"
}
},
"tags": [
"foo",
"bar"
],
"secret": true
}
}
],
"count": 1,
"nextLink": ""
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Key |
Dettagli del contratto KeyVault. |
Key |
Problema di proprietà dell'aggiornamento del contratto. |
Named |
Rappresentazione dell'elenco NamedValue paginata. |
Named |
Dettagli di NamedValue. |
ErrorFieldContract
Contratto campo errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
KeyVaultContractProperties
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 |
Ultima sincronizzazione e aggiornamento dello stato del segreto dall'insieme di credenziali delle chiavi. |
|
secretIdentifier |
string |
Identificatore segreto dell'insieme di credenziali delle chiavi per recuperare il segreto. La fornitura di un segreto con versione impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Problema di proprietà dell'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 altro vuoto. |
timeStampUtc |
string |
L'ultima volta che è stato eseguito l'accesso al segreto. La data è conforme al formato seguente: |
NamedValueCollection
Rappresentazione dell'elenco NamedValue paginata.
Nome | Tipo | Descrizione |
---|---|---|
count |
integer |
Numero totale di record in tutte le pagine. |
nextLink |
string |
Collegamento alla pagina successiva se disponibile. |
value |
Valori di pagina. |
NamedValueContract
Dettagli di NamedValue.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.displayName |
string |
Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. |
properties.keyVault |
Dettagli della posizione di KeyVault dell'oggetto namedValue. |
|
properties.secret |
boolean |
Determina se il valore è un segreto e se deve essere crittografato. Il valore predefinito è false. |
properties.tags |
string[] |
Tag facoltativi che, se specificato, possono essere usati per filtrare l'elenco NamedValue. |
properties.value |
string |
Valore di NamedValue. Può contenere espressioni di criteri. Non può essere vuoto o contenere solo spazi. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |