ContainerGroupResource.AttachContainerAsync(String, CancellationToken) Method

Definition

Attach to the output stream of a specific container instance in a specified resource group and container group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach
  • Operation Id: Containers_Attach
  • Default Api Version: 2024-05-01-preview
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.Models.ContainerAttachResult>> AttachContainerAsync (string containerName, System.Threading.CancellationToken cancellationToken = default);
abstract member AttachContainerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.Models.ContainerAttachResult>>
override this.AttachContainerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.Models.ContainerAttachResult>>
Public Overridable Function AttachContainerAsync (containerName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ContainerAttachResult))

Parameters

containerName
String

The name of the container instance.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

containerName is null.

Applies to