DeploymentStackWhatIfCmdlet Class

Definition

Base class for Deployment Stack What-If cmdlets.

public abstract class DeploymentStackWhatIfCmdlet : Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.CmdletBase.DeploymentStacksCreateCmdletBase
type DeploymentStackWhatIfCmdlet = class
    inherit DeploymentStacksCreateCmdletBase
Public MustInherit Class DeploymentStackWhatIfCmdlet
Inherits DeploymentStacksCreateCmdletBase
Inheritance

Constructors

Name Description
DeploymentStackWhatIfCmdlet()

Fields

Name Description
_adalListener (Inherited from AzurePSCmdlet)
_clientRequestId (Inherited from AzurePSCmdlet)
_cmdletContext (Inherited from AzurePSCmdlet)
_fileTimeStampSuffixFormat (Inherited from AzurePSCmdlet)
_metricHelper (Inherited from AzurePSCmdlet)
_qosEvent (Inherited from AzurePSCmdlet)
_serviceClientTracingInterceptor (Inherited from AzureRMCmdlet)
AUX_HEADER_NAME (Inherited from AzureRMCmdlet)
AUX_TOKEN_APPEND_CHAR (Inherited from AzureRMCmdlet)
AUX_TOKEN_PREFIX (Inherited from AzureRMCmdlet)
EnqueueDebugKey (Inherited from AzureRMCmdlet)
MAX_NUMBER_OF_TOKENS_ALLOWED_IN_AUX_HEADER (Inherited from AzureRMCmdlet)
protectedTemplateUri (Inherited from DeploymentStacksCreateCmdletBase)
WriteDebugKey (Inherited from AzureRMCmdlet)
WriteInformationKey (Inherited from AzureRMCmdlet)
WriteVerboseKey (Inherited from AzureRMCmdlet)
WriteWarningKey (Inherited from AzureRMCmdlet)

Properties

Name Description
_dataCollectionProfile (Inherited from AzurePSCmdlet)
_matchers (Inherited from AzurePSCmdlet)
AsJob
AsJobDynamicParameters (Inherited from AzurePSCmdlet)
CancellationToken

Gets the cancellation source.

(Inherited from ResourceManagerCmdletBase)
DataCollectionWarning (Inherited from AzureRMCmdlet)
DebugMessages (Inherited from AzurePSCmdlet)
DefaultContext (Inherited from AzureRMCmdlet)
DefaultProfile (Inherited from AzureRMCmdlet)
DeploymentStacksSdkClient

Gets or sets the deployment stacks sdk client

(Inherited from DeploymentStacksCmdletBase)
DeploymentStacksWhatIfSdkClient

Gets or sets the deployment stacks what-if sdk client (separate resource type)

(Inherited from DeploymentStacksCmdletBase)
Force
ImplementationBackgroundJobDescription (Inherited from AzurePSCmdlet)
IsErrorMetricEnabled (Inherited from AzurePSCmdlet)
IsSetCmdlet
IsUsageMetricEnabled (Inherited from AzurePSCmdlet)
ModuleName (Inherited from AzurePSCmdlet)
ModuleVersion (Inherited from AzurePSCmdlet)
NewResourceManagerSdkClient

Gets or sets the resource manager sdk client

(Inherited from ResourceManagerCmdletBase)
Pre

Gets or sets the switch that indicates if pre-release API version should be considered.

(Inherited from ResourceManagerCmdletBase)
PSVersion
Obsolete.
(Inherited from AzurePSCmdlet)
QueryString (Inherited from DeploymentStacksCreateCmdletBase)
ResourceManagerSdkClient

Gets or sets the resource manager sdk client

(Inherited from ResourceManagerCmdletBase)
SessionState (Inherited from AzurePSCmdlet)
SkipTemplateParameterPrompt (Inherited from DeploymentStacksCreateCmdletBase)
SubscriptionSdkClient

Gets or sets the subscription sdk client

