All Policies - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

Status of all policies of API Management services.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AllPoliciesCollection	Returns an array of Policy Status.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementListPolicyRestrictions

Sample request

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

Sample response

Status code:: 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": ""
}

Definitions

Name	Description
AllPoliciesCollection	The response of All Policies.
AllPoliciesContract	AllPolicies Contract details.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PolicyComplianceState	Policy Restriction Compliance State

AllPoliciesCollection

The response of All Policies.

Name	Type	Description
nextLink	string	Next page link if any.
value	AllPoliciesContract[]	AllPolicies Contract value.

AllPoliciesContract

AllPolicies Contract details.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		The name of the resource
properties.complianceState	PolicyComplianceState	Pending	Policy Restriction Compliance State
properties.referencePolicyId	string		Policy Identifier
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PolicyComplianceState

Policy Restriction Compliance State

Name	Type	Description
Compliant	string	The scope in restriction is in compliance.
NonCompliant	string	The scope in restriction is out of compliance.
Pending	string	The policy restriction compliance state has not yet been determined.

Share via