Share via


ContainerGroupCollection Class

Definition

A class representing a collection of ContainerGroupResource and their operations. Each ContainerGroupResource in the collection will belong to the same instance of ResourceGroupResource. To get a ContainerGroupCollection instance call the GetContainerGroups method from an instance of ResourceGroupResource.

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

Constructors

ContainerGroupCollection()

Initializes a new instance of the ContainerGroupCollection 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, ContainerGroupData, CancellationToken)

Create or update container groups with specified configurations.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_CreateOrUpdate
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
CreateOrUpdateAsync(WaitUntil, String, ContainerGroupData, CancellationToken)

Create or update container groups with specified configurations.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_CreateOrUpdate
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
Get(String, CancellationToken)

Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
GetAll(CancellationToken)

Get a list of container groups in a specified subscription and resource group. 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups
  • Operation Id: ContainerGroups_ListByResourceGroup
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
GetAllAsync(CancellationToken)

Get a list of container groups in a specified subscription and resource group. 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups
  • Operation Id: ContainerGroups_ListByResourceGroup
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
GetAsync(String, CancellationToken)

Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
  • Operation Id: ContainerGroups_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupResource
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<ContainerGroupResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ContainerGroupResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to