Package com.azure.resourcemanager.containerinstance.fluent

Interface ContainersClient

public interface ContainersClient

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

Method Summary

Modifier and Type	Method	Description
ContainerAttachResponseInner	attach(String resourceGroupName, String containerGroupName, String containerName)	Attach to the output stream of a specific container instance in a specified resource group and container group.
Mono<ContainerAttachResponseInner>	attachAsync(String resourceGroupName, String containerGroupName, String containerName)	Attach to the output stream of a specific container instance in a specified resource group and container group.
com.azure.core.http.rest.Response<ContainerAttachResponseInner>	attachWithResponse(String resourceGroupName, String containerGroupName, String containerName, com.azure.core.util.Context context)	Attach to the output stream of a specific container instance in a specified resource group and container group.
Mono<com.azure.core.http.rest.Response<ContainerAttachResponseInner>>	attachWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName)	Attach to the output stream of a specific container instance in a specified resource group and container group.
ContainerExecResponseInner	executeCommand(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)	Executes a command for a specific container instance in a specified resource group and container group.
Mono<ContainerExecResponseInner>	executeCommandAsync(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)	Executes a command for a specific container instance in a specified resource group and container group.
com.azure.core.http.rest.Response<ContainerExecResponseInner>	executeCommandWithResponse(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest, com.azure.core.util.Context context)	Executes a command for a specific container instance in a specified resource group and container group.
Mono<com.azure.core.http.rest.Response<ContainerExecResponseInner>>	executeCommandWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName, ContainerExecRequest containerExecRequest)	Executes a command for a specific container instance in a specified resource group and container group.
LogsInner	listLogs(String resourceGroupName, String containerGroupName, String containerName)	Get the logs for a specified container instance in a specified resource group and container group.
Mono<LogsInner>	listLogsAsync(String resourceGroupName, String containerGroupName, String containerName)	Get the logs for a specified container instance in a specified resource group and container group.
Mono<LogsInner>	listLogsAsync(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps)	Get the logs for a specified container instance in a specified resource group and container group.
com.azure.core.http.rest.Response<LogsInner>	listLogsWithResponse(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps, com.azure.core.util.Context context)	Get the logs for a specified container instance in a specified resource group and container group.
Mono<com.azure.core.http.rest.Response<LogsInner>>	listLogsWithResponseAsync(String resourceGroupName, String containerGroupName, String containerName, Integer tail, Boolean timestamps)	Get the logs for a specified container instance in a specified resource group and container group.

Method Detail

listLogsWithResponseAsync

Mono<com.azure.core.http.rest.Response<LogsInner>> listLogsWithResponseAsync(String resourceGroupName,
                                                                             String containerGroupName,
                                                                             String containerName,
                                                                             Integer tail,
                                                                             Boolean timestamps)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listLogsAsync

Mono<LogsInner> listLogsAsync(String resourceGroupName,
                              String containerGroupName,
                              String containerName,
                              Integer tail,
                              Boolean timestamps)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listLogsAsync

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listLogs

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listLogsWithResponse

com.azure.core.http.rest.Response<LogsInner> listLogsWithResponse(String resourceGroupName,
                                                                  String containerGroupName,
                                                                  String containerName,
                                                                  Integer tail,
                                                                  Boolean timestamps,
                                                                  com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

executeCommandWithResponseAsync

Mono<com.azure.core.http.rest.Response<ContainerExecResponseInner>> executeCommandWithResponseAsync(String resourceGroupName,
                                                                                                    String containerGroupName,
                                                                                                    String containerName,
                                                                                                    ContainerExecRequest containerExecRequest)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

executeCommandAsync

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

executeCommand

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

executeCommandWithResponse

com.azure.core.http.rest.Response<ContainerExecResponseInner> executeCommandWithResponse(String resourceGroupName,
                                                                                         String containerGroupName,
                                                                                         String containerName,
                                                                                         ContainerExecRequest containerExecRequest,
                                                                                         com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

attachWithResponseAsync

Mono<com.azure.core.http.rest.Response<ContainerAttachResponseInner>> attachWithResponseAsync(String resourceGroupName,
                                                                                              String containerGroupName,
                                                                                              String containerName)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

attachAsync

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

attach

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

attachWithResponse

com.azure.core.http.rest.Response<ContainerAttachResponseInner> attachWithResponse(String resourceGroupName,
                                                                                   String containerGroupName,
                                                                                   String containerName,
                                                                                   com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.