Get-AzBlueprint
Get one or more blueprint definitions.
Syntax
Get-AzBlueprint
[-SubscriptionId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
-Name <String>
-ManagementGroupId <String>
[-Version] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
[-Name <String>]
[-SubscriptionId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
-Name <String>
-ManagementGroupId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
-Name <String>
-ManagementGroupId <String>
[-LatestPublished]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
-Name <String>
[-SubscriptionId <String>]
[-LatestPublished]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
-Name <String>
[-SubscriptionId <String>]
[-Version] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBlueprint
-ManagementGroupId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Get one or more blueprint definitions. Blueprint definitions exist at the management group or subscription scope.
Examples
Example 1
Get-AzBlueprint
Name : PS-BlueprintDefinition
Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/providers/Microsoft.Blueprint/blueprints/PS-BlueprintDefinition
SubscriptionId : aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e
Versions : {1.0}
Description : Powershell test blueprint
TimeCreated : 2019-02-01
TargetScope : Subscription
Parameters : {storageData_storageAccountType, storageData_location, allowedlocations_listOfAllowedLocations}
ResourceGroups : ResourceGroup
Get the blueprint definitions within the current subscription and the management group hierarchy of the subscription.
Example 2
Get-AzBlueprint -ManagementGroupId "myManagementGroupId"
Name : PS-MG-BlueprintDefinition
Id : /providers/Microsoft.Management/managementGroups/myManagementGroupId/providers/Microsoft.Blueprint/blueprints/PS-MG-BlueprintDefinition
ManagementGroupId : myManagementGroupId
Versions : {1.0, 2.0, 3.0, 4.0}
TimeCreated : 2019-03-04
TargetScope : Subscription
Parameters : {enforcetaganditsvalue_tagName, enforcetaganditsvalue_tagValue, [Usergrouporapplicationname]:Contributor_RoleAssignmentName,
[Usergrouporapplicationname]:Owner_RoleAssignmentName}
ResourceGroups : {ResourceGroup, ResourceGroup2}
Get the blueprint definitions within the specified management group.
Example 3
Get-AzBlueprint -SubscriptionId "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"
Name : PS-BlueprintDefinition
Id : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/providers/Microsoft.Blueprint/blueprints/PS-BlueprintDefinition
SubscriptionId : aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e
Versions : {1.0}
Description : Powershell test blueprint
TimeCreated : 2019-02-01
TargetScope : Subscription
Parameters : {storageData_storageAccountType, storageData_location, allowedlocations_listOfAllowedLocations}
ResourceGroups : ResourceGroup
Get the blueprint definitions within the specified subscription and the management group hierarchy of the subscription.
Example 4
Get-AzBlueprint -SubscriptionId "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e" -Name "myBlueprintName"
Get the blueprint definition with the given name within the specified subscription.
Example 5
Get-AzBlueprint -ManagementGroupId "myManagementGroupId" -Name "myBlueprintName" -Version "myBlueprintVersion"
Get the blueprint definition with the given name and version within the specified management group.
Example 6
Get-AzBlueprint -ManagementGroupId "myManagementGroupId" -Name "myBlueprintName" -LatestPublished
Get the latest published blueprint definition with the given name within the specified management group.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LatestPublished
The latest published blueprint definition flag. When set, execution returns the latest published version of the blueprint definition. Defaults to false.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagementGroupId
Management Group Id where the blueprint definition is saved.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Blueprint definition name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
Subscription Id where the blueprint definition is saved.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Version
Published blueprint definition version.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |