ContainerInstanceExtensions.GetContainerGroupsAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ContainerInstance
Assembly:
Azure.ResourceManager.ContainerInstance.dll
Package:
Azure.ResourceManager.ContainerInstance v1.2.1
Package:
Azure.ResourceManager.ContainerInstance v1.3.0-beta.1
Source:
ContainerInstanceExtensions.cs
Source:
ContainerInstanceExtensions.cs

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups
  • Operation Id: ContainerGroups_List
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
public static Azure.AsyncPageable<Azure.ResourceManager.ContainerInstance.ContainerGroupResource> GetContainerGroupsAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);
static member GetContainerGroupsAsync : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ContainerInstance.ContainerGroupResource>
<Extension()>
Public Function GetContainerGroupsAsync (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ContainerGroupResource)

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ContainerGroupResource>

An async collection of ContainerGroupResource that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

subscriptionResource is null.

Applies to