class Azure::ContainerInstance::Mgmt::V2018_10_01::Models::ContainerGroup

A container group.

Attributes

containers[RW]

@return [Array<Container>] The containers within the container group.

diagnostics[RW]

@return [ContainerGroupDiagnostics] The diagnostic information for a container group.

dns_config[RW]

@return [DnsConfiguration] The DNS config information for a container group.

identity[RW]

@return [ContainerGroupIdentity] The identity of the container group, if configured.

image_registry_credentials[RW]

@return [Array<ImageRegistryCredential>] The image registry credentials by which the container group is created from.

instance_view[RW]

@return [ContainerGroupPropertiesInstanceView] The instance view of the container group. Only valid in response.

ip_address[RW]

@return [IpAddress] The IP address type of the container group.

network_profile[RW]

@return [ContainerGroupNetworkProfile] The network profile information for a container group.

os_type[RW]

@return [OperatingSystemTypes] The operating system type required by the containers in the container group. Possible values include: 'Windows', 'Linux'

provisioning_state[RW]

@return [String] The provisioning state of the container group. This only appears in the response.

restart_policy[RW]

@return [ContainerGroupRestartPolicy] Restart policy for all containers within the container group.

  • `Always` Always restart

  • `OnFailure` Restart on failure

  • `Never` Never restart

. Possible values include: 'Always', 'OnFailure', 'Never'

volumes[RW]

@return [Array<Volume>] The list of volumes that can be mounted by containers in this container group.

Public Class Methods

mapper() click to toggle source

Mapper for ContainerGroup class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb, line 71
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ContainerGroup',
    type: {
      name: 'Composite',
      class_name: 'ContainerGroup',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupIdentity'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        containers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.containers',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ContainerElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Container'
                }
            }
          }
        },
        image_registry_credentials: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.imageRegistryCredentials',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ImageRegistryCredentialElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ImageRegistryCredential'
                }
            }
          }
        },
        restart_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.restartPolicy',
          type: {
            name: 'String'
          }
        },
        ip_address: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipAddress',
          type: {
            name: 'Composite',
            class_name: 'IpAddress'
          }
        },
        os_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osType',
          type: {
            name: 'String'
          }
        },
        volumes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.volumes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VolumeElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Volume'
                }
            }
          }
        },
        instance_view: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.instanceView',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupPropertiesInstanceView'
          }
        },
        diagnostics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnostics',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupDiagnostics'
          }
        },
        network_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkProfile',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupNetworkProfile'
          }
        },
        dns_config: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsConfig',
          type: {
            name: 'Composite',
            class_name: 'DnsConfiguration'
          }
        }
      }
    }
  }
end