Share via


ArmDeploymentCollection Class

Definition

A class representing a collection of ArmDeploymentResource and their operations. Each ArmDeploymentResource in the collection will belong to the same instance of SubscriptionResource, ResourceGroupResource, ManagementGroupResource or TenantResource. To get an ArmDeploymentCollection instance call the GetArmDeployments method from an instance of SubscriptionResource, ResourceGroupResource, ManagementGroupResource or TenantResource.

public class ArmDeploymentCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Resources.ArmDeploymentResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Resources.ArmDeploymentResource>
type ArmDeploymentCollection = class
    inherit ArmCollection
    interface seq<ArmDeploymentResource>
    interface IEnumerable
    interface IAsyncEnumerable<ArmDeploymentResource>
Public Class ArmDeploymentCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ArmDeploymentResource), IEnumerable(Of ArmDeploymentResource)
Inheritance
ArmDeploymentCollection
Implements

Constructors

ArmDeploymentCollection()

Initializes a new instance of the ArmDeploymentCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, ArmDeploymentContent, CancellationToken)

You can provide the template and parameters directly in the request or link to JSON files.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_CreateOrUpdateAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
CreateOrUpdateAsync(WaitUntil, String, ArmDeploymentContent, CancellationToken)

You can provide the template and parameters directly in the request or link to JSON files.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_CreateOrUpdateAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
Get(String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetAll(String, Nullable<Int32>, CancellationToken)

Get all the deployments at the given scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments
  • Operation Id: Deployments_ListAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetAllAsync(String, Nullable<Int32>, CancellationToken)

Get all the deployments at the given scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments
  • Operation Id: Deployments_ListAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetAsync(String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<ArmDeploymentResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ArmDeploymentResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to