Group

Manages as an Azure Container Group instance.

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

def Group(resource_name, opts=None, containers=None, diagnostics=None, dns_name_label=None, identity=None, image_registry_credentials=None, ip_address_type=None, location=None, name=None, network_profile_id=None, os_type=None, resource_group_name=None, restart_policy=None, tags=None, __props__=None);

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Group resource accepts the following input properties:

Containers List<GroupContainerArgs>: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
OsType string: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
Diagnostics GroupDiagnosticsArgs: A diagnostics block as documented below.
DnsNameLabel string: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
Identity GroupIdentityArgs: An identity block as defined below.
ImageRegistryCredentials List<GroupImageRegistryCredentialArgs>: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
IpAddressType string: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
NetworkProfileId string: Network profile ID for deploying to virtual network.
RestartPolicy string: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

Containers []GroupContainer: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
OsType string: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
Diagnostics GroupDiagnostics: A diagnostics block as documented below.
DnsNameLabel string: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
Identity GroupIdentity: An identity block as defined below.
ImageRegistryCredentials []GroupImageRegistryCredential: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
IpAddressType string: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
NetworkProfileId string: Network profile ID for deploying to virtual network.
RestartPolicy string: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

containers GroupContainer[]: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
osType string: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
diagnostics GroupDiagnostics: A diagnostics block as documented below.
dnsNameLabel string: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
identity GroupIdentity: An identity block as defined below.
imageRegistryCredentials GroupImageRegistryCredential[]: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
ipAddressType string: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
networkProfileId string: Network profile ID for deploying to virtual network.
restartPolicy string: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

containers List[GroupContainer]: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
os_type str: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
diagnostics Dict[GroupDiagnostics]: A diagnostics block as documented below.
dns_name_label str: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
identity Dict[GroupIdentity]: An identity block as defined below.
image_registry_credentials List[GroupImageRegistryCredential]: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
ip_address_type str: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Container Group. Changing this forces a new resource to be created.
network_profile_id str: Network profile ID for deploying to virtual network.
restart_policy str: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Fqdn string: The FQDN of the container group derived from dns_name_label.
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: The IP address allocated to the container group.

Fqdn string: The FQDN of the container group derived from dns_name_label.
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: The IP address allocated to the container group.

fqdn string: The FQDN of the container group derived from dns_name_label.
id string: The provider-assigned unique ID for this managed resource.
ipAddress string: The IP address allocated to the container group.

fqdn str: The FQDN of the container group derived from dns_name_label.
id str: The provider-assigned unique ID for this managed resource.
ip_address str: The IP address allocated to the container group.

Look up an Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group

static get(resource_name, id, opts=None, containers=None, diagnostics=None, dns_name_label=None, fqdn=None, identity=None, image_registry_credentials=None, ip_address=None, ip_address_type=None, location=None, name=None, network_profile_id=None, os_type=None, resource_group_name=None, restart_policy=None, tags=None, __props__=None);

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Containers List<GroupContainerArgs>: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
Diagnostics GroupDiagnosticsArgs: A diagnostics block as documented below.
DnsNameLabel string: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
Fqdn string: The FQDN of the container group derived from dns_name_label.
Identity GroupIdentityArgs: An identity block as defined below.
ImageRegistryCredentials List<GroupImageRegistryCredentialArgs>: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
IpAddress string: The IP address allocated to the container group.
IpAddressType string: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
NetworkProfileId string: Network profile ID for deploying to virtual network.
OsType string: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
RestartPolicy string: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

Containers []GroupContainer: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
Diagnostics GroupDiagnostics: A diagnostics block as documented below.
DnsNameLabel string: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
Fqdn string: The FQDN of the container group derived from dns_name_label.
Identity GroupIdentity: An identity block as defined below.
ImageRegistryCredentials []GroupImageRegistryCredential: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
IpAddress string: The IP address allocated to the container group.
IpAddressType string: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
NetworkProfileId string: Network profile ID for deploying to virtual network.
OsType string: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
RestartPolicy string: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