(Inherited from ResourceManagerCmdletBase)
TemplateFile (Inherited from DeploymentStacksCreateCmdletBase)
TemplateObject (Inherited from DeploymentStacksCreateCmdletBase)
TemplateParameterFile (Inherited from DeploymentStacksCreateCmdletBase)
TemplateParameterObject (Inherited from DeploymentStacksCreateCmdletBase)
TemplateParameterUri (Inherited from DeploymentStacksCreateCmdletBase)
TemplateSpecId (Inherited from DeploymentStacksCreateCmdletBase)
TemplateSpecsClient

TemplateSpecsClient for making template spec sdk calls. On first access, it will be initialized before being returned.

(Inherited from DeploymentStacksCreateCmdletBase)
TemplateUri (Inherited from DeploymentStacksCreateCmdletBase)

Methods

Name Description
AddDebuggingFilter(Regex) (Inherited from AzurePSCmdlet)
BeginProcessing()

The BeginProcessing method.

(Inherited from ResourceManagerCmdletBase)
BuildAndUseBicepParameters(Boolean)

Attempts to build the bicep param file. If no other template file, uri, or spec is present, a template or template spec will try to be extracted from the bicep param build output.

(Inherited from DeploymentStacksCreateCmdletBase)
BuildAndUseBicepTemplate()

Constructs a TemplateObject from the bicep file located at the TemplateFile address.

(Inherited from DeploymentStacksCreateCmdletBase)
BuildWhatIfParameters()

It's important not to call this function more than once during an invocation, as it can call the Bicep CLI. This is slow, and can also cause diagnostics to be emitted multiple times.

ConfirmAction(Boolean, String, String, String, Action, Func<Boolean>) (Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action) (Inherited from AzureRMCmdlet)
ConfirmAction(String, String, Action) (Inherited from AzurePSCmdlet)
ConfirmResourceAction(String, Boolean, String, String, Action, Func<Boolean>) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, Action) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, Boolean, String, String, Action, Func<Boolean>) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, String, Action) (Inherited from AzureRMCmdlet)
ConstructPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
CurrentPath() (Inherited from AzurePSCmdlet)
DetermineParameterSetName()

Determines the parameter set name.

(Inherited from ResourceManagerCmdletBase)
Dispose() (Inherited from AzurePSCmdlet)
Dispose(Boolean) (Inherited from AzureRMCmdlet)
EndProcessing()

The EndProcessing method.

(Inherited from ResourceManagerCmdletBase)
ExecuteCmdlet()

The ProcessRecord method.

(Inherited from ResourceManagerCmdletBase)
ExecuteWhatIf(PSDeploymentStackWhatIfParameters)
FlushInitializationWarnings() (Inherited from AzurePSCmdlet)
GetAuxilaryAuthHeaderFromResourceIds(List<String>) (Inherited from AzureRMCmdlet)
GetAuxiliaryAuthHeaderFromTenantIds(IEnumerable<String>) (Inherited from AzureRMCmdlet)
GetDynamicParameters()

Attempts to load dynamic parameters from populated template/template parameter properties. Runs on every tab complete and before processing on execution. It will silently fail (exception is caught and not visible to user) until required properties are popluated.

(Inherited from DeploymentStacksCreateCmdletBase)
GetResourcesClient()

Gets a new instance of the ResourceManagerRestRestClient.

(Inherited from ResourceManagerCmdletBase)
GetStaticParameterNames()

Gets the names of the static parameters defined for this cmdlet.

(Inherited from DeploymentStacksCreateCmdletBase)
GetTemplateParameterObject()

Used to evaluate the combination of template parameters from passed in static properties and those extracted via dynamic parameter logic.

