azure.mgmt.containerinstance.models module

class azure.mgmt.containerinstance.models.AzureFileVolume(*, share_name: str, storage_account_name: str, read_only: Optional[bool] = None, storage_account_key: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The properties of the Azure File volume. Azure File shares are mounted as volumes.

All required parameters must be populated in order to send to Azure.

Variables

  • share_name (str) – The name of the Azure File share to be mounted as a volume. Required.

  • read_only (bool) – The flag indicating whether the Azure File shared mounted as a volume is read-only.

  • storage_account_name (str) – The name of the storage account that contains the Azure File share. Required.

  • storage_account_key (str) – The storage account access key used to access the Azure File share.

Keyword Arguments

  • share_name (str) – The name of the Azure File share to be mounted as a volume. Required.

  • read_only (bool) – The flag indicating whether the Azure File shared mounted as a volume is read-only.

  • storage_account_name (str) – The name of the storage account that contains the Azure File share. Required.

  • storage_account_key (str) – The storage account access key used to access the Azure File share.

class azure.mgmt.containerinstance.models.CachedImages(*, os_type: str, image: str, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The cached image and OS type.

All required parameters must be populated in order to send to Azure.

Variables

  • os_type (str) – The OS type of the cached image. Required.

  • image (str) – The cached image name. Required.

Keyword Arguments

  • os_type (str) – The OS type of the cached image. Required.

  • image (str) – The cached image name. Required.

class azure.mgmt.containerinstance.models.CachedImagesListResult(*, value: Optional[List[_models.CachedImages]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The response containing cached images.

Variables

  • value (list[CachedImages]) – The list of cached images.

  • next_link (str) – The URI to fetch the next page of cached images.

Keyword Arguments

  • value (list[CachedImages]) – The list of cached images.

  • next_link (str) – The URI to fetch the next page of cached images.

class azure.mgmt.containerinstance.models.Capabilities(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The regional capabilities.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • resource_type (str) – The resource type that this capability describes.

  • os_type (str) – The OS type that this capability describes.

  • location (str) – The resource location.

  • ip_address_type (str) – The ip address type that this capability describes.

  • gpu (str) – The GPU sku that this capability describes.

  • capabilities (CapabilitiesCapabilities) – The supported capabilities.

class azure.mgmt.containerinstance.models.CapabilitiesCapabilities(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The supported capabilities.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • max_memory_in_gb (float) – The maximum allowed memory request in GB.

  • max_cpu (float) – The maximum allowed CPU request in cores.

  • max_gpu_count (float) – The maximum allowed GPU count.

class azure.mgmt.containerinstance.models.CapabilitiesListResult(*, value: Optional[List[_models.Capabilities]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The response containing list of capabilities.

Variables

  • value (list[Capabilities]) – The list of capabilities.

  • next_link (str) – The URI to fetch the next page of capabilities.

Keyword Arguments

  • value (list[Capabilities]) – The list of capabilities.

  • next_link (str) – The URI to fetch the next page of capabilities.

class azure.mgmt.containerinstance.models.CloudErrorBody(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[_models.CloudErrorBody]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

An error response from the Container Instance service.

Variables

  • code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

  • target (str) – The target of the particular error. For example, the name of the property in error.

  • details (list[CloudErrorBody]) – A list of additional details about the error.

Keyword Arguments

  • code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

  • target (str) – The target of the particular error. For example, the name of the property in error.

  • details (list[CloudErrorBody]) – A list of additional details about the error.

class azure.mgmt.containerinstance.models.ConfidentialComputeProperties(*, cce_policy: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The properties for confidential container group.

Variables

cce_policy (str) – The base64 encoded confidential compute enforcement policy.

Keyword Arguments

cce_policy (str) – The base64 encoded confidential compute enforcement policy.

class azure.mgmt.containerinstance.models.Container(*, name: str, image: str, resources: _models.ResourceRequirements, command: Optional[List[str]] = None, ports: Optional[List[_models.ContainerPort]] = None, environment_variables: Optional[List[_models.EnvironmentVariable]] = None, volume_mounts: Optional[List[_models.VolumeMount]] = None, liveness_probe: Optional[_models.ContainerProbe] = None, readiness_probe: Optional[_models.ContainerProbe] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

A container instance.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The user-provided name of the container instance. Required.

  • image (str) – The name of the image used to create the container instance. Required.

  • command (list[str]) – The commands to execute within the container instance in exec form.

  • ports (list[ContainerPort]) – The exposed ports on the container instance.

  • environment_variables (list[EnvironmentVariable]) – The environment variables to set in the container instance.

  • instance_view (ContainerPropertiesInstanceView) – The instance view of the container instance. Only valid in response.

  • resources (ResourceRequirements) – The resource requirements of the container instance. Required.

  • volume_mounts (list[VolumeMount]) – The volume mounts available to the container instance.

  • liveness_probe (ContainerProbe) – The liveness probe.

  • readiness_probe (ContainerProbe) – The readiness probe.

Keyword Arguments

  • name (str) – The user-provided name of the container instance. Required.

  • image (str) – The name of the image used to create the container instance. Required.

  • command (list[str]) – The commands to execute within the container instance in exec form.

  • ports (list[ContainerPort]) – The exposed ports on the container instance.

  • environment_variables (list[EnvironmentVariable]) – The environment variables to set in the container instance.

  • resources (ResourceRequirements) – The resource requirements of the container instance. Required.

  • volume_mounts (list[VolumeMount]) – The volume mounts available to the container instance.

  • liveness_probe (ContainerProbe) – The liveness probe.

  • readiness_probe (ContainerProbe) – The readiness probe.

class azure.mgmt.containerinstance.models.ContainerAttachResponse(*, web_socket_uri: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The information for the output stream from container attach.

Variables

  • web_socket_uri (str) – The uri for the output stream from the attach.

  • password (str) – The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.

Keyword Arguments

  • web_socket_uri (str) – The uri for the output stream from the attach.

  • password (str) – The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.

class azure.mgmt.containerinstance.models.ContainerExec(*, command: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container execution command, for liveness or readiness probe.

Variables

command (list[str]) – The commands to execute within the container.

Keyword Arguments

command (list[str]) – The commands to execute within the container.

class azure.mgmt.containerinstance.models.ContainerExecRequest(*, command: Optional[str] = None, terminal_size: Optional[_models.ContainerExecRequestTerminalSize] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container exec request.

Variables
Keyword Arguments
class azure.mgmt.containerinstance.models.ContainerExecRequestTerminalSize(*, rows: Optional[int] = None, cols: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The size of the terminal.

Variables

  • rows (int) – The row size of the terminal.

  • cols (int) – The column size of the terminal.

Keyword Arguments

  • rows (int) – The row size of the terminal.

  • cols (int) – The column size of the terminal.

class azure.mgmt.containerinstance.models.ContainerExecResponse(*, web_socket_uri: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The information for the container exec command.

Variables

  • web_socket_uri (str) – The uri for the exec websocket.

  • password (str) – The password to start the exec command.

Keyword Arguments

  • web_socket_uri (str) – The uri for the exec websocket.

  • password (str) – The password to start the exec command.

class azure.mgmt.containerinstance.models.ContainerGroup(*, containers: List[_models.Container], os_type: Union[str, _models.OperatingSystemTypes], identity: Optional[_models.ContainerGroupIdentity] = None, image_registry_credentials: Optional[List[_models.ImageRegistryCredential]] = None, restart_policy: Optional[Union[str, _models.ContainerGroupRestartPolicy]] = None, ip_address: Optional[_models.IpAddress] = None, volumes: Optional[List[_models.Volume]] = None, diagnostics: Optional[_models.ContainerGroupDiagnostics] = None, subnet_ids: Optional[List[_models.ContainerGroupSubnetId]] = None, dns_config: Optional[_models.DnsConfiguration] = None, sku: Optional[Union[str, _models.ContainerGroupSku]] = None, encryption_properties: Optional[_models.EncryptionProperties] = None, init_containers: Optional[List[_models.InitContainerDefinition]] = None, extensions: Optional[List[_models.DeploymentExtensionSpec]] = None, confidential_compute_properties: Optional[_models.ConfidentialComputeProperties] = None, priority: Optional[Union[str, _models.ContainerGroupPriority]] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, zones: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance.models._models_py3.Resource, azure.mgmt.containerinstance.models._models_py3.ContainerGroupProperties

A container group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • identity (ContainerGroupIdentity) – The identity of the container group, if configured.

  • provisioning_state (str) – The provisioning state of the container group. This only appears in the response.

  • containers (list[Container]) – The containers within the container group. Required.

  • image_registry_credentials (list[ImageRegistryCredential]) – The image registry credentials by which the container group is created from.

  • restart_policy (str or ContainerGroupRestartPolicy) –

    Restart policy for all containers within the container group.

    • Always Always restart

    • OnFailure Restart on failure

    • Never Never restart. Known values are: “Always”, “OnFailure”, and “Never”.

  • ip_address (IpAddress) – The IP address type of the container group.

  • os_type (str or OperatingSystemTypes) – The operating system type required by the containers in the container group. Required. Known values are: “Windows” and “Linux”.

  • volumes (list[Volume]) – The list of volumes that can be mounted by containers in this container group.

  • instance_view (ContainerGroupPropertiesInstanceView) – The instance view of the container group. Only valid in response.

  • diagnostics (ContainerGroupDiagnostics) – The diagnostic information for a container group.

  • subnet_ids (list[ContainerGroupSubnetId]) – The subnet resource IDs for a container group.

  • dns_config (DnsConfiguration) – The DNS config information for a container group.

  • sku (str or ContainerGroupSku) – The SKU for a container group. Known values are: “Standard”, “Dedicated”, and “Confidential”.

  • encryption_properties (EncryptionProperties) – The encryption properties for a container group.

  • init_containers (list[InitContainerDefinition]) – The init containers for a container group.

  • extensions (list[DeploymentExtensionSpec]) – extensions used by virtual kubelet.

  • confidential_compute_properties (ConfidentialComputeProperties) – The properties for confidential container group.

  • priority (str or ContainerGroupPriority) – The priority of the container group. Known values are: “Regular” and “Spot”.

  • id (str) – The resource id.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • location (str) – The resource location.

  • tags (dict[str, str]) – The resource tags.

  • zones (list[str]) – The zones for the container group.

Keyword Arguments

  • identity (ContainerGroupIdentity) – The identity of the container group, if configured.

  • containers (list[Container]) – The containers within the container group. Required.

  • image_registry_credentials (list[ImageRegistryCredential]) – The image registry credentials by which the container group is created from.

  • restart_policy (str or ContainerGroupRestartPolicy) –

    Restart policy for all containers within the container group.

    • Always Always restart

    • OnFailure Restart on failure

    • Never Never restart. Known values are: “Always”, “OnFailure”, and “Never”.

  • ip_address (IpAddress) – The IP address type of the container group.

  • os_type (str or OperatingSystemTypes) – The operating system type required by the containers in the container group. Required. Known values are: “Windows” and “Linux”.

  • volumes (list[Volume]) – The list of volumes that can be mounted by containers in this container group.

  • diagnostics (ContainerGroupDiagnostics) – The diagnostic information for a container group.

  • subnet_ids (list[ContainerGroupSubnetId]) – The subnet resource IDs for a container group.

  • dns_config (DnsConfiguration) – The DNS config information for a container group.

  • sku (str or ContainerGroupSku) – The SKU for a container group. Known values are: “Standard”, “Dedicated”, and “Confidential”.

  • encryption_properties (EncryptionProperties) – The encryption properties for a container group.

  • init_containers (list[InitContainerDefinition]) – The init containers for a container group.

  • extensions (list[DeploymentExtensionSpec]) – extensions used by virtual kubelet.

  • confidential_compute_properties (ConfidentialComputeProperties) – The properties for confidential container group.

  • priority (str or ContainerGroupPriority) – The priority of the container group. Known values are: “Regular” and “Spot”.

  • location (str) – The resource location.

  • tags (dict[str, str]) – The resource tags.

  • zones (list[str]) – The zones for the container group.

class azure.mgmt.containerinstance.models.ContainerGroupDiagnostics(*, log_analytics: Optional[_models.LogAnalytics] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Container group diagnostic information.

Variables

log_analytics (LogAnalytics) – Container group log analytics information.

Keyword Arguments

log_analytics (LogAnalytics) – Container group log analytics information.

class azure.mgmt.containerinstance.models.ContainerGroupIdentity(*, type: Optional[Union[str, _models.ResourceIdentityType]] = None, user_assigned_identities: Optional[Dict[str, _models.UserAssignedIdentities]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Identity for the container group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • principal_id (str) – The principal id of the container group identity. This property will only be provided for a system assigned identity.

  • tenant_id (str) – The tenant id associated with the container group. This property will only be provided for a system assigned identity.

  • type (str or ResourceIdentityType) – The type of identity used for the container group. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the container group. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

  • user_assigned_identities (dict[str, UserAssignedIdentities]) – The list of user identities associated with the container group.

Keyword Arguments

  • type (str or ResourceIdentityType) – The type of identity used for the container group. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the container group. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

  • user_assigned_identities (dict[str, UserAssignedIdentities]) – The list of user identities associated with the container group.

class azure.mgmt.containerinstance.models.ContainerGroupIpAddressType(value)[source]

Bases: str, enum.Enum

Specifies if the IP is exposed to the public internet or private VNET.

PRIVATE = 'Private'
PUBLIC = 'Public'
class azure.mgmt.containerinstance.models.ContainerGroupListResult(*, value: Optional[List[_models.ContainerGroup]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container group list response that contains the container group properties.

Variables

  • value (list[ContainerGroup]) – The list of container groups.

  • next_link (str) – The URI to fetch the next page of container groups.

Keyword Arguments

  • value (list[ContainerGroup]) – The list of container groups.

  • next_link (str) – The URI to fetch the next page of container groups.

class azure.mgmt.containerinstance.models.ContainerGroupNetworkProtocol(value)[source]

Bases: str, enum.Enum

The protocol associated with the port.

TCP = 'TCP'
UDP = 'UDP'
class azure.mgmt.containerinstance.models.ContainerGroupPriority(value)[source]

Bases: str, enum.Enum

The priority of the container group.

REGULAR = 'Regular'
SPOT = 'Spot'
class azure.mgmt.containerinstance.models.ContainerGroupProperties(*, containers: List[_models.Container], os_type: Union[str, _models.OperatingSystemTypes], identity: Optional[_models.ContainerGroupIdentity] = None, image_registry_credentials: Optional[List[_models.ImageRegistryCredential]] = None, restart_policy: Optional[Union[str, _models.ContainerGroupRestartPolicy]] = None, ip_address: Optional[_models.IpAddress] = None, volumes: Optional[List[_models.Volume]] = None, diagnostics: Optional[_models.ContainerGroupDiagnostics] = None, subnet_ids: Optional[List[_models.ContainerGroupSubnetId]] = None, dns_config: Optional[_models.DnsConfiguration] = None, sku: Optional[Union[str, _models.ContainerGroupSku]] = None, encryption_properties: Optional[_models.EncryptionProperties] = None, init_containers: Optional[List[_models.InitContainerDefinition]] = None, extensions: Optional[List[_models.DeploymentExtensionSpec]] = None, confidential_compute_properties: Optional[_models.ConfidentialComputeProperties] = None, priority: Optional[Union[str, _models.ContainerGroupPriority]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container group properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • identity (ContainerGroupIdentity) – The identity of the container group, if configured.

  • provisioning_state (str) – The provisioning state of the container group. This only appears in the response.

  • containers (list[Container]) – The containers within the container group. Required.

  • image_registry_credentials (list[ImageRegistryCredential]) – The image registry credentials by which the container group is created from.

  • restart_policy (str or ContainerGroupRestartPolicy) –

    Restart policy for all containers within the container group.

    • Always Always restart

    • OnFailure Restart on failure

    • Never Never restart. Known values are: “Always”, “OnFailure”, and “Never”.

  • ip_address (IpAddress) – The IP address type of the container group.

  • os_type (str or OperatingSystemTypes) – The operating system type required by the containers in the container group. Required. Known values are: “Windows” and “Linux”.

  • volumes (list[Volume]) – The list of volumes that can be mounted by containers in this container group.

  • instance_view (ContainerGroupPropertiesInstanceView) – The instance view of the container group. Only valid in response.

  • diagnostics (ContainerGroupDiagnostics) – The diagnostic information for a container group.

  • subnet_ids (list[ContainerGroupSubnetId]) – The subnet resource IDs for a container group.

  • dns_config (DnsConfiguration) – The DNS config information for a container group.

  • sku (str or ContainerGroupSku) – The SKU for a container group. Known values are: “Standard”, “Dedicated”, and “Confidential”.

  • encryption_properties (EncryptionProperties) – The encryption properties for a container group.

  • init_containers (list[InitContainerDefinition]) – The init containers for a container group.

  • extensions (list[DeploymentExtensionSpec]) – extensions used by virtual kubelet.

  • confidential_compute_properties (ConfidentialComputeProperties) – The properties for confidential container group.

  • priority (str or ContainerGroupPriority) – The priority of the container group. Known values are: “Regular” and “Spot”.

Keyword Arguments

  • identity (ContainerGroupIdentity) – The identity of the container group, if configured.

  • containers (list[Container]) – The containers within the container group. Required.

  • image_registry_credentials (list[ImageRegistryCredential]) – The image registry credentials by which the container group is created from.

  • restart_policy (str or ContainerGroupRestartPolicy) –

    Restart policy for all containers within the container group.

    • Always Always restart

    • OnFailure Restart on failure

    • Never Never restart. Known values are: “Always”, “OnFailure”, and “Never”.

  • ip_address (IpAddress) – The IP address type of the container group.

  • os_type (str or OperatingSystemTypes) – The operating system type required by the containers in the container group. Required. Known values are: “Windows” and “Linux”.

  • volumes (list[Volume]) – The list of volumes that can be mounted by containers in this container group.

  • diagnostics (ContainerGroupDiagnostics) – The diagnostic information for a container group.

  • subnet_ids (list[ContainerGroupSubnetId]) – The subnet resource IDs for a container group.

  • dns_config (DnsConfiguration) – The DNS config information for a container group.

  • sku (str or ContainerGroupSku) – The SKU for a container group. Known values are: “Standard”, “Dedicated”, and “Confidential”.

  • encryption_properties (EncryptionProperties) – The encryption properties for a container group.

  • init_containers (list[InitContainerDefinition]) – The init containers for a container group.

  • extensions (list[DeploymentExtensionSpec]) – extensions used by virtual kubelet.

  • confidential_compute_properties (ConfidentialComputeProperties) – The properties for confidential container group.

  • priority (str or ContainerGroupPriority) – The priority of the container group. Known values are: “Regular” and “Spot”.

class azure.mgmt.containerinstance.models.ContainerGroupPropertiesInstanceView(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The instance view of the container group. Only valid in response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • events (list[Event]) – The events of this container group.

  • state (str) – The state of the container group. Only valid in response.

class azure.mgmt.containerinstance.models.ContainerGroupRestartPolicy(value)[source]

Bases: str, enum.Enum

Restart policy for all containers within the container group.

  • Always Always restart

  • OnFailure Restart on failure

  • Never Never restart.

ALWAYS = 'Always'
NEVER = 'Never'
ON_FAILURE = 'OnFailure'
class azure.mgmt.containerinstance.models.ContainerGroupSku(value)[source]

Bases: str, enum.Enum

The container group SKU.

CONFIDENTIAL = 'Confidential'
DEDICATED = 'Dedicated'
STANDARD = 'Standard'
class azure.mgmt.containerinstance.models.ContainerGroupSubnetId(*, id: str, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Container group subnet information.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Resource ID of virtual network and subnet. Required.

  • name (str) – Friendly name for the subnet.

Keyword Arguments

  • id (str) – Resource ID of virtual network and subnet. Required.

  • name (str) – Friendly name for the subnet.

class azure.mgmt.containerinstance.models.ContainerHttpGet(*, port: int, path: Optional[str] = None, scheme: Optional[Union[str, _models.Scheme]] = None, http_headers: Optional[List[_models.HttpHeader]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container Http Get settings, for liveness or readiness probe.

All required parameters must be populated in order to send to Azure.

Variables

  • path (str) – The path to probe.

  • port (int) – The port number to probe. Required.

  • scheme (str or Scheme) – The scheme. Known values are: “http” and “https”.

  • http_headers (list[HttpHeader]) – The HTTP headers.

Keyword Arguments

  • path (str) – The path to probe.

  • port (int) – The port number to probe. Required.

  • scheme (str or Scheme) – The scheme. Known values are: “http” and “https”.

  • http_headers (list[HttpHeader]) – The HTTP headers.

class azure.mgmt.containerinstance.models.ContainerInstanceOperationsOrigin(value)[source]

Bases: str, enum.Enum

The intended executor of the operation.

SYSTEM = 'System'
USER = 'User'
class azure.mgmt.containerinstance.models.ContainerNetworkProtocol(value)[source]

Bases: str, enum.Enum

The protocol associated with the port.

TCP = 'TCP'
UDP = 'UDP'
class azure.mgmt.containerinstance.models.ContainerPort(*, port: int, protocol: Optional[Union[str, _models.ContainerNetworkProtocol]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The port exposed on the container instance.

All required parameters must be populated in order to send to Azure.

Variables

  • protocol (str or ContainerNetworkProtocol) – The protocol associated with the port. Known values are: “TCP” and “UDP”.

  • port (int) – The port number exposed within the container group. Required.

Keyword Arguments

  • protocol (str or ContainerNetworkProtocol) – The protocol associated with the port. Known values are: “TCP” and “UDP”.

  • port (int) – The port number exposed within the container group. Required.

class azure.mgmt.containerinstance.models.ContainerProbe(*, exec_property: Optional[_models.ContainerExec] = None, http_get: Optional[_models.ContainerHttpGet] = None, initial_delay_seconds: Optional[int] = None, period_seconds: Optional[int] = None, failure_threshold: Optional[int] = None, success_threshold: Optional[int] = None, timeout_seconds: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container probe, for liveness or readiness.

Variables

  • exec_property (ContainerExec) – The execution command to probe.

  • http_get (ContainerHttpGet) – The Http Get settings to probe.

  • initial_delay_seconds (int) – The initial delay seconds.

  • period_seconds (int) – The period seconds.

  • failure_threshold (int) – The failure threshold.

  • success_threshold (int) – The success threshold.

  • timeout_seconds (int) – The timeout seconds.

Keyword Arguments

  • exec_property (ContainerExec) – The execution command to probe.

  • http_get (ContainerHttpGet) – The Http Get settings to probe.

  • initial_delay_seconds (int) – The initial delay seconds.

  • period_seconds (int) – The period seconds.

  • failure_threshold (int) – The failure threshold.

  • success_threshold (int) – The success threshold.

  • timeout_seconds (int) – The timeout seconds.

class azure.mgmt.containerinstance.models.ContainerPropertiesInstanceView(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The instance view of the container instance. Only valid in response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • restart_count (int) – The number of times that the container instance has been restarted.

  • current_state (ContainerState) – Current container instance state.

  • previous_state (ContainerState) – Previous container instance state.

  • events (list[Event]) – The events of the container instance.

class azure.mgmt.containerinstance.models.ContainerState(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container instance state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • state (str) – The state of the container instance.

  • start_time (datetime) – The date-time when the container instance state started.

  • exit_code (int) – The container instance exit codes correspond to those from the docker run command.

  • finish_time (datetime) – The date-time when the container instance state finished.

  • detail_status (str) – The human-readable status of the container instance state.

class azure.mgmt.containerinstance.models.DeploymentExtensionSpec(*, name: str, extension_type: Optional[str] = None, version: Optional[str] = None, settings: Optional[collections.abc.MutableMapping[str, Any]] = None, protected_settings: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Extension sidecars to be added to the deployment.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – Name of the extension. Required.

  • extension_type (str) – Type of extension to be added.

  • version (str) – Version of the extension being used.

  • settings (JSON) – Settings for the extension.

  • protected_settings (JSON) – Protected settings for the extension.

Keyword Arguments

  • name (str) – Name of the extension. Required.

  • extension_type (str) – Type of extension to be added.

  • version (str) – Version of the extension being used.

  • settings (JSON) – Settings for the extension.

  • protected_settings (JSON) – Protected settings for the extension.

class azure.mgmt.containerinstance.models.DnsConfiguration(*, name_servers: List[str], search_domains: Optional[str] = None, options: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

DNS configuration for the container group.

All required parameters must be populated in order to send to Azure.

Variables

  • name_servers (list[str]) – The DNS servers for the container group. Required.

  • search_domains (str) – The DNS search domains for hostname lookup in the container group.

  • options (str) – The DNS options for the container group.

Keyword Arguments

  • name_servers (list[str]) – The DNS servers for the container group. Required.

  • search_domains (str) – The DNS search domains for hostname lookup in the container group.

  • options (str) – The DNS options for the container group.

class azure.mgmt.containerinstance.models.DnsNameLabelReusePolicy(value)[source]

Bases: str, enum.Enum

The value representing the security enum. The ‘Unsecure’ value is the default value if not selected and means the object’s domain name label is not secured against subdomain takeover. The ‘TenantReuse’ value is the default value if selected and means the object’s domain name label can be reused within the same tenant. The ‘SubscriptionReuse’ value means the object’s domain name label can be reused within the same subscription. The ‘ResourceGroupReuse’ value means the object’s domain name label can be reused within the same resource group. The ‘NoReuse’ value means the object’s domain name label cannot be reused within the same resource group, subscription, or tenant.

NOREUSE = 'Noreuse'
RESOURCE_GROUP_REUSE = 'ResourceGroupReuse'
SUBSCRIPTION_REUSE = 'SubscriptionReuse'
TENANT_REUSE = 'TenantReuse'
UNSECURE = 'Unsecure'
class azure.mgmt.containerinstance.models.EncryptionProperties(*, vault_base_url: str, key_name: str, key_version: str, identity: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The container group encryption properties.

All required parameters must be populated in order to send to Azure.

Variables

  • vault_base_url (str) – The keyvault base url. Required.

  • key_name (str) – The encryption key name. Required.

  • key_version (str) – The encryption key version. Required.

  • identity (str) – The keyvault managed identity.

Keyword Arguments

  • vault_base_url (str) – The keyvault base url. Required.

  • key_name (str) – The encryption key name. Required.

  • key_version (str) – The encryption key version. Required.

  • identity (str) – The keyvault managed identity.

class azure.mgmt.containerinstance.models.EnvironmentVariable(*, name: str, value: Optional[str] = None, secure_value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The environment variable to set within the container instance.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name of the environment variable. Required.

  • value (str) – The value of the environment variable.

  • secure_value (str) – The value of the secure environment variable.

Keyword Arguments

  • name (str) – The name of the environment variable. Required.

  • value (str) – The value of the environment variable.

  • secure_value (str) – The value of the secure environment variable.

class azure.mgmt.containerinstance.models.Event(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

A container group or container instance event.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • count (int) – The count of the event.

  • first_timestamp (datetime) – The date-time of the earliest logged event.

  • last_timestamp (datetime) – The date-time of the latest logged event.

  • name (str) – The event name.

  • message (str) – The event message.

  • type (str) – The event type.

class azure.mgmt.containerinstance.models.GitRepoVolume(*, repository: str, directory: Optional[str] = None, revision: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Represents a volume that is populated with the contents of a git repository.

All required parameters must be populated in order to send to Azure.

Variables

  • directory (str) – Target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

  • repository (str) – Repository URL. Required.

  • revision (str) – Commit hash for the specified revision.

Keyword Arguments

  • directory (str) – Target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

  • repository (str) – Repository URL. Required.

  • revision (str) – Commit hash for the specified revision.

class azure.mgmt.containerinstance.models.GpuResource(*, count: int, sku: Union[str, _models.GpuSku], **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The GPU resource.

All required parameters must be populated in order to send to Azure.

Variables

  • count (int) – The count of the GPU resource. Required.

  • sku (str or GpuSku) – The SKU of the GPU resource. Required. Known values are: “K80”, “P100”, and “V100”.

Keyword Arguments

  • count (int) – The count of the GPU resource. Required.

  • sku (str or GpuSku) – The SKU of the GPU resource. Required. Known values are: “K80”, “P100”, and “V100”.

class azure.mgmt.containerinstance.models.GpuSku(value)[source]

Bases: str, enum.Enum

The SKU of the GPU resource.

K80 = 'K80'
P100 = 'P100'
V100 = 'V100'
class azure.mgmt.containerinstance.models.HttpHeader(*, name: Optional[str] = None, value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The HTTP header.

Variables

  • name (str) – The header name.

  • value (str) – The header value.

Keyword Arguments

  • name (str) – The header name.

  • value (str) – The header value.

class azure.mgmt.containerinstance.models.ImageRegistryCredential(*, server: str, username: Optional[str] = None, password: Optional[str] = None, identity: Optional[str] = None, identity_url: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Image registry credential.

All required parameters must be populated in order to send to Azure.

Variables

  • server (str) – The Docker image registry server without a protocol such as “http” and “https”. Required.

  • username (str) – The username for the private registry.

  • password (str) – The password for the private registry.

  • identity (str) – The identity for the private registry.

  • identity_url (str) – The identity URL for the private registry.

Keyword Arguments

  • server (str) – The Docker image registry server without a protocol such as “http” and “https”. Required.

  • username (str) – The username for the private registry.

  • password (str) – The password for the private registry.

  • identity (str) – The identity for the private registry.

  • identity_url (str) – The identity URL for the private registry.

class azure.mgmt.containerinstance.models.InitContainerDefinition(*, name: str, image: Optional[str] = None, command: Optional[List[str]] = None, environment_variables: Optional[List[_models.EnvironmentVariable]] = None, volume_mounts: Optional[List[_models.VolumeMount]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The init container definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name for the init container. Required.

  • image (str) – The image of the init container.

  • command (list[str]) – The command to execute within the init container in exec form.

  • environment_variables (list[EnvironmentVariable]) – The environment variables to set in the init container.

  • instance_view (InitContainerPropertiesDefinitionInstanceView) – The instance view of the init container. Only valid in response.

  • volume_mounts (list[VolumeMount]) – The volume mounts available to the init container.

Keyword Arguments

  • name (str) – The name for the init container. Required.

  • image (str) – The image of the init container.

  • command (list[str]) – The command to execute within the init container in exec form.

  • environment_variables (list[EnvironmentVariable]) – The environment variables to set in the init container.

  • volume_mounts (list[VolumeMount]) – The volume mounts available to the init container.

class azure.mgmt.containerinstance.models.InitContainerPropertiesDefinitionInstanceView(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The instance view of the init container. Only valid in response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • restart_count (int) – The number of times that the init container has been restarted.

  • current_state (ContainerState) – The current state of the init container.

  • previous_state (ContainerState) – The previous state of the init container.

  • events (list[Event]) – The events of the init container.

class azure.mgmt.containerinstance.models.IpAddress(*, ports: List[_models.Port], type: Union[str, _models.ContainerGroupIpAddressType], ip: Optional[str] = None, dns_name_label: Optional[str] = None, auto_generated_domain_name_label_scope: Union[str, _models.DnsNameLabelReusePolicy] = 'Unsecure', **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

IP address for the container group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • ports (list[Port]) – The list of ports exposed on the container group. Required.

  • type (str or ContainerGroupIpAddressType) – Specifies if the IP is exposed to the public internet or private VNET. Required. Known values are: “Public” and “Private”.

  • ip (str) – The IP exposed to the public internet.

  • dns_name_label (str) – The Dns name label for the IP.

  • auto_generated_domain_name_label_scope (str or DnsNameLabelReusePolicy) – The value representing the security enum. The ‘Unsecure’ value is the default value if not selected and means the object’s domain name label is not secured against subdomain takeover. The ‘TenantReuse’ value is the default value if selected and means the object’s domain name label can be reused within the same tenant. The ‘SubscriptionReuse’ value means the object’s domain name label can be reused within the same subscription. The ‘ResourceGroupReuse’ value means the object’s domain name label can be reused within the same resource group. The ‘NoReuse’ value means the object’s domain name label cannot be reused within the same resource group, subscription, or tenant. Known values are: “Unsecure”, “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “Noreuse”.

  • fqdn (str) – The FQDN for the IP.

Keyword Arguments

  • ports (list[Port]) – The list of ports exposed on the container group. Required.

  • type (str or ContainerGroupIpAddressType) – Specifies if the IP is exposed to the public internet or private VNET. Required. Known values are: “Public” and “Private”.

  • ip (str) – The IP exposed to the public internet.

  • dns_name_label (str) – The Dns name label for the IP.

  • auto_generated_domain_name_label_scope (str or DnsNameLabelReusePolicy) – The value representing the security enum. The ‘Unsecure’ value is the default value if not selected and means the object’s domain name label is not secured against subdomain takeover. The ‘TenantReuse’ value is the default value if selected and means the object’s domain name label can be reused within the same tenant. The ‘SubscriptionReuse’ value means the object’s domain name label can be reused within the same subscription. The ‘ResourceGroupReuse’ value means the object’s domain name label can be reused within the same resource group. The ‘NoReuse’ value means the object’s domain name label cannot be reused within the same resource group, subscription, or tenant. Known values are: “Unsecure”, “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “Noreuse”.

class azure.mgmt.containerinstance.models.LogAnalytics(*, workspace_id: str, workspace_key: str, log_type: Optional[Union[str, _models.LogAnalyticsLogType]] = None, metadata: Optional[Dict[str, str]] = None, workspace_resource_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

Container group log analytics information.

All required parameters must be populated in order to send to Azure.

Variables

  • workspace_id (str) – The workspace id for log analytics. Required.

  • workspace_key (str) – The workspace key for log analytics. Required.

  • log_type (str or LogAnalyticsLogType) – The log type to be used. Known values are: “ContainerInsights” and “ContainerInstanceLogs”.

  • metadata (dict[str, str]) – Metadata for log analytics.

  • workspace_resource_id (str) – The workspace resource id for log analytics.

Keyword Arguments

  • workspace_id (str) – The workspace id for log analytics. Required.

  • workspace_key (str) – The workspace key for log analytics. Required.

  • log_type (str or LogAnalyticsLogType) – The log type to be used. Known values are: “ContainerInsights” and “ContainerInstanceLogs”.

  • metadata (dict[str, str]) – Metadata for log analytics.

  • workspace_resource_id (str) – The workspace resource id for log analytics.

class azure.mgmt.containerinstance.models.LogAnalyticsLogType(value)[source]

Bases: str, enum.Enum

The log type to be used.

CONTAINER_INSIGHTS = 'ContainerInsights'
CONTAINER_INSTANCE_LOGS = 'ContainerInstanceLogs'
class azure.mgmt.containerinstance.models.Logs(*, content: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The logs.

Variables

content (str) – The content of the log.

Keyword Arguments

content (str) – The content of the log.

class azure.mgmt.containerinstance.models.OperatingSystemTypes(value)[source]

Bases: str, enum.Enum

The operating system type required by the containers in the container group.

LINUX = 'Linux'
WINDOWS = 'Windows'
class azure.mgmt.containerinstance.models.Operation(*, name: str, display: _models.OperationDisplay, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, origin: Optional[Union[str, _models.ContainerInstanceOperationsOrigin]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

An operation for Azure Container Instance service.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name of the operation. Required.

  • display (OperationDisplay) – The display information of the operation. Required.

  • properties (JSON) – The additional properties.

  • origin (str or ContainerInstanceOperationsOrigin) – The intended executor of the operation. Known values are: “User” and “System”.

Keyword Arguments

  • name (str) – The name of the operation. Required.

  • display (OperationDisplay) – The display information of the operation. Required.

  • properties (JSON) – The additional properties.

  • origin (str or ContainerInstanceOperationsOrigin) – The intended executor of the operation. Known values are: “User” and “System”.

class azure.mgmt.containerinstance.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The display information of the operation.

Variables

  • provider (str) – The name of the provider of the operation.

  • resource (str) – The name of the resource type of the operation.

  • operation (str) – The friendly name of the operation.

  • description (str) – The description of the operation.

Keyword Arguments

  • provider (str) – The name of the provider of the operation.

  • resource (str) – The name of the resource type of the operation.

  • operation (str) – The friendly name of the operation.

  • description (str) – The description of the operation.

class azure.mgmt.containerinstance.models.OperationListResult(*, value: Optional[List[_models.Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The operation list response that contains all operations for Azure Container Instance service.

Variables

  • value (list[Operation]) – The list of operations.

  • next_link (str) – The URI to fetch the next page of operations.

Keyword Arguments

  • value (list[Operation]) – The list of operations.

  • next_link (str) – The URI to fetch the next page of operations.

class azure.mgmt.containerinstance.models.Port(*, port: int, protocol: Optional[Union[str, _models.ContainerGroupNetworkProtocol]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The port exposed on the container group.

All required parameters must be populated in order to send to Azure.

Variables

  • protocol (str or ContainerGroupNetworkProtocol) – The protocol associated with the port. Known values are: “TCP” and “UDP”.

  • port (int) – The port number. Required.

Keyword Arguments

  • protocol (str or ContainerGroupNetworkProtocol) – The protocol associated with the port. Known values are: “TCP” and “UDP”.

  • port (int) – The port number. Required.

class azure.mgmt.containerinstance.models.Resource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, zones: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The resource id.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • location (str) – The resource location.

  • tags (dict[str, str]) – The resource tags.

  • zones (list[str]) – The zones for the container group.

Keyword Arguments

  • location (str) – The resource location.

  • tags (dict[str, str]) – The resource tags.

  • zones (list[str]) – The zones for the container group.

class azure.mgmt.containerinstance.models.ResourceIdentityType(value)[source]

Bases: str, enum.Enum

The type of identity used for the container group. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the container group.

NONE = 'None'
SYSTEM_ASSIGNED = 'SystemAssigned'
SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'
USER_ASSIGNED = 'UserAssigned'
class azure.mgmt.containerinstance.models.ResourceLimits(*, memory_in_gb: Optional[float] = None, cpu: Optional[float] = None, gpu: Optional[_models.GpuResource] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The resource limits.

Variables

  • memory_in_gb (float) – The memory limit in GB of this container instance.

  • cpu (float) – The CPU limit of this container instance.

  • gpu (GpuResource) – The GPU limit of this container instance.

Keyword Arguments

  • memory_in_gb (float) – The memory limit in GB of this container instance.

  • cpu (float) – The CPU limit of this container instance.

  • gpu (GpuResource) – The GPU limit of this container instance.

class azure.mgmt.containerinstance.models.ResourceRequests(*, memory_in_gb: float, cpu: float, gpu: Optional[_models.GpuResource] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The resource requests.

All required parameters must be populated in order to send to Azure.

Variables

  • memory_in_gb (float) – The memory request in GB of this container instance. Required.

  • cpu (float) – The CPU request of this container instance. Required.

  • gpu (GpuResource) – The GPU request of this container instance.

Keyword Arguments

  • memory_in_gb (float) – The memory request in GB of this container instance. Required.

  • cpu (float) – The CPU request of this container instance. Required.

  • gpu (GpuResource) – The GPU request of this container instance.

class azure.mgmt.containerinstance.models.ResourceRequirements(*, requests: _models.ResourceRequests, limits: Optional[_models.ResourceLimits] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The resource requirements.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments

  • requests (ResourceRequests) – The resource requests of this container instance. Required.

  • limits (ResourceLimits) – The resource limits of this container instance.

class azure.mgmt.containerinstance.models.Scheme(value)[source]

Bases: str, enum.Enum

The scheme.

HTTP = 'http'
HTTPS = 'https'
class azure.mgmt.containerinstance.models.Usage(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

A single usage result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Id of the usage result.

  • unit (str) – Unit of the usage result.

  • current_value (int) – The current usage of the resource.

  • limit (int) – The maximum permitted usage of the resource.

  • name (UsageName) – The name object of the resource.

class azure.mgmt.containerinstance.models.UsageListResult(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The response containing the usage data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Usage]) – The usage data.

class azure.mgmt.containerinstance.models.UsageName(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The name object of the resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • value (str) – The name of the resource.

  • localized_value (str) – The localized name of the resource.

class azure.mgmt.containerinstance.models.UserAssignedIdentities(**kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • principal_id (str) – The principal id of user assigned identity.

  • client_id (str) – The client id of user assigned identity.

class azure.mgmt.containerinstance.models.Volume(*, name: str, azure_file: Optional[_models.AzureFileVolume] = None, empty_dir: Optional[collections.abc.MutableMapping[str, Any]] = None, secret: Optional[Dict[str, str]] = None, git_repo: Optional[_models.GitRepoVolume] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The properties of the volume.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name of the volume. Required.

  • azure_file (AzureFileVolume) – The Azure File volume.

  • empty_dir (JSON) – The empty directory volume.

  • secret (dict[str, str]) – The secret volume.

  • git_repo (GitRepoVolume) – The git repo volume.

Keyword Arguments

  • name (str) – The name of the volume. Required.

  • azure_file (AzureFileVolume) – The Azure File volume.

  • empty_dir (JSON) – The empty directory volume.

  • secret (dict[str, str]) – The secret volume.

  • git_repo (GitRepoVolume) – The git repo volume.

class azure.mgmt.containerinstance.models.VolumeMount(*, name: str, mount_path: str, read_only: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.containerinstance._serialization.Model

The properties of the volume mount.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name of the volume mount. Required.

  • mount_path (str) – The path within the container where the volume should be mounted. Must not contain colon (:). Required.

  • read_only (bool) – The flag indicating whether the volume mount is read-only.

Keyword Arguments

  • name (str) – The name of the volume mount. Required.

  • mount_path (str) – The path within the container where the volume should be mounted. Must not contain colon (:). Required.

  • read_only (bool) – The flag indicating whether the volume mount is read-only.