ContainerGroupResource.ExecuteContainerCommandAsync Method

Definition

Executes a command for 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}/exec
  • Operation Id: Containers_ExecuteCommand
  • Default Api Version: 2024-05-01-preview
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.Models.ContainerExecResult>> ExecuteContainerCommandAsync (string containerName, Azure.ResourceManager.ContainerInstance.Models.ContainerExecContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member ExecuteContainerCommandAsync : string * Azure.ResourceManager.ContainerInstance.Models.ContainerExecContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.Models.ContainerExecResult>>
override this.ExecuteContainerCommandAsync : string * Azure.ResourceManager.ContainerInstance.Models.ContainerExecContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerInstance.Models.ContainerExecResult>>
Public Overridable Function ExecuteContainerCommandAsync (containerName As String, content As ContainerExecContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ContainerExecResult))

Parameters

containerName
String

The name of the container instance.

content
ContainerExecContent

The request for the exec command.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

containerName or content is null.

Applies to