(Inherited from DeploymentStacksCreateCmdletBase)
InitDebuggingFilter() (Inherited from AzurePSCmdlet)
InitializeQosEvent() (Inherited from AzureRMCmdlet)
IsDataCollectionAllowed() (Inherited from AzurePSCmdlet)
IsTerminatingError(Exception) (Inherited from AzurePSCmdlet)
IsVerbose() (Inherited from AzurePSCmdlet)
LoadModuleVersion(String, Boolean) (Inherited from AzurePSCmdlet)
LogCmdletStartInvocationInfo() (Inherited from AzureRMCmdlet)
LogQosEvent() (Inherited from AzurePSCmdlet)
OnBeginProcessing() (Inherited from DeploymentStacksCreateCmdletBase)
OnEndProcessing()

When overridden, allows child classes to be called when the EndProcessing method is invoked.

(Inherited from ResourceManagerCmdletBase)
OnProcessRecord()
OnStopProcessing()

When overridden, allows child classes to be called when the StopProcessing method is invoked.

(Inherited from ResourceManagerCmdletBase)
ProcessRecord() (Inherited from AzurePSCmdlet)
RegisterDynamicParameters(RuntimeDefinedParameterDictionary) (Inherited from AzurePSCmdlet)
RequireDefaultContext() (Inherited from AzureRMCmdlet)
ResolveUserPath(String) (Inherited from AzurePSCmdlet)
ResolveUserPath(String[]) (Inherited from AzurePSCmdlet)
SafeWriteOutputPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
SetBackgroundJobDescription(String) (Inherited from AzurePSCmdlet)
SetupDebuggingTraces() (Inherited from AzureRMCmdlet)
SetupHttpClientPipeline() (Inherited from AzurePSCmdlet)
ShouldGetByName(String, String) (Inherited from AzureRMCmdlet)
ShouldListByResourceGroup(String, String) (Inherited from AzureRMCmdlet)
ShouldListBySubscription(String, String) (Inherited from AzureRMCmdlet)
StopProcessing()

The StopProcessing method.

(Inherited from ResourceManagerCmdletBase)
SubResourceWildcardFilter<T>(String, IEnumerable<T>) (Inherited from AzureRMCmdlet)
TearDownDebuggingTraces() (Inherited from AzureRMCmdlet)
TearDownHttpClientPipeline() (Inherited from AzurePSCmdlet)
ThrowTerminatingError(ErrorRecord) (Inherited from AzurePSCmdlet)
TopLevelWildcardFilter<T>(String, String, IEnumerable<T>) (Inherited from AzureRMCmdlet)
TryConvertAndWriteObject(String)

Writes the object

(Inherited from ResourceManagerCmdletBase)
TryConvertToResourceAndWriteObject(String)

Writes the object

(Inherited from ResourceManagerCmdletBase)
TryGetDefaultContext(IAzureContext) (Inherited from AzureRMCmdlet)
WriteCommandDetail(String) (Inherited from AzurePSCmdlet)
WriteDebug(String) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteError(ErrorRecord) (Inherited from AzurePSCmdlet)
WriteErrorWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteExceptionError(Exception) (Inherited from AzurePSCmdlet)
WriteInformation(Object, String[]) (Inherited from AzurePSCmdlet)
WriteInformation(String, Nullable<Boolean>) (Inherited from AzurePSCmdlet)
WriteInformationWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteInitializationWarnings(String) (Inherited from AzurePSCmdlet)
WriteObject(JToken)

Writes a Newtonsoft.Json.Linq.JToken object as a PSObject.

(Inherited from ResourceManagerCmdletBase)
WriteObject(Object, Boolean) (Inherited from AzurePSCmdlet)
WriteObject(Object) (Inherited from AzurePSCmdlet)
WriteProgress(ProgressRecord) (Inherited from AzurePSCmdlet)
WriteSurvey() (Inherited from AzurePSCmdlet)
WriteVerbose(String) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteWarning(String) (Inherited from AzurePSCmdlet)
WriteWarningWithTimestamp(String) (Inherited from AzurePSCmdlet)

Extension Methods

Name Description
DisableDataCollection(AzurePSCmdlet)
EnableDataCollection(AzurePSCmdlet)

Applies to