ArmDeploymentResource.WhatIf Method

Definition

Namespace:

Azure.ResourceManager.Resources

Assembly:

Azure.ResourceManager.Resources.dll

Package:

Azure.ResourceManager.Resources v1.9.0

Source:

ArmDeploymentResource.cs

Returns changes that will be made by the deployment if executed at the scope of the tenant group.

• Request Path: /providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
• Operation Id: Deployments_WhatIfAtTenantScope
• Default Api Version: 2024-03-01
• Resource: ArmDeploymentResource
• Request Path: /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
• Operation Id: Deployments_WhatIfAtManagementGroupScope
• Default Api Version: 2024-03-01
• Resource: ArmDeploymentResource
• Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
• Operation Id: Deployments_WhatIfAtSubscriptionScope
• Default Api Version: 2024-03-01
• Resource: ArmDeploymentResource
• Request Path: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
• Operation Id: Deployments_WhatIf
• Default Api Version: 2024-03-01
• Resource: ArmDeploymentResource

public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Resources.Models.WhatIfOperationResult> WhatIf (Azure.WaitUntil waitUntil, Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfContent content, System.Threading.CancellationToken cancellationToken = default);

abstract member WhatIf : Azure.WaitUntil * Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Resources.Models.WhatIfOperationResult>
override this.WhatIf : Azure.WaitUntil * Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Resources.Models.WhatIfOperationResult>

Public Overridable Function WhatIf (waitUntil As WaitUntil, content As ArmDeploymentWhatIfContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of WhatIfOperationResult)

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

content

ArmDeploymentWhatIfContent

Parameters to validate.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

ArmOperation<WhatIfOperationResult>

Exceptions

ArgumentNullException

content is null.