ResourcesExtensions.GetArmDeployment Method

Definition

Namespace:: Azure.ResourceManager.Resources

Assemblies:: Azure.ResourceManager.Resources.dll, Azure.ResourceManager.Resources.Deployments.dll

Assembly:: Azure.ResourceManager.Resources.dll

Packages:: Azure.ResourceManager.Resources v1.12.0-beta.1, Azure.ResourceManager.Resources.Deployments v1.0.0-beta.1

Package:: Azure.ResourceManager.Resources v1.11.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
GetArmDeployment(ArmClient, ResourceIdentifier, String, CancellationToken)	Gets a deployment. <item> Mocking. To mock this method, please mock GetArmDeployment(ResourceIdentifier, String, CancellationToken) instead. </item>
GetArmDeployment(TenantResource, String, CancellationToken)	Gets a deployment. Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName} Operation Id: Deployments_GetAtScope Default Api Version: 2025-04-01 Resource: ArmDeploymentResource <item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>
GetArmDeployment(SubscriptionResource, String, CancellationToken)	Gets a deployment. Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName} Operation Id: Deployments_GetAtScope Default Api Version: 2025-04-01 Resource: ArmDeploymentResource <item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>
GetArmDeployment(ResourceGroupResource, String, CancellationToken)	Gets a deployment. Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName} Operation Id: Deployments_GetAtScope Default Api Version: 2025-04-01 Resource: ArmDeploymentResource <item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>
GetArmDeployment(ManagementGroupResource, String, CancellationToken)	Gets a deployment. Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName} Operation Id: Deployments_GetAtScope Default Api Version: 2025-04-01 Resource: ArmDeploymentResource <item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>

GetArmDeployment(ArmClient, ResourceIdentifier, String, CancellationToken)

Source:: ResourcesExtensions.cs

Gets a deployment. <item> Mocking. To mock this method, please mock GetArmDeployment(ResourceIdentifier, String, CancellationToken) instead. </item>

public static Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource> GetArmDeployment(this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, string deploymentName, System.Threading.CancellationToken cancellationToken = default);

static member GetArmDeployment : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource>

<Extension()>
Public Function GetArmDeployment (client As ArmClient, scope As ResourceIdentifier, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ArmDeploymentResource)

Parameters

client: ArmClient

The ArmClient the method will execute against.

scope: ResourceIdentifier

The scope of the resource collection to get.

deploymentName: String

The name of the deployment.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<ArmDeploymentResource>

Exceptions

ArgumentNullException

client is null.

Applies to

GetArmDeployment(TenantResource, String, CancellationToken)

Source:: ResourcesExtensions.cs

Source:: ResourcesExtensions.cs

Gets a deployment.

Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Operation Id: Deployments_GetAtScope
Default Api Version: 2025-04-01
Resource: ArmDeploymentResource

<item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>

public static Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource> GetArmDeployment(this Azure.ResourceManager.Resources.TenantResource tenantResource, string deploymentName, System.Threading.CancellationToken cancellationToken = default);

static member GetArmDeployment : Azure.ResourceManager.Resources.TenantResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource>

<Extension()>
Public Function GetArmDeployment (tenantResource As TenantResource, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ArmDeploymentResource)

Parameters

tenantResource: TenantResource

The TenantResource instance the method will execute against.

deploymentName: String

The name of the deployment.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<ArmDeploymentResource>

Exceptions

ArgumentNullException

tenantResource or deploymentName is null.

ArgumentException

deploymentName is an empty string, and was expected to be non-empty.

Applies to

GetArmDeployment(SubscriptionResource, String, CancellationToken)

Source:: ResourcesExtensions.cs

Source:: ResourcesExtensions.cs

Gets a deployment.

Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Operation Id: Deployments_GetAtScope
Default Api Version: 2025-04-01
Resource: ArmDeploymentResource

<item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>

public static Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource> GetArmDeployment(this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string deploymentName, System.Threading.CancellationToken cancellationToken = default);

static member GetArmDeployment : Azure.ResourceManager.Resources.SubscriptionResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource>

<Extension()>
Public Function GetArmDeployment (subscriptionResource As SubscriptionResource, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ArmDeploymentResource)

Parameters

subscriptionResource: SubscriptionResource

The SubscriptionResource instance the method will execute against.

deploymentName: String

The name of the deployment.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<ArmDeploymentResource>

Exceptions

ArgumentNullException

subscriptionResource or deploymentName is null.

ArgumentException

deploymentName is an empty string, and was expected to be non-empty.

Applies to

GetArmDeployment(ResourceGroupResource, String, CancellationToken)

Source:: ResourcesExtensions.cs

Source:: ResourcesExtensions.cs

Gets a deployment.

Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Operation Id: Deployments_GetAtScope
Default Api Version: 2025-04-01
Resource: ArmDeploymentResource

<item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>

public static Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource> GetArmDeployment(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string deploymentName, System.Threading.CancellationToken cancellationToken = default);

static member GetArmDeployment : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource>

<Extension()>
Public Function GetArmDeployment (resourceGroupResource As ResourceGroupResource, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ArmDeploymentResource)

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

deploymentName: String

The name of the deployment.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<ArmDeploymentResource>

Exceptions

ArgumentNullException

resourceGroupResource or deploymentName is null.

ArgumentException

deploymentName is an empty string, and was expected to be non-empty.

Applies to

GetArmDeployment(ManagementGroupResource, String, CancellationToken)

Source:: ResourcesExtensions.cs

Source:: ResourcesExtensions.cs

Gets a deployment.

Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Operation Id: Deployments_GetAtScope
Default Api Version: 2025-04-01
Resource: ArmDeploymentResource

<item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>

public static Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource> GetArmDeployment(this Azure.ResourceManager.ManagementGroups.ManagementGroupResource managementGroupResource, string deploymentName, System.Threading.CancellationToken cancellationToken = default);

static member GetArmDeployment : Azure.ResourceManager.ManagementGroups.ManagementGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Resources.ArmDeploymentResource>

<Extension()>
Public Function GetArmDeployment (managementGroupResource As ManagementGroupResource, deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ArmDeploymentResource)