Policy Restriction - List By Service

Dienst:

API Management

API-Version:

2024-05-01

Ruft alle Richtlinieneinschränkungen von API-Verwaltungsdiensten ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyRestrictionCollection	Gibt ein Array von Richtlinieneinschränkungen zurück.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementListPolicyRestrictions

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1",
      "type": "Microsoft.ApiManagement/service/policyRestrictions",
      "name": "policyRestriction1",
      "properties": {
        "scope": "Sample Path to the policy document.",
        "requireBase": "true"
      }
    }
  ],
  "nextLink": ""
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PolicyRestrictionCollection	Die Antwort des Vorgangs zum Abrufen von Richtlinieneinschränkungen.
PolicyRestrictionContract	Vertragsdetails für Richtlinieneinschränkung.
PolicyRestrictionRequireBase	Gibt an, ob die Basisrichtlinie für das Richtliniendokument erzwungen werden soll.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PolicyRestrictionCollection

Objekt

Die Antwort des Vorgangs zum Abrufen von Richtlinieneinschränkungen.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite, falls vorhanden.
value	PolicyRestrictionContract[]	Vertragsdetails für Richtlinieneinschränkung.

PolicyRestrictionContract

Objekt

Vertragsdetails für Richtlinieneinschränkung.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Der Name der Ressource
properties.requireBase	PolicyRestrictionRequireBase	false	Gibt an, ob die Basisrichtlinie für das Richtliniendokument erzwungen werden soll.
properties.scope	string		Pfad zum Richtliniendokument.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PolicyRestrictionRequireBase

Enumeration

Gibt an, ob die Basisrichtlinie für das Richtliniendokument erzwungen werden soll.

Wert	Beschreibung
false	Für die Richtlinie ist keine Basisrichtlinie erforderlich.
true	Die Richtlinie ist für die Basisrichtlinie erforderlich.