ContainerGroup (Microsoft Azure Management Libraries for Java 1.21.0)

All Superinterfaces:

com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.containerinstance.implementation.ContainerInstanceManager,com.microsoft.azure.management.containerinstance.implementation.ContainerGroupInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasId, com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.containerinstance.implementation.ContainerGroupInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<com.microsoft.azure.management.containerinstance.implementation.ContainerInstanceManager>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasName, com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup, com.microsoft.azure.management.resources.fluentcore.model.Indexable, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<ContainerGroup>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource, com.microsoft.azure.management.resources.fluentcore.model.Updatable<ContainerGroup.Update>
```
@Beta(value=V1_3_0)
public interface ContainerGroup
extends com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.containerinstance.implementation.ContainerInstanceManager,com.microsoft.azure.management.containerinstance.implementation.ContainerGroupInner>, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<ContainerGroup>, com.microsoft.azure.management.resources.fluentcore.model.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.microsoft.azure.management.resources.fluentcore.arm.models.Resource
com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map<String,Container>`	`containers()`
`String`	`dnsPrefix()`
`Set<Event>`	`events()`
`ContainerExecResponse`	`executeCommand(String containerName, String command, int row, int column)` Starts the exec command for a specific container instance.
`rx.Observable<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.
`rx.Observable<String>`	`getLogContentAsync(String containerName)` Get the log content for the specified container instance within the container group.
`rx.Observable<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`	`isIPAddressPublic()`
`OperatingSystemTypes`	`osType()`
`String`	`provisioningState()`
`void`	`restart()` Restarts all containers in a container group in place.
`rx.Completable`	`restartAsync()` Restarts all containers in a container group in place asynchronously.
`ContainerGroupRestartPolicy`	`restartPolicy()`
`String`	`state()`
`void`	`stop()` Stops all containers in a container group.
`rx.Completable`	`stopAsync()` Stops all containers in a container group asynchronously.
`Map<String,Volume>`	`volumes()`

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable
key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId
id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName
name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager
manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner
inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable
refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable
update

- Method Detail
  - containers
```
Map<String,Container> containers()
```
    Returns:
    
    the container instances in this container group
  - externalPorts
```
@Beta(value=V1_5_0)
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
```
@Beta(value=V1_5_0)
ContainerGroupRestartPolicy restartPolicy()
```
    Returns:
    
    the container group restart policy
  - dnsPrefix
```
@Beta(value=V1_7_0)
String dnsPrefix()
```
    Returns:
    
    the DNS prefix which was specified at creation time
  - fqdn
```
@Beta(value=V1_7_0)
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
  - 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
```
@Beta(value=V1_5_0)
Set<Event> events()
```
    Returns:
    
    the container group events
  - restart
```
@Beta(value=V1_15_0)
void restart()
```
    Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
  - restartAsync
```
@Beta(value=V1_15_0)
rx.Completable 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
```
@Beta(value=V1_15_0)
void stop()
```
    Stops all containers in a container group. Compute resources will be de-allocated and billing will stop.
  - stopAsync
```
@Beta(value=V1_15_0)
rx.Completable 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
```
rx.Observable<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
```
rx.Observable<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
```
@Beta(value=V1_11_0)
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
```
@Beta(value=V1_11_0)
rx.Observable<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

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Interface ContainerGroup

Nested Class Summary

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

Method Summary

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

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

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

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

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

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

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

Method Detail

containers

externalPorts

externalTcpPorts

externalUdpPorts

volumes

imageRegistryServers

restartPolicy

dnsPrefix

fqdn

ipAddress

isIPAddressPublic

osType

state

provisioningState

events

restart

restartAsync

stop

stopAsync

getLogContent

getLogContent

getLogContentAsync

getLogContentAsync

executeCommand

executeCommandAsync