Share via

Workspace Policy Fragment - Get

  • Reference
Service:
API Management
API Version:
2024-05-01

Gets a policy fragment.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}?api-version=2024-05-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}?api-version=2024-05-01&format={format}

URI Parameters

Name In Required Type Description
id
 path True

string

A resource identifier.

Regex pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$)
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.
workspaceId
 path True

string

Workspace identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$
api-version
 query True

string

The API version to use for this operation.
format
 query

PolicyFragmentContentFormat

Policy fragment content format.

Responses

Name Type Description
200 OK

PolicyFragmentContract

Successfully returned a policy fragment.

Headers

ETag: string
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

ApiManagementGetWorkspacePolicyFragment
ApiManagementGetWorkspacePolicyFragmentFormat

ApiManagementGetWorkspacePolicyFragment

Sample request

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

Sample response

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

ApiManagementGetWorkspacePolicyFragmentFormat

Sample request

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/workspaces/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "rawxml",
    "description": "A policy fragment example",
    "value": "<fragment><set-header name=\"correlationid\" exists-action=\"skip\">\r\n\t\t\t<value>@{\n                var guidBinary = new byte[16];\n                Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n                long time = DateTime.Now.Ticks;\n                byte[] bytes = new byte[6];\n                unchecked\n                {\n                       bytes[5] = (byte)(time >> 40);\n                       bytes[4] = (byte)(time >> 32);\n                       bytes[3] = (byte)(time >> 24);\n                       bytes[2] = (byte)(time >> 16);\n                       bytes[1] = (byte)(time >> 8);\n                       bytes[0] = (byte)(time);\n                }\n                Array.Copy(bytes, 0, guidBinary, 10, 6);\n                return new Guid(guidBinary).ToString();\n            }\n            </value>\r\n\t\t</set-header></fragment>"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
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.

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"