Share via


ContainerInstanceExtensions.GetContainerGroupProfileAsync Method

Definition

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
  • Operation Id: ContainerGroupProfiles_Get
  • Default Api Version: 2024-05-01-preview
  • Resource: ContainerGroupProfileResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupProfileResource>> GetContainerGroupProfileAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string containerGroupProfileName, System.Threading.CancellationToken cancellationToken = default);
static member GetContainerGroupProfileAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.ContainerGroupProfileResource>>
<Extension()>
Public Function GetContainerGroupProfileAsync (resourceGroupResource As ResourceGroupResource, containerGroupProfileName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ContainerGroupProfileResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

containerGroupProfileName
String

The name of the container group profile.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or containerGroupProfileName is null.

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

Applies to