containers GroupContainer[]: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
diagnostics GroupDiagnostics: A diagnostics block as documented below.
dnsNameLabel string: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
fqdn string: The FQDN of the container group derived from dns_name_label.
identity GroupIdentity: An identity block as defined below.
imageRegistryCredentials GroupImageRegistryCredential[]: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
ipAddress string: The IP address allocated to the container group.
ipAddressType string: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
networkProfileId string: Network profile ID for deploying to virtual network.
osType string: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
restartPolicy string: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

containers List[GroupContainer]: The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.
diagnostics Dict[GroupDiagnostics]: A diagnostics block as documented below.
dns_name_label str: The DNS label/name for the container groups IP. Changing this forces a new resource to be created.
fqdn str: The FQDN of the container group derived from dns_name_label.
identity Dict[GroupIdentity]: An identity block as defined below.
image_registry_credentials List[GroupImageRegistryCredential]: A image_registry_credential block as documented below. Changing this forces a new resource to be created.
ip_address str: The IP address allocated to the container group.
ip_address_type str: Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Container Group. Changing this forces a new resource to be created.
network_profile_id str: Network profile ID for deploying to virtual network.
os_type str: The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
restart_policy str: Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

Supporting Types

GroupContainer

Cpu double: The required number of CPU cores of the containers. Changing this forces a new resource to be created.
Image string: The container image name. Changing this forces a new resource to be created.
Memory double: The required memory of the containers in GB. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
Commands List<string>: A list of commands which should be run on the container. Changing this forces a new resource to be created.
EnvironmentVariables Dictionary<string, string>: A list of environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
Gpu GroupContainerGpuArgs: A gpu block as defined below. Changing this forces a new resource to be created.
LivenessProbe GroupContainerLivenessProbeArgs: The definition of a readiness probe for this container as documented in the liveness_probe block below. Changing this forces a new resource to be created.
Ports List<GroupContainerPortArgs>: A set of public ports for the container. Changing this forces a new resource to be created. Set as documented in the ports block below.
ReadinessProbe GroupContainerReadinessProbeArgs: The definition of a readiness probe for this container as documented in the readiness_probe block below. Changing this forces a new resource to be created.
SecureEnvironmentVariables Dictionary<string, string>: A list of sensitive environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
Volumes List<GroupContainerVolumeArgs>: The definition of a volume mount for this container as documented in the volume block below. Changing this forces a new resource to be created.

Cpu float64: The required number of CPU cores of the containers. Changing this forces a new resource to be created.
Image string: The container image name. Changing this forces a new resource to be created.
Memory float64: The required memory of the containers in GB. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
Commands []string: A list of commands which should be run on the container. Changing this forces a new resource to be created.
EnvironmentVariables map[string]string: A list of environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
Gpu GroupContainerGpu: A gpu block as defined below. Changing this forces a new resource to be created.
LivenessProbe GroupContainerLivenessProbe: The definition of a readiness probe for this container as documented in the liveness_probe block below. Changing this forces a new resource to be created.
Ports []GroupContainerPort: A set of public ports for the container. Changing this forces a new resource to be created. Set as documented in the ports block below.
ReadinessProbe GroupContainerReadinessProbe: The definition of a readiness probe for this container as documented in the readiness_probe block below. Changing this forces a new resource to be created.
SecureEnvironmentVariables map[string]string: A list of sensitive environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
Volumes []GroupContainerVolume: The definition of a volume mount for this container as documented in the volume block below. Changing this forces a new resource to be created.

cpu number: The required number of CPU cores of the containers. Changing this forces a new resource to be created.
image string: The container image name. Changing this forces a new resource to be created.
memory number: The required memory of the containers in GB. Changing this forces a new resource to be created.
name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
commands string[]: A list of commands which should be run on the container. Changing this forces a new resource to be created.
environmentVariables {[key: string]: string}: A list of environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
gpu GroupContainerGpu: A gpu block as defined below. Changing this forces a new resource to be created.
livenessProbe GroupContainerLivenessProbe: The definition of a readiness probe for this container as documented in the liveness_probe block below. Changing this forces a new resource to be created.
ports GroupContainerPort[]: A set of public ports for the container. Changing this forces a new resource to be created. Set as documented in the ports block below.
readinessProbe GroupContainerReadinessProbe: The definition of a readiness probe for this container as documented in the readiness_probe block below. Changing this forces a new resource to be created.
secureEnvironmentVariables {[key: string]: string}: A list of sensitive environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
volumes GroupContainerVolume[]: The definition of a volume mount for this container as documented in the volume block below. Changing this forces a new resource to be created.

