Condividi tramite

Api Operation Policy - Get

  • Riferimento
Servizio:
API Management
Versione API:
2024-05-01

Ottenere la configurazione dei criteri a livello di operazione API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/policy?api-version=2024-05-01
Con parametri facoltativi: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/policy?format={format}&api-version=2024-05-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
apiId
 path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
operationId
 path True

string

minLength: 1
maxLength: 80

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
policyId
 path True

PolicyIdName

Identificatore del criterio.
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.
format
 query

PolicyExportFormat

Formato esportazione criteri.

Risposte

Nome Tipo Descrizione
200 OK

PolicyContract

Informazioni sui criteri dell'operazione API.

Intestazioni

ETag: 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

ApiManagementGetApiOperationPolicy

Esempio di richiesta

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy?api-version=2024-05-01

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy",
  "type": "Microsoft.ApiManagement/service/apis/operations/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound>\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <base />\r\n    <set-header name=\"X-My-Sample\" exists-action=\"override\">\r\n      <value>This is a sample</value>\r\n      <!-- for multiple headers with the same name add additional value elements -->\r\n    </set-header>\r\n    <jsonp callback-parameter-name=\"ProcessResponse\" />\r\n  </outbound>\r\n</policies>"
  }
}

Definizioni

Nome Descrizione
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
PolicyContentFormat

Formato del criterioContent.
PolicyContract

Dettagli contratto criteri.
PolicyExportFormat

Formato esportazione criteri.
PolicyIdName

Identificatore del criterio.

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.

PolicyContentFormat

Enumerazione

Formato del criterioContent.

Valore Descrizione
rawxml

Il contenuto è inline e Il tipo di contenuto è un documento di criteri non codificati XML.
rawxml-link

Il documento dei criteri non è codificato in XML ed è ospitato in un endpoint HTTP accessibile dal servizio Gestione API.
xml

Il contenuto è inline e Il tipo di contenuto è un documento XML.
xml-link

Il documento XML dei criteri è ospitato in un endpoint HTTP accessibile dal servizio Gestione API.

PolicyContract

Object

Dettagli contratto criteri.

Nome Tipo Valore predefinito 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.format

PolicyContentFormat

xml

Formato del criterioContent.
properties.value

string

Contenuto del criterio come definito dal formato.
type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PolicyExportFormat

Enumerazione

Formato esportazione criteri.

Valore Descrizione
rawxml

Il contenuto è inline e Il tipo di contenuto è un documento di criteri non codificati XML.
xml

Il contenuto è inline e Il tipo di contenuto è un documento XML.

PolicyIdName

Enumerazione

Identificatore del criterio.

Valore Descrizione
policy