Microsoft.Blueprint (preview:2018-11-01)

2025/10/23 • 21 new, 21 deleted methods

AssignmentOperations_List (new)
Description :  List operations for given blueprint assignment within a subscription or a management group.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/assignmentOperations
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AssignmentOperation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for AssignmentOperation. ,
Required: False ,
}
{
blueprintVersion:
{
Description: The published version of the blueprint definition used for the blueprint assignment operation. ,
Required: False ,
}
string ,
assignmentState:
{
Description: State of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Create time of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeStarted:
{
Description: Start time of the underlying deployment. ,
Required: False ,
}
string ,
timeFinished:
{
Description: Finish time of the overall underlying deployments. ,
Required: False ,
}
string ,
deployments:
{
Description: List of jobs in this blueprint assignment operation. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of job. ,
Required: False ,
}
string ,
action:
{
Description: Name of the action performed in this job. ,
Required: False ,
}
string ,
jobId:
{
Description: Id of this job. ,
Required: False ,
}
string ,
jobState:
{
Description: State of this job. ,
Required: False ,
}
string ,
result:
{
Description: Deployment job result. ,
Required: False ,
}
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
history:
{
Description: Result of this deployment job for each retry. ,
Required: False ,
}
[
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
requestUri:
{
Description: Reference to deployment job resource id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
AssignmentOperations_Get (new)
Description :  Get a blueprint assignment operation.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/assignmentOperations/{assignmentOperationName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
assignmentOperationName:
{
Description: Name of the blueprint assignment operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for AssignmentOperation. ,
Required: False ,
}
{
blueprintVersion:
{
Description: The published version of the blueprint definition used for the blueprint assignment operation. ,
Required: False ,
}
string ,
assignmentState:
{
Description: State of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Create time of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeStarted:
{
Description: Start time of the underlying deployment. ,
Required: False ,
}
string ,
timeFinished:
{
Description: Finish time of the overall underlying deployments. ,
Required: False ,
}
string ,
deployments:
{
Description: List of jobs in this blueprint assignment operation. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of job. ,
Required: False ,
}
string ,
action:
{
Description: Name of the action performed in this job. ,
Required: False ,
}
string ,
jobId:
{
Description: Id of this job. ,
Required: False ,
}
string ,
jobState:
{
Description: State of this job. ,
Required: False ,
}
string ,
result:
{
Description: Deployment job result. ,
Required: False ,
}
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
history:
{
Description: Result of this deployment job for each retry. ,
Required: False ,
}
[
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
requestUri:
{
Description: Reference to deployment job resource id. ,
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 ,
}
,
]
,
}
,
}
Assignments_CreateOrUpdate (new)
Description :  Create or update a blueprint assignment.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
assignment:
{
Description: Blueprint assignment object to save. ,
Required: True ,
}
{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
deleteBehavior:
{
Description: When deleteBehavior=all, the resources that were created by the blueprint assignment will be deleted. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

POST:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/whoIsBlueprint
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
objectId:
{
Description: AAD object Id of the Azure Blueprints service principal in the tenant. ,
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 ,
}
,
]
,
}
,
}
Assignments_List (new)
Description :  List blueprint assignments within a subscription or a management group.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint assignments. ,
Required: False ,
}
[
{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
Blueprints_CreateOrUpdate (new)
Description :  Create or update a blueprint definition.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
blueprint:
{
Description: Blueprint definition. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Blueprints_Get (new)
Description :  Get a blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Blueprints_Delete (new)
Description :  Delete a blueprint definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Blueprints_List (new)
Description :  List blueprint definitions.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
Artifacts_CreateOrUpdate (new)
Description :  Create or update blueprint artifact.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
artifact:
{
Description: Blueprint artifact to create or update. ,
Required: True ,
}
{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_List (new)
Description :  List artifacts for a given blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint artifacts. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
PublishedBlueprints_Create (new)
Description :  Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
publishedBlueprint:
{
Description: Published Blueprint to create or update. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
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 ,
}
,
]
,
}
,
}
PublishedBlueprints_Get (new)
Description :  Get a published version of a blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
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 ,
}
,
]
,
}
,
}
PublishedBlueprints_Delete (new)
Description :  Delete a published version of a blueprint definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PublishedBlueprints_List (new)
Description :  List published versions of given blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of published blueprint definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
PublishedArtifacts_Get (new)
Description :  Get an artifact for a published blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PublishedArtifacts_List (new)
Description :  List artifacts for a version of a published blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint artifacts. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
AssignmentOperations_List (removed)
Description :  List operations for given blueprint assignment within a subscription or a management group.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/assignmentOperations
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AssignmentOperation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for AssignmentOperation. ,
Required: False ,
}
{
blueprintVersion:
{
Description: The published version of the blueprint definition used for the blueprint assignment operation. ,
Required: False ,
}
string ,
assignmentState:
{
Description: State of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Create time of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeStarted:
{
Description: Start time of the underlying deployment. ,
Required: False ,
}
string ,
timeFinished:
{
Description: Finish time of the overall underlying deployments. ,
Required: False ,
}
string ,
deployments:
{
Description: List of jobs in this blueprint assignment operation. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of job. ,
Required: False ,
}
string ,
action:
{
Description: Name of the action performed in this job. ,
Required: False ,
}
string ,
jobId:
{
Description: Id of this job. ,
Required: False ,
}
string ,
jobState:
{
Description: State of this job. ,
Required: False ,
}
string ,
result:
{
Description: Deployment job result. ,
Required: False ,
}
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
history:
{
Description: Result of this deployment job for each retry. ,
Required: False ,
}
[
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
requestUri:
{
Description: Reference to deployment job resource id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
AssignmentOperations_Get (removed)
Description :  Get a blueprint assignment operation.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/assignmentOperations/{assignmentOperationName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
assignmentOperationName:
{
Description: Name of the blueprint assignment operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties for AssignmentOperation. ,
Required: False ,
}
{
blueprintVersion:
{
Description: The published version of the blueprint definition used for the blueprint assignment operation. ,
Required: False ,
}
string ,
assignmentState:
{
Description: State of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeCreated:
{
Description: Create time of this blueprint assignment operation. ,
Required: False ,
}
string ,
timeStarted:
{
Description: Start time of the underlying deployment. ,
Required: False ,
}
string ,
timeFinished:
{
Description: Finish time of the overall underlying deployments. ,
Required: False ,
}
string ,
deployments:
{
Description: List of jobs in this blueprint assignment operation. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of job. ,
Required: False ,
}
string ,
action:
{
Description: Name of the action performed in this job. ,
Required: False ,
}
string ,
jobId:
{
Description: Id of this job. ,
Required: False ,
}
string ,
jobState:
{
Description: State of this job. ,
Required: False ,
}
string ,
result:
{
Description: Deployment job result. ,
Required: False ,
}
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
history:
{
Description: Result of this deployment job for each retry. ,
Required: False ,
}
[
{
error:
{
Description: Contains error details if deployment job failed. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources created as result of the deployment job. ,
Required: False ,
}
[
{
properties:
{
Description: Additional properties in a dictionary. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
requestUri:
{
Description: Reference to deployment job resource id. ,
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 ,
}
,
]
,
}
,
}
Assignments_CreateOrUpdate (removed)
Description :  Create or update a blueprint assignment.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
assignment:
{
Description: Blueprint assignment object to save. ,
Required: True ,
}
{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
deleteBehavior:
{
Description: When deleteBehavior=all, the resources that were created by the blueprint assignment will be deleted. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

POST:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/whoIsBlueprint
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
assignmentName:
{
Description: Name of the blueprint assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
objectId:
{
Description: AAD object Id of the Azure Blueprints service principal in the tenant. ,
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 ,
}
,
]
,
}
,
}
Assignments_List (removed)
Description :  List blueprint assignments within a subscription or a management group.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint assignments. ,
Required: False ,
}
[
{
identity:
{
Description: Managed identity for this blueprint assignment. ,
Required: True ,
}
{
type:
{
Description: Type of the managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
principalId:
{
Description: Azure Active Directory principal ID associated with this Identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: ID of the Azure Active Directory. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties for blueprint assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the published version of a blueprint definition. ,
Required: False ,
}
string ,
scope:
{
Description: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint assignment parameter values. ,
Required: True ,
}
object ,
resourceGroups:
{
Description: Names and locations of resource group placeholders. ,
Required: True ,
}
object ,
status:
{
Description: Status of blueprint assignment. This field is readonly. ,
Required: False ,
}
{
managedResources:
{
Description: List of resources that were created by the blueprint assignment. ,
Required: False ,
}
[
string ,
]
,
}
,
locks:
{
Description: Defines how resources deployed by a blueprint assignment are locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResourcesReadOnly: No description available. ,
AllResourcesDoNotDelete: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: State of the blueprint assignment. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
cancelling: No description available. ,
locking: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
Blueprints_CreateOrUpdate (removed)
Description :  Create or update a blueprint definition.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
blueprint:
{
Description: Blueprint definition. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Blueprints_Get (removed)
Description :  Get a blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Blueprints_Delete (removed)
Description :  Delete a blueprint definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Blueprints_List (removed)
Description :  List blueprint definitions.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for blueprint definition. ,
Required: True ,
}
{
versions:
{
Description: Published versions of this blueprint definition. ,
Required: False ,
}
object ,
layout:
{
Description: Layout view of the blueprint definition for UI reference. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
Artifacts_CreateOrUpdate (removed)
Description :  Create or update blueprint artifact.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
artifact:
{
Description: Blueprint artifact to create or update. ,
Required: True ,
}
{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_List (removed)
Description :  List artifacts for a given blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint artifacts. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
PublishedBlueprints_Create (removed)
Description :  Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
publishedBlueprint:
{
Description: Published Blueprint to create or update. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
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 ,
}
,
]
,
}
,
}
PublishedBlueprints_Get (removed)
Description :  Get a published version of a blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
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 ,
}
,
]
,
}
,
}
PublishedBlueprints_Delete (removed)
Description :  Delete a published version of a blueprint definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PublishedBlueprints_List (removed)
Description :  List published versions of given blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of published blueprint definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for published blueprint. ,
Required: True ,
}
{
blueprintName:
{
Description: Name of the published blueprint definition. ,
Required: False ,
}
string ,
changeNotes:
{
Description: Version-specific change notes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}
PublishedArtifacts_Get (removed)
Description :  Get an artifact for a published blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts/{artifactName}
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
artifactName:
{
Description: Name of the blueprint artifact. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PublishedArtifacts_List (removed)
Description :  List artifacts for a version of a published blueprint definition.
Reference :  Link ¶

⚼ Request

GET:  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
resourceScope:
{
Description: The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'). ,
Required: True ,
}
string ,
blueprintName:
{
Description: Name of the blueprint definition. ,
Required: True ,
}
string ,
versionId:
{
Description: Version of the published blueprint definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blueprint artifacts. ,
Required: False ,
}
[
{
kind:
{
Description: Specifies the kind of blueprint artifact. ,
Enum:
{
template: No description available. ,
roleAssignment: No description available. ,
policyAssignment: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to the next page 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 ,
}
,
]
,
}
,
}