Microsoft.Blueprint (preview:2017-11-11)

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

Assignments_CreateOrUpdate (new)
Description :  Create or update a Blueprint assignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
assignmentName:
{
Description: name of the assignment. ,
Required: True ,
}
string ,
assignment:
{
Description: assignment object to save. ,
Required: True ,
}
{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 ,
}
,
}
Assignments_Get (new)
Description :  Get a Blueprint assignment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
assignmentName:
{
Description: name of the assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 ,
}
,
}
Assignments_Delete (new)
Description :  Delete a Blueprint assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
assignmentName:
{
Description: name of the assignment. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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)

{}
Assignments_List (new)
Description :  List Blueprint assignments within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Blueprint assignments. ,
Required: False ,
}
[
{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 ,
}
Assignments_CreateOrUpdate (removed)
Description :  Create or update a Blueprint assignment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
assignmentName:
{
Description: name of the assignment. ,
Required: True ,
}
string ,
assignment:
{
Description: assignment object to save. ,
Required: True ,
}
{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 ,
}
,
}
Assignments_Get (removed)
Description :  Get a Blueprint assignment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
assignmentName:
{
Description: name of the assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 ,
}
,
}
Assignments_Delete (removed)
Description :  Delete a Blueprint assignment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
assignmentName:
{
Description: name of the assignment. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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)

{}
Assignments_List (removed)
Description :  List Blueprint assignments within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: azure subscriptionId, which we assign the blueprint to. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Blueprint assignments. ,
Required: False ,
}
[
{
identity:
{
Description: Managed Service Identity for this Blueprint assignment ,
Required: True ,
}
{
type:
{
Description: Type of the Managed Service 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 ,
}
,
properties:
{
Description: Properties for Assignment object. ,
Required: True ,
}
{
blueprintId:
{
Description: ID of the Blueprint definition resource. ,
Required: False ,
}
string ,
parameters:
{
Description: Blueprint 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 ,
}
object ,
locks:
{
Description: Defines how Blueprint-managed resources will be locked. ,
Required: False ,
}
{
mode:
{
Description: Lock mode. ,
Enum:
{
None: No description available. ,
AllResources: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the 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 ,
}