cpu float: The required number of CPU cores of the containers. Changing this forces a new resource to be created.
image str: The container image name. Changing this forces a new resource to be created.
memory float: The required memory of the containers in GB. Changing this forces a new resource to be created.
name str: Specifies the name of the Container Group. Changing this forces a new resource to be created.
commands List[str]: A list of commands which should be run on the container. Changing this forces a new resource to be created.
environmentVariables Dict[str, str]: A list of environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
gpu Dict[GroupContainerGpu]: A gpu block as defined below. Changing this forces a new resource to be created.
livenessProbe Dict[GroupContainerLivenessProbe]: The definition of a readiness probe for this container as documented in the liveness_probe block below. Changing this forces a new resource to be created.
ports List[GroupContainerPort]: A set of public ports for the container. Changing this forces a new resource to be created. Set as documented in the ports block below.
readinessProbe Dict[GroupContainerReadinessProbe]: The definition of a readiness probe for this container as documented in the readiness_probe block below. Changing this forces a new resource to be created.
secureEnvironmentVariables Dict[str, str]: A list of sensitive environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.
volumes List[GroupContainerVolume]: The definition of a volume mount for this container as documented in the volume block below. Changing this forces a new resource to be created.

GroupContainerGpu

Count int: The number of GPUs which should be assigned to this container. Allowed values are 1, 2, or 4. Changing this forces a new resource to be created.
Sku string: The Sku which should be used for the GPU. Possible values are K80, P100, or V100. Changing this forces a new resource to be created.

Count int: The number of GPUs which should be assigned to this container. Allowed values are 1, 2, or 4. Changing this forces a new resource to be created.
Sku string: The Sku which should be used for the GPU. Possible values are K80, P100, or V100. Changing this forces a new resource to be created.

count number: The number of GPUs which should be assigned to this container. Allowed values are 1, 2, or 4. Changing this forces a new resource to be created.
sku string: The Sku which should be used for the GPU. Possible values are K80, P100, or V100. Changing this forces a new resource to be created.

count float: The number of GPUs which should be assigned to this container. Allowed values are 1, 2, or 4. Changing this forces a new resource to be created.
sku str: The Sku which should be used for the GPU. Possible values are K80, P100, or V100. Changing this forces a new resource to be created.

GroupContainerLivenessProbe

Execs List<string>: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
FailureThreshold int: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
HttpGets List<GroupContainerLivenessProbeHttpGetArgs>: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
InitialDelaySeconds int: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
PeriodSeconds int: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
SuccessThreshold int: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
TimeoutSeconds int: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

Execs []string: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
FailureThreshold int: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
HttpGets []GroupContainerLivenessProbeHttpGet: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
InitialDelaySeconds int: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
PeriodSeconds int: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
SuccessThreshold int: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
TimeoutSeconds int: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

execs string[]: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
failureThreshold number: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
httpGets GroupContainerLivenessProbeHttpGet[]: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
initialDelaySeconds number: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
periodSeconds number: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
successThreshold number: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
timeoutSeconds number: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

execs List[str]: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
failureThreshold float: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
httpGets List[GroupContainerLivenessProbeHttpGet]: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
initialDelaySeconds float: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
periodSeconds float: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
successThreshold float: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
timeoutSeconds float: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

GroupContainerLivenessProbeHttpGet

Path string: Path to access on the HTTP server. Changing this forces a new resource to be created.
Port int: The port number the container will expose. Changing this forces a new resource to be created.
Scheme string: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

Path string: Path to access on the HTTP server. Changing this forces a new resource to be created.
Port int: The port number the container will expose. Changing this forces a new resource to be created.
Scheme string: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

path string: Path to access on the HTTP server. Changing this forces a new resource to be created.
port number: The port number the container will expose. Changing this forces a new resource to be created.
scheme string: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

