Class ContainerGroupProperties


  • public final class ContainerGroupProperties
    extends Object
    The container group properties.
    • Constructor Detail

      • ContainerGroupProperties

        public ContainerGroupProperties()
    • Method Detail

      • provisioningState

        public String provisioningState()
        Get the provisioningState property: The provisioning state of the container group. This only appears in the response.
        Returns:
        the provisioningState value.
      • containers

        public List<Container> containers()
        Get the containers property: The containers within the container group.
        Returns:
        the containers value.
      • withContainers

        public ContainerGroupProperties withContainers​(List<Container> containers)
        Set the containers property: The containers within the container group.
        Parameters:
        containers - the containers value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • imageRegistryCredentials

        public List<ImageRegistryCredential> imageRegistryCredentials()
        Get the imageRegistryCredentials property: The image registry credentials by which the container group is created from.
        Returns:
        the imageRegistryCredentials value.
      • withImageRegistryCredentials

        public ContainerGroupProperties withImageRegistryCredentials​(List<ImageRegistryCredential> imageRegistryCredentials)
        Set the imageRegistryCredentials property: The image registry credentials by which the container group is created from.
        Parameters:
        imageRegistryCredentials - the imageRegistryCredentials value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • restartPolicy

        public ContainerGroupRestartPolicy restartPolicy()
        Get the restartPolicy property: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart.
        Returns:
        the restartPolicy value.
      • withRestartPolicy

        public ContainerGroupProperties withRestartPolicy​(ContainerGroupRestartPolicy restartPolicy)
        Set the restartPolicy property: Restart policy for all containers within the container group. - `Always` Always restart - `OnFailure` Restart on failure - `Never` Never restart.
        Parameters:
        restartPolicy - the restartPolicy value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • ipAddress

        public IpAddress ipAddress()
        Get the ipAddress property: The IP address type of the container group.
        Returns:
        the ipAddress value.
      • withIpAddress

        public ContainerGroupProperties withIpAddress​(IpAddress ipAddress)
        Set the ipAddress property: The IP address type of the container group.
        Parameters:
        ipAddress - the ipAddress value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • osType

        public OperatingSystemTypes osType()
        Get the osType property: The operating system type required by the containers in the container group.
        Returns:
        the osType value.
      • withOsType

        public ContainerGroupProperties withOsType​(OperatingSystemTypes osType)
        Set the osType property: The operating system type required by the containers in the container group.
        Parameters:
        osType - the osType value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • volumes

        public List<Volume> volumes()
        Get the volumes property: The list of volumes that can be mounted by containers in this container group.
        Returns:
        the volumes value.
      • withVolumes

        public ContainerGroupProperties withVolumes​(List<Volume> volumes)
        Set the volumes property: The list of volumes that can be mounted by containers in this container group.
        Parameters:
        volumes - the volumes value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • instanceView

        public ContainerGroupPropertiesInstanceView instanceView()
        Get the instanceView property: The instance view of the container group. Only valid in response.
        Returns:
        the instanceView value.
      • diagnostics

        public ContainerGroupDiagnostics diagnostics()
        Get the diagnostics property: The diagnostic information for a container group.
        Returns:
        the diagnostics value.
      • withDiagnostics

        public ContainerGroupProperties withDiagnostics​(ContainerGroupDiagnostics diagnostics)
        Set the diagnostics property: The diagnostic information for a container group.
        Parameters:
        diagnostics - the diagnostics value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • subnetIds

        public List<ContainerGroupSubnetId> subnetIds()
        Get the subnetIds property: The subnet resource IDs for a container group.
        Returns:
        the subnetIds value.
      • withSubnetIds

        public ContainerGroupProperties withSubnetIds​(List<ContainerGroupSubnetId> subnetIds)
        Set the subnetIds property: The subnet resource IDs for a container group.
        Parameters:
        subnetIds - the subnetIds value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • dnsConfig

        public DnsConfiguration dnsConfig()
        Get the dnsConfig property: The DNS config information for a container group.
        Returns:
        the dnsConfig value.
      • withDnsConfig

        public ContainerGroupProperties withDnsConfig​(DnsConfiguration dnsConfig)
        Set the dnsConfig property: The DNS config information for a container group.
        Parameters:
        dnsConfig - the dnsConfig value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • sku

        public ContainerGroupSku sku()
        Get the sku property: The SKU for a container group.
        Returns:
        the sku value.
      • withSku

        public ContainerGroupProperties withSku​(ContainerGroupSku sku)
        Set the sku property: The SKU for a container group.
        Parameters:
        sku - the sku value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • encryptionProperties

        public EncryptionProperties encryptionProperties()
        Get the encryptionProperties property: The encryption properties for a container group.
        Returns:
        the encryptionProperties value.
      • withEncryptionProperties

        public ContainerGroupProperties withEncryptionProperties​(EncryptionProperties encryptionProperties)
        Set the encryptionProperties property: The encryption properties for a container group.
        Parameters:
        encryptionProperties - the encryptionProperties value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • initContainers

        public List<InitContainerDefinition> initContainers()
        Get the initContainers property: The init containers for a container group.
        Returns:
        the initContainers value.
      • withInitContainers

        public ContainerGroupProperties withInitContainers​(List<InitContainerDefinition> initContainers)
        Set the initContainers property: The init containers for a container group.
        Parameters:
        initContainers - the initContainers value to set.
        Returns:
        the ContainerGroupProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.