Get-AzResourceGroupDeploymentStackWhatIfResult
Gets a resource group scoped deployment stack WhatIf result.
Syntax
List (Default)
Get-AzResourceGroupDeploymentStackWhatIfResult
-ResourceGroupName <String>
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByName
Get-AzResourceGroupDeploymentStackWhatIfResult
-Name <String>
-ResourceGroupName <String>
[-IncludePropertyChange]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceId
Get-AzResourceGroupDeploymentStackWhatIfResult
-ResourceId <String>
[-IncludePropertyChange]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Gets one or more resource group scoped deployment stack WhatIf result resources.
Examples
Example 1: List deployment stack WhatIf results in a resource group
Get-AzResourceGroupDeploymentStackWhatIfResult -ResourceGroupName MyResourceGroup
Gets deployment stack WhatIf results in resource group MyResourceGroup.
Example 2: Get a deployment stack WhatIf result by name
Get-AzResourceGroupDeploymentStackWhatIfResult -Name MyWhatIfResult -ResourceGroupName MyResourceGroup
Gets the deployment stack WhatIf result named MyWhatIfResult in resource group MyResourceGroup.
Example 3: Get a deployment stack WhatIf result with property changes
Get-AzResourceGroupDeploymentStackWhatIfResult -Name MyWhatIfResult -ResourceGroupName MyResourceGroup -IncludePropertyChange
Gets the deployment stack WhatIf result named MyWhatIfResult with resource property changes populated.
Example 4: Get a deployment stack WhatIf result by resource ID
$subscriptionId = (Get-AzContext).Subscription.Id
$whatIfResultId = "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroup/providers/Microsoft.Resources/deploymentStacksWhatIfResults/MyWhatIfResult"
Get-AzResourceGroupDeploymentStackWhatIfResult -ResourceId $whatIfResultId
Gets the deployment stack WhatIf result by its fully-qualified resource ID.
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
-IncludePropertyChange
If set, returns the WhatIf result with resource property changes populated.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the WhatIf result to get.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Pre
When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
GetByName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
The fully-qualified resource ID of the WhatIf result to get.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Id
Parameter sets
GetByResourceId
Position: Named Mandatory: True 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 .
Outputs
