Microsoft.Authorization (stable:2020-09-01)

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

DataPolicyManifests_GetByPolicyMode (new)
Description :  This operation retrieves the data policy manifest with the given policy mode.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/dataPolicyManifests/{policyMode}
{
policyMode:
{
Description: The policy mode of the data policy manifest to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data policy manifest properties. ,
Required: False ,
}
{
namespaces:
{
Description: The list of namespaces for the data policy manifest. ,
Required: False ,
}
[
string ,
]
,
policyMode:
{
Description: The policy mode of the data policy manifest. ,
Required: False ,
}
string ,
isBuiltInOnly:
{
Description: A value indicating whether policy mode is allowed only in built-in definitions. ,
Required: False ,
}
boolean ,
resourceTypeAliases:
{
Description: An array of resource type aliases. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type name. ,
Required: False ,
}
string ,
aliases:
{
Description: The aliases for property names. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
effects:
{
Description: The effect definition. ,
Required: False ,
}
[
{
name:
{
Description: The data effect name. ,
Required: False ,
}
string ,
detailsSchema:
{
Description: The data effect details schema. ,
Required: False ,
}
object ,
}
,
]
,
fieldValues:
{
Description: The non-alias field accessor values that can be used in the policy rule. ,
Required: False ,
}
[
string ,
]
,
resourceFunctions:
{
Description: The resource functions definition specified in the data manifest. ,
Required: False ,
}
{
standard:
{
Description: The standard resource functions (subscription and/or resourceGroup). ,
Required: False ,
}
[
string ,
]
,
custom:
{
Description: An array of data manifest custom resource definition. ,
Required: False ,
}
[
{
name:
{
Description: The function name as it will appear in the policy rule. eg - 'vault'. ,
Required: False ,
}
string ,
fullyQualifiedResourceType:
{
Description: The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'. ,
Required: False ,
}
string ,
defaultProperties:
{
Description: The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported ,
Required: False ,
}
[
string ,
]
,
allowCustomProperties:
{
Description: A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01'). ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
id:
{
Description: The ID of the data policy manifest. ,
Required: False ,
}
string ,
name:
{
Description: The name of the data policy manifest (it's the same as the Policy Mode). ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/dataPolicyManifests). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataPolicyManifests_List (new)
Description :  This operation retrieves a list of all the data policy manifests that match the optional given $filter. Valid values for $filter are: "$filter=namespace eq '{0}'". If $filter is not provided, the unfiltered list includes all data policy manifests for data resource types. If $filter=namespace is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/dataPolicyManifests
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: "namespace eq '{value}'". If $filter is not provided, no filtering is performed. If $filter=namespace eq '{value}' is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of data policy manifests. ,
Required: False ,
}
[
{
properties:
{
Description: The data policy manifest properties. ,
Required: False ,
}
{
namespaces:
{
Description: The list of namespaces for the data policy manifest. ,
Required: False ,
}
[
string ,
]
,
policyMode:
{
Description: The policy mode of the data policy manifest. ,
Required: False ,
}
string ,
isBuiltInOnly:
{
Description: A value indicating whether policy mode is allowed only in built-in definitions. ,
Required: False ,
}
boolean ,
resourceTypeAliases:
{
Description: An array of resource type aliases. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type name. ,
Required: False ,
}
string ,
aliases:
{
Description: The aliases for property names. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
effects:
{
Description: The effect definition. ,
Required: False ,
}
[
{
name:
{
Description: The data effect name. ,
Required: False ,
}
string ,
detailsSchema:
{
Description: The data effect details schema. ,
Required: False ,
}
object ,
}
,
]
,
fieldValues:
{
Description: The non-alias field accessor values that can be used in the policy rule. ,
Required: False ,
}
[
string ,
]
,
resourceFunctions:
{
Description: The resource functions definition specified in the data manifest. ,
Required: False ,
}
{
standard:
{
Description: The standard resource functions (subscription and/or resourceGroup). ,
Required: False ,
}
[
string ,
]
,
custom:
{
Description: An array of data manifest custom resource definition. ,
Required: False ,
}
[
{
name:
{
Description: The function name as it will appear in the policy rule. eg - 'vault'. ,
Required: False ,
}
string ,
fullyQualifiedResourceType:
{
Description: The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'. ,
Required: False ,
}
string ,
defaultProperties:
{
Description: The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported ,
Required: False ,
}
[
string ,
]
,
allowCustomProperties:
{
Description: A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01'). ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
id:
{
Description: The ID of the data policy manifest. ,
Required: False ,
}
string ,
name:
{
Description: The name of the data policy manifest (it's the same as the Policy Mode). ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/dataPolicyManifests). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_Delete (new)
Description :  This operation deletes a policy assignment, given its name and the scope it was created in. The scope of a policy assignment is the part of its ID preceding '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_Create (new)
Description :  This operation creates or updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_Get (new)
Description :  This operation retrieves a single policy assignment, given its name and the scope it was created at.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_ListForResourceGroup (new)
Description :  This operation retrieves the list of all policy assignments associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource group, which is everything in the unfiltered list except those applied to resources contained within the resource group. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to 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. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_ListForResource (new)
Description :  This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource level. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the resource. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ''). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').
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. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines) ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource path. Use empty string if there is none. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_ListForManagementGroup (new)
Description :  This operation retrieves the list of all policy assignments applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter=atScope() is provided, the returned list includes all policy assignments that are assigned to the management group or the management group's ancestors. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the management group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyAssignments
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for the operation. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_List (new)
Description :  This operation retrieves the list of all policy assignments associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the subscription, which is everything in the unfiltered list except those applied to objects contained within the subscription. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the subscription. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
{
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_DeleteById (new)
Description :  This operation deletes the policy with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid formats for {scope} are: '/providers/Microsoft.Management/managementGroups/{managementGroup}' (management group), '/subscriptions/{subscriptionId}' (subscription), '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' (resource group), or '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' (resource).
Reference :  Link ¶

⚼ Request

DELETE:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_CreateById (new)
Description :  This operation creates or updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
Reference :  Link ¶

⚼ Request

PUT:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_GetById (new)
Description :  The operation retrieves the policy assignment with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
Reference :  Link ¶

⚼ Request

GET:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_CreateOrUpdate (new)
Description :  This operation creates or updates a policy definition in the given subscription with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_Delete (new)
Description :  This operation deletes the policy definition in the given subscription with the given name.
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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_Get (new)
Description :  This operation retrieves the policy definition in the given subscription with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_GetBuiltIn (new)
Description :  This operation retrieves the built-in policy definition with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_CreateOrUpdateAtManagementGroup (new)
Description :  This operation creates or updates a policy definition in the given management group with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_DeleteAtManagementGroup (new)
Description :  This operation deletes the policy definition in the given management group with the given name.
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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_GetAtManagementGroup (new)
Description :  This operation retrieves the policy definition in the given management group with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_List (new)
Description :  This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_ListBuiltIn (new)
Description :  This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_ListByManagementGroup (new)
Description :  This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_CreateOrUpdate (new)
Description :  This operation creates or updates a policy set definition in the given subscription with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy set definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_Delete (new)
Description :  This operation deletes the policy set definition in the given subscription with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_Get (new)
Description :  This operation retrieves the policy set definition in the given subscription with the given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_GetBuiltIn (new)
Description :  This operation retrieves the built-in policy set definition with the given name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_List (new)
Description :  This operation retrieves a list of all the policy set definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_ListBuiltIn (new)
Description :  This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policySetDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_CreateOrUpdateAtManagementGroup (new)
Description :  This operation creates or updates a policy set definition in the given management group with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy set definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_DeleteAtManagementGroup (new)
Description :  This operation deletes the policy set definition in the given management group with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_GetAtManagementGroup (new)
Description :  This operation retrieves the policy set definition in the given management group with the given name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_ListByManagementGroup (new)
Description :  This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataPolicyManifests_GetByPolicyMode (removed)
Description :  This operation retrieves the data policy manifest with the given policy mode.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/dataPolicyManifests/{policyMode}
{
policyMode:
{
Description: The policy mode of the data policy manifest to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The data policy manifest properties. ,
Required: False ,
}
{
namespaces:
{
Description: The list of namespaces for the data policy manifest. ,
Required: False ,
}
[
string ,
]
,
policyMode:
{
Description: The policy mode of the data policy manifest. ,
Required: False ,
}
string ,
isBuiltInOnly:
{
Description: A value indicating whether policy mode is allowed only in built-in definitions. ,
Required: False ,
}
boolean ,
resourceTypeAliases:
{
Description: An array of resource type aliases. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type name. ,
Required: False ,
}
string ,
aliases:
{
Description: The aliases for property names. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
effects:
{
Description: The effect definition. ,
Required: False ,
}
[
{
name:
{
Description: The data effect name. ,
Required: False ,
}
string ,
detailsSchema:
{
Description: The data effect details schema. ,
Required: False ,
}
object ,
}
,
]
,
fieldValues:
{
Description: The non-alias field accessor values that can be used in the policy rule. ,
Required: False ,
}
[
string ,
]
,
resourceFunctions:
{
Description: The resource functions definition specified in the data manifest. ,
Required: False ,
}
{
standard:
{
Description: The standard resource functions (subscription and/or resourceGroup). ,
Required: False ,
}
[
string ,
]
,
custom:
{
Description: An array of data manifest custom resource definition. ,
Required: False ,
}
[
{
name:
{
Description: The function name as it will appear in the policy rule. eg - 'vault'. ,
Required: False ,
}
string ,
fullyQualifiedResourceType:
{
Description: The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'. ,
Required: False ,
}
string ,
defaultProperties:
{
Description: The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported ,
Required: False ,
}
[
string ,
]
,
allowCustomProperties:
{
Description: A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01'). ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
id:
{
Description: The ID of the data policy manifest. ,
Required: False ,
}
string ,
name:
{
Description: The name of the data policy manifest (it's the same as the Policy Mode). ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/dataPolicyManifests). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataPolicyManifests_List (removed)
Description :  This operation retrieves a list of all the data policy manifests that match the optional given $filter. Valid values for $filter are: "$filter=namespace eq '{0}'". If $filter is not provided, the unfiltered list includes all data policy manifests for data resource types. If $filter=namespace is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/dataPolicyManifests
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: "namespace eq '{value}'". If $filter is not provided, no filtering is performed. If $filter=namespace eq '{value}' is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of data policy manifests. ,
Required: False ,
}
[
{
properties:
{
Description: The data policy manifest properties. ,
Required: False ,
}
{
namespaces:
{
Description: The list of namespaces for the data policy manifest. ,
Required: False ,
}
[
string ,
]
,
policyMode:
{
Description: The policy mode of the data policy manifest. ,
Required: False ,
}
string ,
isBuiltInOnly:
{
Description: A value indicating whether policy mode is allowed only in built-in definitions. ,
Required: False ,
}
boolean ,
resourceTypeAliases:
{
Description: An array of resource type aliases. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type name. ,
Required: False ,
}
string ,
aliases:
{
Description: The aliases for property names. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
effects:
{
Description: The effect definition. ,
Required: False ,
}
[
{
name:
{
Description: The data effect name. ,
Required: False ,
}
string ,
detailsSchema:
{
Description: The data effect details schema. ,
Required: False ,
}
object ,
}
,
]
,
fieldValues:
{
Description: The non-alias field accessor values that can be used in the policy rule. ,
Required: False ,
}
[
string ,
]
,
resourceFunctions:
{
Description: The resource functions definition specified in the data manifest. ,
Required: False ,
}
{
standard:
{
Description: The standard resource functions (subscription and/or resourceGroup). ,
Required: False ,
}
[
string ,
]
,
custom:
{
Description: An array of data manifest custom resource definition. ,
Required: False ,
}
[
{
name:
{
Description: The function name as it will appear in the policy rule. eg - 'vault'. ,
Required: False ,
}
string ,
fullyQualifiedResourceType:
{
Description: The fully qualified control plane resource type that this function represents. eg - 'Microsoft.KeyVault/vaults'. ,
Required: False ,
}
string ,
defaultProperties:
{
Description: The top-level properties that can be selected on the function's output. eg - [ "name", "location" ] if vault().name and vault().location are supported ,
Required: False ,
}
[
string ,
]
,
allowCustomProperties:
{
Description: A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault('2019-06-01'). ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
id:
{
Description: The ID of the data policy manifest. ,
Required: False ,
}
string ,
name:
{
Description: The name of the data policy manifest (it's the same as the Policy Mode). ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/dataPolicyManifests). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_Delete (removed)
Description :  This operation deletes a policy assignment, given its name and the scope it was created in. The scope of a policy assignment is the part of its ID preceding '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_Create (removed)
Description :  This operation creates or updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_Get (removed)
Description :  This operation retrieves a single policy assignment, given its name and the scope it was created at.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
{
scope:
{
Description: The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_ListForResourceGroup (removed)
Description :  This operation retrieves the list of all policy assignments associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource group, which is everything in the unfiltered list except those applied to resources contained within the resource group. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to 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. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_ListForResource (removed)
Description :  This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource level. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the resource. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ''). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').
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. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines) ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource path. Use empty string if there is none. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_ListForManagementGroup (removed)
Description :  This operation retrieves the list of all policy assignments applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter=atScope() is provided, the returned list includes all policy assignments that are assigned to the management group or the management group's ancestors. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the management group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyAssignments
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for the operation. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_List (removed)
Description :  This operation retrieves the list of all policy assignments associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the subscription, which is everything in the unfiltered list except those applied to objects contained within the subscription. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the subscription. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
{
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_DeleteById (removed)
Description :  This operation deletes the policy with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid formats for {scope} are: '/providers/Microsoft.Management/managementGroups/{managementGroup}' (management group), '/subscriptions/{subscriptionId}' (subscription), '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' (resource group), or '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' (resource).
Reference :  Link ¶

⚼ Request

DELETE:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_CreateById (removed)
Description :  This operation creates or updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
Reference :  Link ¶

⚼ Request

PUT:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyAssignments_GetById (removed)
Description :  The operation retrieves the policy assignment with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.
Reference :  Link ¶

⚼ Request

GET:  /{policyAssignmentId}
{
policyAssignmentId:
{
Description: The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. ,
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 or policy set definition being assigned. ,
Required: False ,
}
string ,
scope:
{
Description: The scope for the policy assignment. ,
Required: False ,
}
string ,
notScopes:
{
Description: The policy's excluded scopes. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The parameter values for the assigned policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
description:
{
Description: This message will be part of response in case of policy violation. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
enforcementMode:
{
Description: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. ,
Enum:
{
Default: The policy effect is enforced during resource creation or update. ,
DoNotEnforce: The policy effect is not enforced during resource creation or update. ,
}
,
Required: False ,
}
enum ,
nonComplianceMessages:
{
Description: The messages that describe why a resource is non-compliant with the policy. ,
Required: False ,
}
[
{
message:
{
Description: A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. ,
Required: True ,
}
string ,
policyDefinitionReferenceId:
{
Description: The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. ,
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 ,
location:
{
Description: The location of the policy assignment. Only required when utilizing managed identity. ,
Required: False ,
}
string ,
identity:
{
Description: The managed identity associated with the policy assignment. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of the resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the resource identity. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. This is the only required field when adding a system assigned identity to a resource. ,
Enum:
{
SystemAssigned: Indicates that a system assigned identity is associated with the resource. ,
None: Indicates that no identity is associated with the resource or that the existing identity should be removed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_CreateOrUpdate (removed)
Description :  This operation creates or updates a policy definition in the given subscription with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_Delete (removed)
Description :  This operation deletes the policy definition in the given subscription with the given name.
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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_Get (removed)
Description :  This operation retrieves the policy definition in the given subscription with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_GetBuiltIn (removed)
Description :  This operation retrieves the built-in policy definition with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_CreateOrUpdateAtManagementGroup (removed)
Description :  This operation creates or updates a policy definition in the given management group with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_DeleteAtManagementGroup (removed)
Description :  This operation deletes the policy definition in the given management group with the given name.
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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_GetAtManagementGroup (removed)
Description :  This operation retrieves the policy definition in the given management group with the given name.
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_List (removed)
Description :  This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_ListBuiltIn (removed)
Description :  This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policyDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicyDefinitions_ListByManagementGroup (removed)
Description :  This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. ,
Required: False ,
}
string ,
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. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameter definitions for parameters used in the policy rule. The keys are the parameter names. ,
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 ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_CreateOrUpdate (removed)
Description :  This operation creates or updates a policy set definition in the given subscription with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy set definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_Delete (removed)
Description :  This operation deletes the policy set definition in the given subscription with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_Get (removed)
Description :  This operation retrieves the policy set definition in the given subscription with the given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_GetBuiltIn (removed)
Description :  This operation retrieves the built-in policy set definition with the given name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_List (removed)
Description :  This operation retrieves a list of all the policy set definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_ListBuiltIn (removed)
Description :  This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Authorization/policySetDefinitions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_CreateOrUpdateAtManagementGroup (removed)
Description :  This operation creates or updates a policy set definition in the given management group with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set definition to create. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy set definition properties. ,
Required: True ,
}
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_DeleteAtManagementGroup (removed)
Description :  This operation deletes the policy set definition in the given management group with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_GetAtManagementGroup (removed)
Description :  This operation retrieves the policy set definition in the given management group with the given name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
{
policySetDefinitionName:
{
Description: The name of the policy set 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, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySetDefinitions_ListByManagementGroup (removed)
Description :  This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. When the $top filter is not provided, it will return 500 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The policy definition properties. ,
Required: False ,
}
{
policyType:
{
Description: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. ,
Enum:
{
NotSpecified: No description available. ,
BuiltIn: No description available. ,
Custom: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the policy set definition. ,
Required: False ,
}
string ,
description:
{
Description: The policy set definition description. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: The policy set definition parameters that can be used in policy definition references. ,
Required: False ,
}
object ,
policyDefinitions:
{
Description: An array of policy definition references. ,
Required: True ,
}
[
{
policyDefinitionId:
{
Description: The ID of the policy definition or policy set definition. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameter values for the referenced policy rule. The keys are the parameter names. ,
Required: False ,
}
object ,
policyDefinitionReferenceId:
{
Description: A unique id (within the policy set definition) for this policy definition reference. ,
Required: False ,
}
string ,
groupNames:
{
Description: The name of the groups that this policy definition reference belongs to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyDefinitionGroups:
{
Description: The metadata describing groups of policy definition references within the policy set definition. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: True ,
}
string ,
displayName:
{
Description: The group's display name. ,
Required: False ,
}
string ,
category:
{
Description: The group's category. ,
Required: False ,
}
string ,
description:
{
Description: The group's description. ,
Required: False ,
}
string ,
additionalMetadataId:
{
Description: A resource ID of a resource that contains additional metadata about the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
id:
{
Description: The ID of the policy set definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy set definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policySetDefinitions). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}