ContainerGroupCollection.GetAsync(String, CancellationToken) Method

Definition

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
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupResource>> GetAsync (string containerGroupName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupResource>>
Public Overridable Function GetAsync (containerGroupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ContainerGroupResource))

Parameters

containerGroupName
String

The name of the container group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

containerGroupName is null.

Applies to