Policy Fragment - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

Gets all policy fragments.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments?api-version=2024-05-01&$filter={$filter}&$orderby={$orderby}&$top={$top}&$skip={$skip}

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.
$filter	query		string	\| Field \| Usage \| Supported operators \| Supported functions \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter, orderBy \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| description \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| value \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$orderby	query		string	OData order by query option.
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.

Responses

Name	Type	Description
200 OK	PolicyFragmentCollection	Successfully returned an array of policy fragments.
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

ApiManagementListPolicyFragments

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
      "type": "Microsoft.ApiManagement/service/policyFragments",
      "name": "policyFragment1",
      "properties": {
        "format": "xml",
        "description": "A policy fragment example",
        "value": "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PolicyFragmentCollection	The response of the get policy fragments operation.
PolicyFragmentContentFormat	Format of the policy fragment content.
PolicyFragmentContract	Policy fragment contract details.

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.

PolicyFragmentCollection

The response of the get policy fragments operation.

Name	Type	Description
count	integer	Total record count number.
nextLink	string	Next page link if any.
value	PolicyFragmentContract[]	Policy fragment contract value.

PolicyFragmentContentFormat

Format of the policy fragment content.

Name	Type	Description
rawxml	string	The contents are inline and Content type is a non XML encoded policy document.
xml	string	The contents are inline and Content type is an XML document.

PolicyFragmentContract

Policy fragment 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.description	string		Policy fragment description.
properties.format	PolicyFragmentContentFormat	xml	Format of the policy fragment content.
properties.provisioningState	string		The provisioning state
properties.value	string		Contents of the policy fragment.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Partager via