Microsoft.Authorization (stable:2016-12-01)

2025/12/05 • 19 new, 19 deleted methods

PolicyAssignments_Delete (new)
Description :  Deletes a policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: The name of the policy assignment to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}
PolicyAssignments_Create (new)
Description :  Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: The name of the policy assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_Get (new)
Description :  Gets a policy assignment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: The name of the policy assignment to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForResourceGroup (new)
Description :  Gets policy assignments for the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: The name of the resource group that contains policy assignments. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForResource (new)
Description :  Gets policy assignments for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: The name of the resource group containing the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource path. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource with policy assignments. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_List (new)
Description :  Gets all the policy assignments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_DeleteById (new)
Description :  When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
Reference :  Link ¶

⚼ Request

DELETE:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to delete. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_CreateById (new)
Description :  Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
Reference :  Link ¶

⚼ Request

PUT:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to create. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_GetById (new)
Description :  When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
Reference :  Link ¶

⚼ Request

GET:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to get. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyDefinitions_CreateOrUpdate (new)
Description :  Creates or updates a policy definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_Delete (new)
Description :  Deletes a policy definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
PolicyDefinitions_Get (new)
Description :  Gets the policy definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_GetBuiltIn (new)
Description :  Gets the built in policy definition.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the built in policy definition to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_CreateOrUpdateAtManagementGroup (new)
Description :  Creates or updates a policy definition at management group level.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_DeleteAtManagementGroup (new)
Description :  Deletes a policy definition at management group level.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
PolicyDefinitions_GetAtManagementGroup (new)
Description :  Gets the policy definition at management group level.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_List (new)
Description :  Gets all the policy definitions for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyDefinitions_ListBuiltIn (new)
Description :  Gets all the built in policy definitions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyDefinitions_ListByManagementGroup (new)
Description :  Gets all the policy definitions for a subscription at management group level.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_Delete (removed)
Description :  Deletes a policy assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: The name of the policy assignment to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}
PolicyAssignments_Create (removed)
Description :  Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: The name of the policy assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_Get (removed)
Description :  Gets a policy assignment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. ,
Required: True ,
}
string ,
policyAssignmentName:
{
Description: The name of the policy assignment to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForResourceGroup (removed)
Description :  Gets policy assignments for the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: The name of the resource group that contains policy assignments. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_ListForResource (removed)
Description :  Gets policy assignments for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments
{
resourceGroupName:
{
Description: The name of the resource group containing the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource path. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource with policy assignments. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_List (removed)
Description :  Gets all the policy assignments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy assignments. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyAssignments_DeleteById (removed)
Description :  When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
Reference :  Link ¶

⚼ Request

DELETE:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to delete. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_CreateById (removed)
Description :  Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
Reference :  Link ¶

⚼ Request

PUT:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to create. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for policy assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyAssignments_GetById (removed)
Description :  When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.
Reference :  Link ¶

⚼ Request

GET:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to get. Use the format '/{scope}/providers/Microsoft.Authorization/policyAssignments/{policy-assignment-name}'. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy assignment. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the policy assignment. ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy assignment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the policy assignment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy assignment. ,
Required: False ,
}
string ,
}
PolicyDefinitions_CreateOrUpdate (removed)
Description :  Creates or updates a policy definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_Delete (removed)
Description :  Deletes a policy definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
PolicyDefinitions_Get (removed)
Description :  Gets the policy definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_GetBuiltIn (removed)
Description :  Gets the built in policy definition.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the built in policy definition to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_CreateOrUpdateAtManagementGroup (removed)
Description :  Creates or updates a policy definition at management group level.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_DeleteAtManagementGroup (removed)
Description :  Deletes a policy definition at management group level.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
PolicyDefinitions_GetAtManagementGroup (removed)
Description :  Gets the policy definition at management group level.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
{
policyDefinitionName:
{
Description: The name of the policy definition to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
PolicyDefinitions_List (removed)
Description :  Gets all the policy definitions for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyDefinitions_ListBuiltIn (removed)
Description :  Gets all the built in policy definitions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
PolicyDefinitions_ListByManagementGroup (removed)
Description :  Gets all the policy definitions for a subscription at management group level.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Possible values are NotSpecified, Indexed, and All. ,
Enum:
{
NotSpecified: No description available. ,
Indexed: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy definition description. ,
Required: False ,
}
string ,
policyRule:
{
Description: The policy rule. ,
Required: False ,
}
object ,
metadata:
{
Description: The policy definition metadata. ,
Required: False ,
}
object ,
parameters:
{
Description: Required if a parameter is used in policy rule. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The ID of the policy definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy definition. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}