ContainersClient Interface

public interface ContainersClient

An instance of this class provides access to all the operations defined in ContainersClient.

Method Summary

Modifier and Type Method and Description
abstract ContainerAttachResponseInner attach(String resourceGroupName, String containerGroupName, String containerName)

Attach to the output of a specific container instance.

abstract Mono<ContainerAttachResponseInner> attachAsync(String resourceGroupName, String containerGroupName, String containerName)

Attach to the output of a specific container instance.

abstract Response<ContainerAttachResponseInner> attachWithResponse(String resourceGroupName, String containerGroupName, String containerName, Context context)

Attach to the output of a specific container instance.

abstract Mono<Response<ContainerAttachResponseInner>> attachWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName)

Attach to the output of a specific container instance.

abstract ContainerExecResponseInner executeCommand(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)

Executes a command in a specific container instance.

abstract Mono<ContainerExecResponseInner> executeCommandAsync(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)

Executes a command in a specific container instance.

abstract Response<ContainerExecResponseInner> executeCommandWithResponse(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest, Context context)

Executes a command in a specific container instance.

abstract Mono<Response<ContainerExecResponseInner>> executeCommandWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)

Executes a command in a specific container instance.

abstract LogsInner listLogs(String resourceGroupName, String containerGroupName, String containerName)

Get the logs for a specified container instance.

abstract Mono<LogsInner> listLogsAsync(String resourceGroupName, String containerGroupName, String containerName)

Get the logs for a specified container instance.

abstract Response<LogsInner> listLogsWithResponse(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps, Context context)

Get the logs for a specified container instance.

abstract Mono<Response<LogsInner>> listLogsWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps)

Get the logs for a specified container instance.

Method Details

attach

public abstract ContainerAttachResponseInner attach(String resourceGroupName, String containerGroupName, String containerName)

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

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.

Returns:

the information for the output stream from container attach.

attachAsync

public abstract Mono attachAsync(String resourceGroupName, String containerGroupName, String containerName)

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

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.

Returns:

the information for the output stream from container attach on successful completion of Mono.

attachWithResponse

public abstract Response attachWithResponse(String resourceGroupName, String containerGroupName, String containerName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
context - The context to associate with this operation.

Returns:

the information for the output stream from container attach along with Response<T>.

attachWithResponseAsync

public abstract Mono> attachWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName)

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

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.

Returns:

the information for the output stream from container attach along with Response<T> on successful completion of Mono.

executeCommand

public abstract ContainerExecResponseInner executeCommand(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)

Executes a command in a specific container instance. Executes a command for a specific container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
containerExecRequest - The request for the exec command.

Returns:

the information for the container exec command.

executeCommandAsync

public abstract Mono executeCommandAsync(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)

Executes a command in a specific container instance. Executes a command for a specific container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
containerExecRequest - The request for the exec command.

Returns:

the information for the container exec command on successful completion of Mono.

executeCommandWithResponse

public abstract Response executeCommandWithResponse(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest, Context context)

Executes a command in a specific container instance. Executes a command for a specific container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
containerExecRequest - The request for the exec command.
context - The context to associate with this operation.

Returns:

the information for the container exec command along with Response<T>.

executeCommandWithResponseAsync

public abstract Mono> executeCommandWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)

Executes a command in a specific container instance. Executes a command for a specific container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
containerExecRequest - The request for the exec command.

Returns:

the information for the container exec command along with Response<T> on successful completion of Mono.

listLogs

public abstract LogsInner listLogs(String resourceGroupName, String containerGroupName, String containerName)

Get the logs for a specified container instance. Get the logs for a specified container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.

Returns:

the logs for a specified container instance in a specified resource group and container group.

listLogsAsync

public abstract Mono listLogsAsync(String resourceGroupName, String containerGroupName, String containerName)

Get the logs for a specified container instance. Get the logs for a specified container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.

Returns:

the logs for a specified container instance in a specified resource group and container group on successful completion of Mono.

listLogsWithResponse

public abstract Response listLogsWithResponse(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps, Context context)

Get the logs for a specified container instance. Get the logs for a specified container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
tail - The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.
timestamps - If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.
context - The context to associate with this operation.

Returns:

the logs for a specified container instance in a specified resource group and container group along with Response<T>.

listLogsWithResponseAsync

public abstract Mono> listLogsWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps)

Get the logs for a specified container instance. Get the logs for a specified container instance in a specified resource group and container group.

Parameters:

resourceGroupName - The name of the resource group.
containerGroupName - The name of the container group.
containerName - The name of the container instance.
tail - The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.
timestamps - If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.

Returns:

the logs for a specified container instance in a specified resource group and container group along with Response<T> on successful completion of Mono.

Applies to