Delen via

Api Operation Policy - Get

  • Referentie
Service:
API Management
API-versie:
2024-05-01

Haal de beleidsconfiguratie op api-bewerkingsniveau op.

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
Met optionele parameters: 
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

URI-parameters

Name In Vereist Type Description
apiId
 path True

string

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

API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
operationId
 path True

string

minLength: 1
maxLength: 80

Bewerkings-id binnen een API. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
policyId
 path True

PolicyIdName

De id van het beleid.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

De naam van de API Management-service.
subscriptionId
 path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.
format
 query

PolicyExportFormat

Beleidsexportindeling.

Antwoorden

Name Type Description
200 OK

PolicyContract

Informatie over api-bewerkingsbeleid.

Kopteksten

ETag: string
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetApiOperationPolicy

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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>"
  }
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
PolicyContentFormat

Indeling van de policyContent.
PolicyContract

Beleidscontractgegevens.
PolicyExportFormat

Beleidsexportindeling.
PolicyIdName

De id van het beleid.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

PolicyContentFormat

Inventarisatie

Indeling van de policyContent.

Waarde Description
rawxml

De inhoud is inline en het inhoudstype is een niet-XML-gecodeerd beleidsdocument.
rawxml-link

Het beleidsdocument is niet xml-gecodeerd en wordt gehost op een HTTP-eindpunt dat toegankelijk is vanuit de API Management-service.
xml

De inhoud is inline en het inhoudstype is een XML-document.
xml-link

Het XML-document van het beleid wordt gehost op een HTTP-eindpunt dat toegankelijk is vanuit de API Management-service.

PolicyContract

Object

Beleidscontractgegevens.

Name Type Default value Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

De naam van de resource
properties.format

PolicyContentFormat

xml

Indeling van de policyContent.
properties.value

string

Inhoud van het beleid zoals gedefinieerd door de indeling.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PolicyExportFormat

Inventarisatie

Beleidsexportindeling.

Waarde Description
rawxml

De inhoud is inline en het inhoudstype is een niet-XML-gecodeerd beleidsdocument.
xml

De inhoud is inline en het inhoudstype is een XML-document.

PolicyIdName

Inventarisatie

De id van het beleid.

Waarde Description
policy