Edit

Share via


Get-AzBlueprintAssignment

Get one or more blueprint assignments.

Syntax

SubscriptionScope (Default)

Get-AzBlueprintAssignment
    [-SubscriptionId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

BySubscriptionAndName

Get-AzBlueprintAssignment
    -Name <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByManagementGroupAndName

Get-AzBlueprintAssignment
    -Name <String>
    -ManagementGroupId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ManagementGroupScope

Get-AzBlueprintAssignment
    -ManagementGroupId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Get one or more blueprint assignments. Blueprint assignments exist at the subscription scope.

Examples

Example 1

Get-AzBlueprintAssignment -SubscriptionId "00000000-1111-0000-1111-000000000000"
Name              : Assignment-PS-BlueprintDefinition
Id                : /subscriptions/00000000-1111-0000-1111-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/Assignment-PS-BlueprintDefinition
Scope             : /subscriptions/00000000-1111-0000-1111-000000000000
LastModified      : 2019-01-08
LockMode          : AllResourcesReadOnly
ProvisioningState : Succeeded
Parameters        : {applytaganditsdefaultvalue_tagName, applytaganditsdefaultvalue_tagValue}
ResourceGroups    : ResourceGroup

Get the blueprint assignments within the specified subscription.

Example 2

Get-AzBlueprintAssignment -SubscriptionId "00000000-1111-0000-1111-000000000000" -Name "myAssignmentName"

Get the blueprint assignment with the given name within the specified subscription.

Example 3

Get-AzBlueprintAssignment -ManagementGroupId "myManagementGroup"

Get the blueprint assignments within the specified management group.

Example 4

Get-AzBlueprintAssignment -ManagementGroupId "myManagementGroup" -Name "myAssignmentName"

Get the blueprint assignment with the given name within the specified management group.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ManagementGroupId

The ID of the management group where the Blueprint assignment is saved.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByManagementGroupAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ManagementGroupScope
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Blueprint assignment name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

BySubscriptionAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByManagementGroupAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SubscriptionId

Subscription Id the blueprint assignment is deployed to.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SubscriptionScope
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
BySubscriptionAndName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

Object