Delen via


Policy Description - List By Service

Geeft een overzicht van alle beleidsbeschrijvingen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions?scope={scope}&api-version=2021-08-01

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep.

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

Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

api-version
query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag.

scope
query

PolicyScopeContract

Beleidsbereik.

Antwoorden

Name Type Description
200 OK

PolicyDescriptionCollection

Retourneert een matrix met beleidsbeschrijvingen.

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

ApiManagementListPolicyDescriptions

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions?scope=Api&api-version=2021-08-01

Voorbeeldrespons

{
  "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
}

Definities

Name Description
ErrorFieldContract

Foutveldcontract.

ErrorResponse

Foutreactie.

PolicyDescriptionCollection

Beschrijvingen van APIM-beleid.

PolicyDescriptionContract

Details van beleidsbeschrijving.

PolicyScopeContract

Beleidsbereik.

ErrorFieldContract

Foutveldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Leesbare weergave van fout op eigenschapsniveau.

target

string

Eigenschapsnaam.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden die in de aanvraag worden verzonden, in het geval van een validatiefout.

error.message

string

Leesbare weergave van de fout.

PolicyDescriptionCollection

Beschrijvingen van APIM-beleid.

Name Type Description
count

integer (int64)

Totaal aantal records.

value

PolicyDescriptionContract[]

Beschrijvingen van APIM-beleid.

PolicyDescriptionContract

Details van beleidsbeschrijving.

Name Type 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.description

string

Beleidsbeschrijving.

properties.scope

integer (int64)

Binaire OF-waarde van het bereik Fragment.

type

string

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

PolicyScopeContract

Beleidsbereik.

Waarde Description
All
Api
Operation
Product
Tenant