Package com.azure.resourcemanager.containerinstance.models

Interface ContainerGroup

All Superinterfaces:
GroupableResource<ContainerInstanceManager,ContainerGroupInner>, HasId, HasInnerModel<ContainerGroupInner>, HasManager<ContainerInstanceManager>, 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.

  • Method Details

    • containers

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

    • externalPorts

      Set<Port> externalPorts()
      Gets all the ports publicly exposed for this container group.
      Returns:
      all the ports publicly exposed for this container group

    • externalTcpPorts

      int[] externalTcpPorts()
      Gets the TCP ports publicly exposed for this container group.
      Returns:
      the TCP ports publicly exposed for this container group

    • externalUdpPorts

      int[] externalUdpPorts()
      Gets the UDP ports publicly exposed for this container group.
      Returns:
      the UDP ports publicly exposed for this container group

    • volumes

      Map<String,Volume> volumes()
      Gets the volumes for this container group.
      Returns:
      the volumes for this container group

    • imageRegistryServers

      Collection<String> imageRegistryServers()
      Gets the Docker image registry servers by which the container group is created from.
      Returns:
      the Docker image registry servers by which the container group is created from

    • restartPolicy

      ContainerGroupRestartPolicy restartPolicy()
      Gets the container group restart policy.
      Returns:
      the container group restart policy

    • dnsPrefix

      String dnsPrefix()
      Gets the DNS prefix which was specified at creation time.
      Returns:
      the DNS prefix which was specified at creation time

    • fqdn

      String fqdn()
      Gets the FQDN for the container group.
      Returns:
      the FQDN for the container group

    • ipAddress

      String ipAddress()
      Gets the IP address.
      Returns:
      the IP address

    • isIPAddressPublic

      boolean isIPAddressPublic()
      Checks whether IP address is public.
      Returns:
      true if IP address is public

    • isIPAddressPrivate

      boolean isIPAddressPrivate()
      Checks whether IP address is private.
      Returns:
      true if IP address is private

    • osType

      OperatingSystemTypes osType()
      Gets the base level OS type required by the containers in the group.
      Returns:
      the base level OS type required by the containers in the group

    • state

      String state()
      Gets the state of the container group; only valid in response.
      Returns:
      the state of the container group; only valid in response

    • provisioningState

      String provisioningState()
      Gets the provisioningState of the container group.
      Returns:
      the provisioningState of the container group

    • events

      Set<Event> events()
      Gets the container group events.
      Returns:
      the container group events

    • dnsConfig

      DnsConfiguration dnsConfig()
      Gets the DNS configuration for the container group.
      Returns:
      the DNS configuration for the container group

    • autoGeneratedDomainNameLabelScope

      DnsNameLabelReusePolicy autoGeneratedDomainNameLabelScope()
      Gets the reuse policy of DNS name label for the container group.
      Returns:
      the reuse policy

    • subnetIds

      List<ContainerGroupSubnetId> subnetIds()
      Gets the id of the subnets..
      Returns:
      the id of the subnets.

    • isManagedServiceIdentityEnabled

      boolean isManagedServiceIdentityEnabled()
      Checks whether managed service identity is enabled for the container group.
      Returns:
      whether managed service identity is enabled for the container group

    • systemAssignedManagedServiceIdentityTenantId

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

    • systemAssignedManagedServiceIdentityPrincipalId

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

    • managedServiceIdentityType

      ResourceIdentityType managedServiceIdentityType()
      Checks whether managed service identity is system assigned, user assigned, both, or neither.
      Returns:
      whether managed service identity is system assigned, user assigned, both, or neither

    • userAssignedManagedServiceIdentityIds

      Set<String> userAssignedManagedServiceIdentityIds()
      Gets the ids of the user assigned managed service identities.
      Returns:
      the ids of the user assigned managed service identities. Returns an empty set if no MSIs are set.

    • logAnalytics

      LogAnalytics logAnalytics()
      Gets the log analytics information of the container group.
      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