ContainerInstanceExtensions.GetContainerGroupAsync Method

Definition

Namespace:

Azure.ResourceManager.ContainerInstance

Assembly:

Azure.ResourceManager.ContainerInstance.dll

Package:

Azure.ResourceManager.ContainerInstance v1.2.1

Source:

ContainerInstanceExtensions.cs

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 static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupResource>> GetContainerGroupAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string containerGroupName, System.Threading.CancellationToken cancellationToken = default);

static member GetContainerGroupAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupResource>>

<Extension()>
Public Function GetContainerGroupAsync (resourceGroupResource As ResourceGroupResource, containerGroupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ContainerGroupResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

containerGroupName

String

The name of the container group.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ContainerGroupResource>>

Exceptions

ArgumentNullException

resourceGroupResource or containerGroupName is null.

ArgumentException

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