All Policies - List By Service

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Stan wszystkich zasad usług API Management.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AllPoliciesCollection	Zwraca tablicę stanu zasad.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementListPolicyRestrictions

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/allpolicies/allpolicies1",
      "type": "Microsoft.ApiManagement/service/allpolicies",
      "name": "allpolicies1",
      "properties": {
        "referencePolicyId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/policies/policy",
        "complianceState": "Compliant"
      }
    }
  ],
  "nextLink": ""
}

Definicje

Nazwa	Opis
AllPoliciesCollection	Odpowiedź na wszystkie zasady.
AllPoliciesContract	Szczegóły umowy AllPolicies.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PolicyComplianceState	Stan zgodności ograniczeń zasad

AllPoliciesCollection

Objekt

Odpowiedź na wszystkie zasady.

Nazwa	Typ	Opis
nextLink	string	Jeśli istnieje, link następnej strony.
value	AllPoliciesContract[]	Wartość kontraktu AllPolicies.

AllPoliciesContract

Objekt

Szczegóły umowy AllPolicies.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nazwa zasobu
properties.complianceState	PolicyComplianceState	Pending	Stan zgodności ograniczeń zasad
properties.referencePolicyId	string		Identyfikator zasad
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

PolicyComplianceState

Wyliczanie

Stan zgodności ograniczeń zasad

Wartość	Opis
Compliant	Zakres w ograniczeniu jest zgodny.
NonCompliant	Zakres ograniczeń jest niezgodny.
Pending	Stan zgodności ograniczeń zasad nie został jeszcze określony.