Package com.microsoft.azure.management.containerinstance

Interface ContainerGroup

All Superinterfaces:
GroupableResource<com.microsoft.azure.management.containerinstance.implementation.ContainerInstanceManager,com.microsoft.azure.management.containerinstance.implementation.ContainerGroupInner>, HasId, HasInner<com.microsoft.azure.management.containerinstance.implementation.ContainerGroupInner>, HasManager<com.microsoft.azure.management.containerinstance.implementation.ContainerInstanceManager>, HasName, HasResourceGroup, Indexable, Refreshable<ContainerGroup>, Resource, Updatable<ContainerGroup.Update>
@Beta(V1_23_0) public interface ContainerGroup extends GroupableResource<com.microsoft.azure.management.containerinstance.implementation.ContainerInstanceManager,com.microsoft.azure.management.containerinstance.implementation.ContainerGroupInner>, Refreshable<ContainerGroup>, Updatable<ContainerGroup.Update>
An immutable client-side representation of an Azure Container Group.

  • Method Details

    • containers

      Map<String,Container> containers()
      Returns:
      the container instances in this container group

    • externalPorts

      @Beta(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(V1_5_0) ContainerGroupRestartPolicy restartPolicy()
      Returns:
      the container group restart policy

    • dnsPrefix

      @Beta(V1_7_0) String dnsPrefix()
      Returns:
      the DNS prefix which was specified at creation time

    • fqdn

      @Beta(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

    • 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

      @Beta(V1_5_0) Set<Event> events()
      Returns:
      the container group events

    • dnsConfig

      @Beta(V1_23_0) DnsConfiguration dnsConfig()
      Returns:
      the DNS configuration for the container group

    • networkProfileId

      @Beta(V1_23_0) String networkProfileId()
      Returns:
      the id of the network profile for the container group

    • isManagedServiceIdentityEnabled

      @Beta(V1_23_0) boolean isManagedServiceIdentityEnabled()
      Returns:
      whether managed service identity is enabled for the container group

    • systemAssignedManagedServiceIdentityTenantId

      @Beta(V1_23_0) String systemAssignedManagedServiceIdentityTenantId()
      Returns:
      the tenant id of the system assigned managed service identity. Null if managed service identity is not configured.

    • systemAssignedManagedServiceIdentityPrincipalId

      @Beta(V1_23_0) String systemAssignedManagedServiceIdentityPrincipalId()
      Returns:
      the principal id of the system assigned managed service identity. Null if managed service identity is not configured.

    • managedServiceIdentityType

      @Beta(V1_23_0) ResourceIdentityType managedServiceIdentityType()
      Returns:
      whether managed service identity is system assigned, user assigned, both, or neither

    • userAssignedManagedServiceIdentityIds

      @Beta(V1_23_0) 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

      @Beta(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(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(V1_15_0) void stop()
      Stops all containers in a container group. Compute resources will be de-allocated and billing will stop.

    • stopAsync

      @Beta(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(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(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