path str: Path to access on the HTTP server. Changing this forces a new resource to be created.
port float: The port number the container will expose. Changing this forces a new resource to be created.
scheme str: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

GroupContainerPort

Port int: The port number the container will expose. Changing this forces a new resource to be created.
Protocol string: The network protocol associated with port. Possible values are TCP & UDP. Changing this forces a new resource to be created.

Port int: The port number the container will expose. Changing this forces a new resource to be created.
Protocol string: The network protocol associated with port. Possible values are TCP & UDP. Changing this forces a new resource to be created.

port number: The port number the container will expose. Changing this forces a new resource to be created.
protocol string: The network protocol associated with port. Possible values are TCP & UDP. Changing this forces a new resource to be created.

port float: The port number the container will expose. Changing this forces a new resource to be created.
protocol str: The network protocol associated with port. Possible values are TCP & UDP. Changing this forces a new resource to be created.

GroupContainerReadinessProbe

Execs List<string>: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
FailureThreshold int: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
HttpGets List<GroupContainerReadinessProbeHttpGetArgs>: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
InitialDelaySeconds int: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
PeriodSeconds int: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
SuccessThreshold int: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
TimeoutSeconds int: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

Execs []string: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
FailureThreshold int: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
HttpGets []GroupContainerReadinessProbeHttpGet: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
InitialDelaySeconds int: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
PeriodSeconds int: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
SuccessThreshold int: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
TimeoutSeconds int: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

execs string[]: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
failureThreshold number: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
httpGets GroupContainerReadinessProbeHttpGet[]: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
initialDelaySeconds number: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
periodSeconds number: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
successThreshold number: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
timeoutSeconds number: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

execs List[str]: Commands to be run to validate container readiness. Changing this forces a new resource to be created.
failureThreshold float: How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.
httpGets List[GroupContainerReadinessProbeHttpGet]: The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.
initialDelaySeconds float: Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
periodSeconds float: How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.
successThreshold float: Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.
timeoutSeconds float: Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

GroupContainerReadinessProbeHttpGet

Path string: Path to access on the HTTP server. Changing this forces a new resource to be created.
Port int: The port number the container will expose. Changing this forces a new resource to be created.
Scheme string: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

Path string: Path to access on the HTTP server. Changing this forces a new resource to be created.
Port int: The port number the container will expose. Changing this forces a new resource to be created.
Scheme string: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

path string: Path to access on the HTTP server. Changing this forces a new resource to be created.
port number: The port number the container will expose. Changing this forces a new resource to be created.
scheme string: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

path str: Path to access on the HTTP server. Changing this forces a new resource to be created.
port float: The port number the container will expose. Changing this forces a new resource to be created.
scheme str: Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

GroupContainerVolume

MountPath string: The path on which this volume is to be mounted. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
ShareName string: The Azure storage share that is to be mounted as a volume. This must be created on the storage account specified as above. Changing this forces a new resource to be created.
StorageAccountKey string: The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
StorageAccountName string: The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
ReadOnly bool: Specify if the volume is to be mounted as read only or not. The default value is false. Changing this forces a new resource to be created.

MountPath string: The path on which this volume is to be mounted. Changing this forces a new resource to be created.
Name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
ShareName string: The Azure storage share that is to be mounted as a volume. This must be created on the storage account specified as above. Changing this forces a new resource to be created.
StorageAccountKey string: The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
StorageAccountName string: The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
ReadOnly bool: Specify if the volume is to be mounted as read only or not. The default value is false. Changing this forces a new resource to be created.

mountPath string: The path on which this volume is to be mounted. Changing this forces a new resource to be created.
name string: Specifies the name of the Container Group. Changing this forces a new resource to be created.
shareName string: The Azure storage share that is to be mounted as a volume. This must be created on the storage account specified as above. Changing this forces a new resource to be created.
storageAccountKey string: The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
storageAccountName string: The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
readOnly boolean: Specify if the volume is to be mounted as read only or not. The default value is false. Changing this forces a new resource to be created.

