com.azure.resourcemanager.containerinstance.models

Interface ContainerGroup

All Superinterfaces:

GroupableResource<ContainerInstanceManager,ContainerGroupInner>, HasId, HasInnerModel<InnerT>, HasManager<TManager>, HasName, HasResourceGroup, Indexable, Refreshable<ContainerGroup>, Resource, Updatable<ContainerGroup.Update>

public interface ContainerGroup
extends GroupableResource<ContainerInstanceManager,ContainerGroupInner>, Refreshable<ContainerGroup>, Updatable<ContainerGroup.Update>

An immutable client-side representation of an Azure Container Group.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ContainerGroup.Definition Starts the exec command for a specific container instance within the current group asynchronously.
static interface	ContainerGroup.DefinitionStages Grouping of the container group definition stages.
static interface	ContainerGroup.Update The template for an update operation, containing all the settings that can be modified.

Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Field Summary

Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

DUMMY

Method Summary

Modifier and Type	Method and Description
ContainerAttachResult	attachOutputStream(Container container) Attaches to the output stream of a specific container instance in a specified container group.
ContainerAttachResult	attachOutputStream(String containerName) Attaches to the output stream of a specific container instance in a specified container group.
Mono<ContainerAttachResult>	attachOutputStreamAsync(Container container) Attaches to the output stream of a specific container instance in a specified container group.
Mono<ContainerAttachResult>	attachOutputStreamAsync(String containerName) Attaches to the output stream of a specific container instance in a specified container group.
Map<String,Container>	containers()
DnsConfiguration	dnsConfig()
String	dnsPrefix()
Set<Event>	events()
ContainerExecResponse	executeCommand(String containerName, String command, int row, int column) Starts the exec command for a specific container instance.
Mono<ContainerExecResponse>	executeCommandAsync(String containerName, String command, int row, int column) Starts the exec command for a specific container instance within the container group.
Set<Port>	externalPorts()
int[]	externalTcpPorts()
int[]	externalUdpPorts()
String	fqdn()
String	getLogContent(String containerName) Get the log content for the specified container instance within the container group.
String	getLogContent(String containerName, int tailLineCount) Get the log content for the specified container instance within the container group.
Mono<String>	getLogContentAsync(String containerName) Get the log content for the specified container instance within the container group.
Mono<String>	getLogContentAsync(String containerName, int tailLineCount) Get the log content for the specified container instance within the container group.
Collection<String>	imageRegistryServers()
String	ipAddress()
boolean	isIPAddressPrivate()
boolean	isIPAddressPublic()
boolean	isManagedServiceIdentityEnabled()
LogAnalytics	logAnalytics()
ResourceIdentityType	managedServiceIdentityType()
String	networkProfileId()
OperatingSystemTypes	osType()
String	provisioningState()
void	restart() Restarts all containers in a container group in place.
Mono<Void>	restartAsync() Restarts all containers in a container group in place asynchronously.
ContainerGroupRestartPolicy	restartPolicy()
String	state()
void	stop() Stops all containers in a container group.
Mono<Void>	stopAsync() Stops all containers in a container group asynchronously.
String	systemAssignedManagedServiceIdentityPrincipalId()
String	systemAssignedManagedServiceIdentityTenantId()
Set<String>	userAssignedManagedServiceIdentityIds()
Map<String,Volume>	volumes()

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Method Detail

containers

Map<String,Container> containers()

Returns:

the container instances in this container group

externalPorts

Set<Port> externalPorts()

Returns:

all the ports publicly exposed for this container group

externalTcpPorts

int[] externalTcpPorts()

Returns:

the TCP ports publicly exposed for this container group

externalUdpPorts

int[] externalUdpPorts()

Returns:

the UDP ports publicly exposed for this container group

volumes

Map<String,Volume> volumes()

Returns:

the volumes for this container group

imageRegistryServers

Collection<String> imageRegistryServers()

Returns:

the Docker image registry servers by which the container group is created from

restartPolicy

ContainerGroupRestartPolicy restartPolicy()

Returns:

the container group restart policy

dnsPrefix

String dnsPrefix()

Returns:

the DNS prefix which was specified at creation time

fqdn

String fqdn()

Returns:

the FQDN for the container group

ipAddress

String ipAddress()

Returns:

the IP address

isIPAddressPublic

boolean isIPAddressPublic()

Returns:

true if IP address is public

isIPAddressPrivate

