Policy Description - List By Service
Elenca tutte le descrizioni dei criteri.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions?scope={scope}&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 di 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. |
scope
|
query |
Ambito dei criteri. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Restituisce una matrice di descrizioni dei criteri. |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui 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
ApiManagementListPolicyDescriptions
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions?scope=Api&api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic",
"type": "Microsoft.ApiManagement/service/policyDescriptions",
"name": "authentication-basic",
"properties": {
"description": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.",
"scope": 268435471
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate",
"type": "Microsoft.ApiManagement/service/policyDescriptions",
"name": "authentication-certificate",
"properties": {
"description": "Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.",
"scope": 268435471
}
}
],
"count": 2
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
Policy |
Descrizioni dei criteri di Gestione API. |
Policy |
Dettagli della descrizione dei criteri. |
Policy |
Ambito dei criteri. |
ErrorFieldContract
Contratto campo di 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. |
PolicyDescriptionCollection
Descrizioni dei criteri di Gestione API.
Nome | Tipo | Descrizione |
---|---|---|
count |
integer |
Numero totale di conteggio record. |
value |
Descrizioni dei criteri di Gestione API. |
PolicyDescriptionContract
Dettagli della descrizione dei criteri.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.description |
string |
Descrizione dei criteri. |
properties.scope |
integer |
Valore OR binario dell'ambito Frammento di codice. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
PolicyScopeContract
Ambito dei criteri.
Nome | Tipo | Descrizione |
---|---|---|
All |
string |
|
Api |
string |
|
Operation |
string |
|
Product |
string |
|
Tenant |
string |