mountPath str: The path on which this volume is to be mounted. Changing this forces a new resource to be created.
name str: Specifies the name of the Container Group. Changing this forces a new resource to be created.
share_name str: The Azure storage share that is to be mounted as a volume. This must be created on the storage account specified as above. Changing this forces a new resource to be created.
storage_account_key str: The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
storage_account_name str: The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
readOnly bool: Specify if the volume is to be mounted as read only or not. The default value is false. Changing this forces a new resource to be created.

GroupDiagnostics

LogAnalytics GroupDiagnosticsLogAnalyticsArgs: A log_analytics block as defined below. Changing this forces a new resource to be created.

LogAnalytics GroupDiagnosticsLogAnalytics: A log_analytics block as defined below. Changing this forces a new resource to be created.

logAnalytics GroupDiagnosticsLogAnalytics: A log_analytics block as defined below. Changing this forces a new resource to be created.

logAnalytics Dict[GroupDiagnosticsLogAnalytics]: A log_analytics block as defined below. Changing this forces a new resource to be created.

GroupDiagnosticsLogAnalytics

WorkspaceId string: The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
WorkspaceKey string: The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
LogType string: The log type which should be used. Possible values are ContainerInsights and ContainerInstanceLogs. Changing this forces a new resource to be created.
Metadata Dictionary<string, string>: Any metadata required for Log Analytics. Changing this forces a new resource to be created.

WorkspaceId string: The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
WorkspaceKey string: The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
LogType string: The log type which should be used. Possible values are ContainerInsights and ContainerInstanceLogs. Changing this forces a new resource to be created.
Metadata map[string]string: Any metadata required for Log Analytics. Changing this forces a new resource to be created.

workspaceId string: The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
workspaceKey string: The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
logType string: The log type which should be used. Possible values are ContainerInsights and ContainerInstanceLogs. Changing this forces a new resource to be created.
metadata {[key: string]: string}: Any metadata required for Log Analytics. Changing this forces a new resource to be created.

workspaceKey str: The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
workspace_id str: The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
logType str: The log type which should be used. Possible values are ContainerInsights and ContainerInstanceLogs. Changing this forces a new resource to be created.
metadata Dict[str, str]: Any metadata required for Log Analytics. Changing this forces a new resource to be created.

GroupIdentity

Type string: The Managed Service Identity Type of this container group. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities. Changing this forces a new resource to be created.
IdentityIds List<string>: Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned. Changing this forces a new resource to be created.
PrincipalId string

Type string: The Managed Service Identity Type of this container group. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities. Changing this forces a new resource to be created.
IdentityIds []string: Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned. Changing this forces a new resource to be created.
PrincipalId string

type string: The Managed Service Identity Type of this container group. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities. Changing this forces a new resource to be created.
identityIds string[]: Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned. Changing this forces a new resource to be created.
principalId string

type str: The Managed Service Identity Type of this container group. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities. Changing this forces a new resource to be created.
identityIds List[str]: Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned. Changing this forces a new resource to be created.
principal_id str

GroupImageRegistryCredential

Password string: The password with which to connect to the registry. Changing this forces a new resource to be created.
Server string: The address to use to connect to the registry without protocol (“https”/“http”). For example: “myacr.acr.io”. Changing this forces a new resource to be created.
Username string: The username with which to connect to the registry. Changing this forces a new resource to be created.

Password string: The password with which to connect to the registry. Changing this forces a new resource to be created.
Server string: The address to use to connect to the registry without protocol (“https”/“http”). For example: “myacr.acr.io”. Changing this forces a new resource to be created.
Username string: The username with which to connect to the registry. Changing this forces a new resource to be created.

password string: The password with which to connect to the registry. Changing this forces a new resource to be created.
server string: The address to use to connect to the registry without protocol (“https”/“http”). For example: “myacr.acr.io”. Changing this forces a new resource to be created.
username string: The username with which to connect to the registry. Changing this forces a new resource to be created.

password str: The password with which to connect to the registry. Changing this forces a new resource to be created.
server str: The address to use to connect to the registry without protocol (“https”/“http”). For example: “myacr.acr.io”. Changing this forces a new resource to be created.
username str: The username with which to connect to the registry. Changing this forces a new resource to be created.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud