Microsoft.Authorization (preview:2024-12-01)

2025/03/25 • 24 new methods

PolicyExemptions_Delete (new)
Description :  This operation deletes a policy exemption, given its name and the scope it was created in. The scope of a policy exemption is the part of its ID preceding '/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}
{
scope:
{
Description: The scope of the policy exemption. 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 ,
policyExemptionName:
{
Description: The name of the policy exemption to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PolicyExemptions_CreateOrUpdate (new)
Description :  This operation creates or updates a policy exemption with the given scope and name. Policy exemptions apply to all resources contained within their scope. For example, when you create a policy exemption at resource group scope for a policy assignment at the same or above level, the exemption exempts to all applicable resources in the resource group.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}
{
scope:
{
Description: The scope of the policy exemption. 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 ,
policyExemptionName:
{
Description: The name of the policy exemption to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the policy exemption. ,
Required: True ,
}
{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
PolicyExemptions_Get (new)
Description :  This operation retrieves a single policy exemption, given its name and the scope it was created at.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}
{
scope:
{
Description: The scope of the policy exemption. 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 ,
policyExemptionName:
{
Description: The name of the policy exemption 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 exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
PolicyExemptions_Update (new)
Description :  This operation updates a policy exemption with the given scope and name.
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}
{
scope:
{
Description: The scope of the policy exemption. 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 ,
policyExemptionName:
{
Description: The name of the policy exemption to delete. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for policy exemption patch request. ,
Required: True ,
}
{
properties:
{
Description: The policy exemption properties for Patch request. ,
Required: False ,
}
{
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
PolicyExemptions_List (new)
Description :  This operation retrieves the list of all policy exemptions associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy exemptions 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyExemptions
{
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: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all policy exemptions 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 exemptions that at the given scope. If $filter=excludeExpired() is provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy exemptions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
PolicyExemptions_ListForResourceGroup (new)
Description :  This operation retrieves the list of all policy exemptions associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy exemptions 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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group containing the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all policy exemptions 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 exemptions that at the given scope. If $filter=excludeExpired() is provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy exemptions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
PolicyExemptions_ListForResource (new)
Description :  This operation retrieves the list of all policy exemptions 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()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy exemptions 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. 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/policyExemptions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
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()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all policy exemptions 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 exemptions that at the given scope. If $filter=excludeExpired() is provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy exemptions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
PolicyExemptions_ListForManagementGroup (new)
Description :  This operation retrieves the list of all policy exemptions applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter=atScope() is provided, the returned list includes all policy exemptions that are assigned to the management group or the management group's ancestors.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyExemptions
{
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()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all policy exemptions 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 exemptions that at the given scope. If $filter=excludeExpired() is provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of policy exemptions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the policy exemption. ,
Required: True ,
}
{
policyAssignmentId:
{
Description: The ID of the policy assignment that is being exempted. ,
Required: True ,
}
string ,
policyDefinitionReferenceIds:
{
Description: The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. ,
Required: False ,
}
[
string ,
]
,
exemptionCategory:
{
Description: The policy exemption category. Possible values are Waiver and Mitigated. ,
Enum:
{
Waiver: This category of exemptions usually means the scope is not applicable for the policy. ,
Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope. ,
}
,
Required: True ,
}
enum ,
expiresOn:
{
Description: The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. ,
Format: date-time ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the policy exemption. ,
Required: False ,
}
string ,
description:
{
Description: The description of the policy exemption. ,
Required: False ,
}
string ,
metadata:
{
Description: The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. ,
Required: False ,
}
object ,
resourceSelectors:
{
Description: The resource selector list to filter policies by resource properties. ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource selector. ,
Required: False ,
}
string ,
selectors:
{
Description: The list of the selector expressions. ,
Required: False ,
}
[
{
kind:
{
Description: The selector kind. ,
Enum:
{
resourceLocation: The selector kind to filter policies by the resource location. ,
resourceType: The selector kind to filter policies by the resource type. ,
resourceWithoutLocation: The selector kind to filter policies by the resource without location. ,
policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. ,
UserPrincipalId: The selector kind to filter policies by the user principle ID. ,
GroupPrincipalId: The selector kind to filter policies by the security group membership ID. ,
}
,
Required: False ,
}
enum ,
in:
{
Description: The list of values to filter in. ,
Required: False ,
}
[
string ,
]
,
notIn:
{
Description: The list of values to filter out. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
assignmentScopeValidation:
{
Description: The option whether validate the exemption is at or under the assignment scope. ,
Enum:
{
Default: This option will validate the exemption is at or under the assignment scope. ,
DoNotValidate: This option will bypass the validation the exemption scope is at or under the policy assignment scope. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the policy exemption. ,
Required: False ,
}
string ,
name:
{
Description: The name of the policy exemption. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/policyExemptions). ,
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 ,
}
,
]
,
}
,
}
VariableValues_Delete (new)
Description :  This operation deletes a variable value, given its name, the subscription it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/variables/{variableName}/values/{variableValueName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
variableValueName:
{
Description: The name of the variable value to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
VariableValues_CreateOrUpdate (new)
Description :  This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/variables/{variableName}/values/{variableValueName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
variableValueName:
{
Description: The name of the variable value to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the variable value. ,
Required: True ,
}
{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
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 ,
}
,
]
,
}
,
}
VariableValues_Get (new)
Description :  This operation retrieves a single variable value; given its name, subscription it was created at and the variable it's created for.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/variables/{variableName}/values/{variableValueName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
variableValueName:
{
Description: The name of the variable value to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
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 ,
}
,
]
,
}
,
}
VariableValues_List (new)
Description :  This operation retrieves the list of all variable values associated with the given variable that is at a subscription level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/variables/{variableName}/values
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of variable values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
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 ,
}
,
]
,
}
,
}
VariableValues_ListForManagementGroup (new)
Description :  This operation retrieves the list of all variable values applicable the variable indicated at the management group scope.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}/values
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of variable values. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
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 ,
}
,
]
,
}
,
}
VariableValues_DeleteAtManagementGroup (new)
Description :  This operation deletes a variable value, given its name, the management group it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}/values/{variableValueName}
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
variableValueName:
{
Description: The name of the variable value to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
VariableValues_CreateOrUpdateAtManagementGroup (new)
Description :  This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}/values/{variableValueName}
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
variableValueName:
{
Description: The name of the variable value to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the variable value. ,
Required: True ,
}
{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
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 ,
}
,
]
,
}
,
}
VariableValues_GetAtManagementGroup (new)
Description :  This operation retrieves a single variable value; given its name, management group it was created at and the variable it's created for.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}/values/{variableValueName}
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
variableValueName:
{
Description: The name of the variable value to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable value. ,
Required: True ,
}
{
values:
{
Description: Variable value column value array. ,
Required: True ,
}
[
{
columnName:
{
Description: Column name for the variable value ,
Required: True ,
}
string ,
columnValue:
{
Description: Column value for the variable value; this can be an integer, double, boolean, null or a string. ,
Required: True ,
}
object ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables/values). ,
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 ,
}
,
]
,
}
,
}
Variables_Delete (new)
Description :  This operation deletes a variable, given its name and the subscription it was created in. The scope of a variable is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/variables/{variableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Variables_CreateOrUpdate (new)
Description :  This operation creates or updates a variable with the given subscription and name. Policy variables can only be used by a policy definition at the scope they are created or below.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/variables/{variableName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the variable. ,
Required: True ,
}
{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
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 ,
}
,
]
,
}
,
}
Variables_Get (new)
Description :  This operation retrieves a single variable, given its name and the subscription it was created at.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
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 ,
}
,
]
,
}
,
}
Variables_DeleteAtManagementGroup (new)
Description :  This operation deletes a variable, given its name and the management group it was created in. The scope of a variable is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Variables_CreateOrUpdateAtManagementGroup (new)
Description :  This operation creates or updates a variable with the given management group and name. Policy variables can only be used by a policy definition at the scope they are created or below.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the variable. ,
Required: True ,
}
{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
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 ,
}
,
]
,
}
,
}
Variables_GetAtManagementGroup (new)
Description :  This operation retrieves a single variable, given its name and the management group it was created at.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/variables/{variableName}
{
managementGroupId:
{
Description: The ID of the management group. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of the variable to operate on. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
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 ,
}
,
]
,
}
,
}
Variables_List (new)
Description :  This operation retrieves the list of all variables associated with the given subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of variables. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
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 ,
}
,
]
,
}
,
}
Variables_ListForManagementGroup (new)
Description :  This operation retrieves the list of all variables applicable to the management group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of variables. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for the variable. ,
Required: True ,
}
{
columns:
{
Description: Variable column definitions. ,
Required: True ,
}
[
{
columnName:
{
Description: The name of this policy variable column. ,
Required: True ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The ID of the variable. ,
Required: False ,
}
string ,
name:
{
Description: The name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource (Microsoft.Authorization/variables). ,
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 ,
}
,
]
,
}
,
}