ArmDeploymentResource.WhatIfAsync Method

Definition

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 System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Resources.Models.WhatIfOperationResult>> WhatIfAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member WhatIfAsync : Azure.WaitUntil * Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Resources.Models.WhatIfOperationResult>>
override this.WhatIfAsync : Azure.WaitUntil * Azure.ResourceManager.Resources.Models.ArmDeploymentWhatIfContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Resources.Models.WhatIfOperationResult>>
Public Overridable Function WhatIfAsync (waitUntil As WaitUntil, content As ArmDeploymentWhatIfContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Exceptions

content is null.

Applies to