boolean isIPAddressPrivate()

Returns:

true if IP address is private

osType

OperatingSystemTypes osType()

Returns:

the base level OS type required by the containers in the group

state

String state()

Returns:

the state of the container group; only valid in response

provisioningState

String provisioningState()

Returns:

the provisioningState of the container group

events

Set<Event> events()

Returns:

the container group events

dnsConfig

DnsConfiguration dnsConfig()

Returns:

the DNS configuration for the container group

networkProfileId

String networkProfileId()

Returns:

the id of the network profile for the container group

isManagedServiceIdentityEnabled

boolean isManagedServiceIdentityEnabled()

Returns:

whether managed service identity is enabled for the container group

systemAssignedManagedServiceIdentityTenantId

String systemAssignedManagedServiceIdentityTenantId()

Returns:

the tenant id of the system assigned managed service identity. Null if managed service identity is not configured.

systemAssignedManagedServiceIdentityPrincipalId

String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

the principal id of the system assigned managed service identity. Null if managed service identity is not configured.

managedServiceIdentityType

ResourceIdentityType managedServiceIdentityType()

Returns:

whether managed service identity is system assigned, user assigned, both, or neither

userAssignedManagedServiceIdentityIds

Set<String> userAssignedManagedServiceIdentityIds()

Returns:

the ids of the user assigned managed service identities. Returns an empty set if no MSIs are set.

logAnalytics

LogAnalytics logAnalytics()

Returns:

the log analytics information of the container group.

restart

void restart()

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

restartAsync

Mono<Void> restartAsync()

Restarts all containers in a container group in place asynchronously. If container image has updates, new image will be downloaded.

Returns:

a representation of the deferred computation of this call

stop

void stop()

Stops all containers in a container group. Compute resources will be de-allocated and billing will stop.

stopAsync

Mono<Void> stopAsync()

Stops all containers in a container group asynchronously. Compute resources will be de-allocated and billing will stop.

Returns:

a representation of the deferred computation of this call

getLogContent

String getLogContent(String containerName)

Get the log content for the specified container instance within the container group.

Parameters:

containerName - the container instance name

Returns:

all available log lines

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getLogContent

String getLogContent(String containerName,
                     int tailLineCount)

Get the log content for the specified container instance within the container group.

Parameters:

containerName - the container instance name

tailLineCount - only get the last log lines up to this

Returns:

the log lines from the end, up to the number specified

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getLogContentAsync

Mono<String> getLogContentAsync(String containerName)

Get the log content for the specified container instance within the container group.

Parameters:

containerName - the container instance name

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getLogContentAsync

Mono<String> getLogContentAsync(String containerName,
                                int tailLineCount)

Get the log content for the specified container instance within the container group.

Parameters:

containerName - the container instance name

tailLineCount - only get the last log lines up to this

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

executeCommand

ContainerExecResponse executeCommand(String containerName,
                                     String command,
                                     int row,
                                     int column)

Starts the exec command for a specific container instance.

Parameters:

containerName - the container instance name

command - the command to be executed

row - the row size of the terminal

column - the column size of the terminal

Returns:

the log lines from the end, up to the number specified

Throws:

IllegalArgumentException - thrown if parameters fail the validation

executeCommandAsync

Mono<ContainerExecResponse> executeCommandAsync(String containerName,
                                                String command,
                                                int row,
                                                int column)

Starts the exec command for a specific container instance within the container group.

Parameters:

containerName - the container instance name

command - the command to be executed

row - the row size of the terminal

column - the column size of the terminal

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

attachOutputStream

ContainerAttachResult attachOutputStream(String containerName)

Attaches to the output stream of a specific container instance in a specified container group.

Parameters:

containerName - the name of the container instance

Returns:

the information for the output stream

attachOutputStreamAsync

Mono<ContainerAttachResult> attachOutputStreamAsync(String containerName)

Attaches to the output stream of a specific container instance in a specified container group.

Parameters:

containerName - the name of the container instance

Returns:

the information for the output stream

attachOutputStream

ContainerAttachResult attachOutputStream(Container container)

Attaches to the output stream of a specific container instance in a specified container group.

Parameters:

container - the container instance

Returns:

the information for the output stream

attachOutputStreamAsync

Mono<ContainerAttachResult> attachOutputStreamAsync(Container container)

Attaches to the output stream of a specific container instance in a specified container group.

Parameters:

container - the container instance

Returns:

the information for the output stream