azure.containerservice.Group
Explore with Pulumi AI
Manages as an Azure Container Group instance.
Note
network_profile_id
is deprecated by Azure. For users who want to continue to manage existingazure.containerservice.Group
that rely onnetwork_profile_id
, please stay on provider versions prior to v3.16.0. Otherwise, usesubnet_ids
instead.
Example Usage
This example provisions a Basic Container.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleGroup = new Azure.ContainerService.Group("exampleGroup", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
IpAddressType = "Public",
DnsNameLabel = "aci-label",
OsType = "Linux",
Containers = new[]
{
new Azure.ContainerService.Inputs.GroupContainerArgs
{
Name = "hello-world",
Image = "mcr.microsoft.com/azuredocs/aci-helloworld:latest",
Cpu = 0.5,
Memory = 1.5,
Ports = new[]
{
new Azure.ContainerService.Inputs.GroupContainerPortArgs
{
Port = 443,
Protocol = "TCP",
},
},
},
new Azure.ContainerService.Inputs.GroupContainerArgs
{
Name = "sidecar",
Image = "mcr.microsoft.com/azuredocs/aci-tutorial-sidecar",
Cpu = 0.5,
Memory = 1.5,
},
},
Tags =
{
{ "environment", "testing" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/containerservice"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = containerservice.NewGroup(ctx, "exampleGroup", &containerservice.GroupArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
IpAddressType: pulumi.String("Public"),
DnsNameLabel: pulumi.String("aci-label"),
OsType: pulumi.String("Linux"),
Containers: containerservice.GroupContainerArray{
&containerservice.GroupContainerArgs{
Name: pulumi.String("hello-world"),
Image: pulumi.String("mcr.microsoft.com/azuredocs/aci-helloworld:latest"),
Cpu: pulumi.Float64(0.5),
Memory: pulumi.Float64(1.5),
Ports: containerservice.GroupContainerPortArray{
&containerservice.GroupContainerPortArgs{
Port: pulumi.Int(443),
Protocol: pulumi.String("TCP"),
},
},
},
&containerservice.GroupContainerArgs{
Name: pulumi.String("sidecar"),
Image: pulumi.String("mcr.microsoft.com/azuredocs/aci-tutorial-sidecar"),
Cpu: pulumi.Float64(0.5),
Memory: pulumi.Float64(1.5),
},
},
Tags: pulumi.StringMap{
"environment": pulumi.String("testing"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.containerservice.Group;
import com.pulumi.azure.containerservice.GroupArgs;
import com.pulumi.azure.containerservice.inputs.GroupContainerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.ipAddressType("Public")
.dnsNameLabel("aci-label")
.osType("Linux")
.containers(
GroupContainerArgs.builder()
.name("hello-world")
.image("mcr.microsoft.com/azuredocs/aci-helloworld:latest")
.cpu("0.5")
.memory("1.5")
.ports(GroupContainerPortArgs.builder()
.port(443)
.protocol("TCP")
.build())
.build(),
GroupContainerArgs.builder()
.name("sidecar")
.image("mcr.microsoft.com/azuredocs/aci-tutorial-sidecar")
.cpu("0.5")
.memory("1.5")
.build())
.tags(Map.of("environment", "testing"))
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_group = azure.containerservice.Group("exampleGroup",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
ip_address_type="Public",
dns_name_label="aci-label",
os_type="Linux",
containers=[
azure.containerservice.GroupContainerArgs(
name="hello-world",
image="mcr.microsoft.com/azuredocs/aci-helloworld:latest",
cpu=0.5,
memory=1.5,
ports=[azure.containerservice.GroupContainerPortArgs(
port=443,
protocol="TCP",
)],
),
azure.containerservice.GroupContainerArgs(
name="sidecar",
image="mcr.microsoft.com/azuredocs/aci-tutorial-sidecar",
cpu=0.5,
memory=1.5,
),
],
tags={
"environment": "testing",
})
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleGroup = new azure.containerservice.Group("exampleGroup", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
ipAddressType: "Public",
dnsNameLabel: "aci-label",
osType: "Linux",
containers: [
{
name: "hello-world",
image: "mcr.microsoft.com/azuredocs/aci-helloworld:latest",
cpu: 0.5,
memory: 1.5,
ports: [{
port: 443,
protocol: "TCP",
}],
},
{
name: "sidecar",
image: "mcr.microsoft.com/azuredocs/aci-tutorial-sidecar",
cpu: 0.5,
memory: 1.5,
},
],
tags: {
environment: "testing",
},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleGroup:
type: azure:containerservice:Group
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
ipAddressType: Public
dnsNameLabel: aci-label
osType: Linux
containers:
- name: hello-world
image: mcr.microsoft.com/azuredocs/aci-helloworld:latest
cpu: '0.5'
memory: '1.5'
ports:
- port: 443
protocol: TCP
- name: sidecar
image: mcr.microsoft.com/azuredocs/aci-tutorial-sidecar
cpu: '0.5'
memory: '1.5'
tags:
environment: testing
Create Group Resource
new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
opts: Optional[ResourceOptions] = None,
containers: Optional[Sequence[GroupContainerArgs]] = None,
diagnostics: Optional[GroupDiagnosticsArgs] = None,
dns_config: Optional[GroupDnsConfigArgs] = None,
dns_name_label: Optional[str] = None,
dns_name_label_reuse_policy: Optional[str] = None,
exposed_ports: Optional[Sequence[GroupExposedPortArgs]] = None,
identity: Optional[GroupIdentityArgs] = None,
image_registry_credentials: Optional[Sequence[GroupImageRegistryCredentialArgs]] = None,
init_containers: Optional[Sequence[GroupInitContainerArgs]] = None,
ip_address_type: Optional[str] = None,
key_vault_key_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
network_profile_id: Optional[str] = None,
os_type: Optional[str] = None,
resource_group_name: Optional[str] = None,
restart_policy: Optional[str] = None,
subnet_ids: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
zones: Optional[Sequence[str]] = None)
@overload
def Group(resource_name: str,
args: GroupArgs,
opts: Optional[ResourceOptions] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
type: azure:containerservice:Group
properties: # The arguments to resource properties.
options: # 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.
- resource_name str
- The unique name of the resource.
- args GroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args GroupArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
The Group resource accepts the following input properties:
- Containers
List<Group
Container Args> 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 string The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- Resource
Group stringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- Diagnostics
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- Dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- Dns
Name stringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- Dns
Name stringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- Exposed
Ports List<GroupExposed Port Args> Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- Identity
Group
Identity Args An
identity
block as defined below.- Image
Registry List<GroupCredentials Image Registry Credential Args> An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- Init
Containers List<GroupInit Container Args> The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- Ip
Address stringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- Key
Vault stringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- Network
Profile stringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- Restart
Policy string Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- Subnet
Ids string The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Zones List<string>
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- Containers
[]Group
Container Args 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 string The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- Resource
Group stringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- Diagnostics
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- Dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- Dns
Name stringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- Dns
Name stringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- Exposed
Ports []GroupExposed Port Args Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- Identity
Group
Identity Args An
identity
block as defined below.- Image
Registry []GroupCredentials Image Registry Credential Args An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- Init
Containers []GroupInit Container Args The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- Ip
Address stringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- Key
Vault stringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- Network
Profile stringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- Restart
Policy string Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- Subnet
Ids string The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- map[string]string
A mapping of tags to assign to the resource.
- Zones []string
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers
List<Group
Container Args> 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 String The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource
Group StringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- diagnostics
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns
Name StringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns
Name StringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed
Ports List<GroupExposed Port Args> Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- identity
Group
Identity Args An
identity
block as defined below.- image
Registry List<GroupCredentials Image Registry Credential Args> An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init
Containers List<GroupInit Container Args> The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip
Address StringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key
Vault StringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- network
Profile StringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- restart
Policy String Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet
Ids String The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Map<String,String>
A mapping of tags to assign to the resource.
- zones List<String>
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers
Group
Container Args[] 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 string The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource
Group stringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- diagnostics
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns
Name stringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns
Name stringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed
Ports GroupExposed Port Args[] Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- identity
Group
Identity Args An
identity
block as defined below.- image
Registry GroupCredentials Image Registry Credential Args[] An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init
Containers GroupInit Container Args[] The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip
Address stringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key
Vault stringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- network
Profile stringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- restart
Policy string Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet
Ids string The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- zones string[]
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers
Sequence[Group
Container Args] 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
andWindows
. Changing this forces a new resource to be created.- resource_
group_ strname The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- diagnostics
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns_
config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns_
name_ strlabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns_
name_ strlabel_ reuse_ policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed_
ports Sequence[GroupExposed Port Args] Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- identity
Group
Identity Args An
identity
block as defined below.- image_
registry_ Sequence[Groupcredentials Image Registry Credential Args] An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init_
containers Sequence[GroupInit Container Args] The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip_
address_ strtype Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key_
vault_ strkey_ id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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_ strid the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- restart_
policy str Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet_
ids str The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- zones Sequence[str]
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers List<Property Map>
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 String The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource
Group StringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- diagnostics Property Map
A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns
Config Property Map A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns
Name StringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns
Name StringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed
Ports List<Property Map> Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- identity Property Map
An
identity
block as defined below.- image
Registry List<Property Map>Credentials An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init
Containers List<Property Map> The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip
Address StringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key
Vault StringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- network
Profile StringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- restart
Policy String Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet
Ids String The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Map<String>
A mapping of tags to assign to the resource.
- zones List<String>
A list of Availability Zones in which this Container Group is located. 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 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 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
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
containers: Optional[Sequence[GroupContainerArgs]] = None,
diagnostics: Optional[GroupDiagnosticsArgs] = None,
dns_config: Optional[GroupDnsConfigArgs] = None,
dns_name_label: Optional[str] = None,
dns_name_label_reuse_policy: Optional[str] = None,
exposed_ports: Optional[Sequence[GroupExposedPortArgs]] = None,
fqdn: Optional[str] = None,
identity: Optional[GroupIdentityArgs] = None,
image_registry_credentials: Optional[Sequence[GroupImageRegistryCredentialArgs]] = None,
init_containers: Optional[Sequence[GroupInitContainerArgs]] = None,
ip_address: Optional[str] = None,
ip_address_type: Optional[str] = None,
key_vault_key_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
network_profile_id: Optional[str] = None,
os_type: Optional[str] = None,
resource_group_name: Optional[str] = None,
restart_policy: Optional[str] = None,
subnet_ids: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
zones: Optional[Sequence[str]] = None) -> Group
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)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Containers
List<Group
Container Args> 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
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- Dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- Dns
Name stringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- Dns
Name stringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- Exposed
Ports List<GroupExposed Port Args> Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- Fqdn string
The FQDN of the container group derived from
dns_name_label
.- Identity
Group
Identity Args An
identity
block as defined below.- Image
Registry List<GroupCredentials Image Registry Credential Args> An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- Init
Containers List<GroupInit Container Args> The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- Ip
Address string The IP address allocated to the container group.
- Ip
Address stringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- Key
Vault stringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- Network
Profile stringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- Os
Type string The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- Resource
Group stringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- Restart
Policy string Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- Subnet
Ids string The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Zones List<string>
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- Containers
[]Group
Container Args 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
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- Dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- Dns
Name stringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- Dns
Name stringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- Exposed
Ports []GroupExposed Port Args Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- Fqdn string
The FQDN of the container group derived from
dns_name_label
.- Identity
Group
Identity Args An
identity
block as defined below.- Image
Registry []GroupCredentials Image Registry Credential Args An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- Init
Containers []GroupInit Container Args The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- Ip
Address string The IP address allocated to the container group.
- Ip
Address stringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- Key
Vault stringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- Network
Profile stringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- Os
Type string The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- Resource
Group stringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- Restart
Policy string Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- Subnet
Ids string The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- map[string]string
A mapping of tags to assign to the resource.
- Zones []string
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers
List<Group
Container Args> 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
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns
Name StringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns
Name StringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed
Ports List<GroupExposed Port Args> Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- fqdn String
The FQDN of the container group derived from
dns_name_label
.- identity
Group
Identity Args An
identity
block as defined below.- image
Registry List<GroupCredentials Image Registry Credential Args> An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init
Containers List<GroupInit Container Args> The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip
Address String The IP address allocated to the container group.
- ip
Address StringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key
Vault StringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- network
Profile StringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- os
Type String The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource
Group StringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- restart
Policy String Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet
Ids String The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Map<String,String>
A mapping of tags to assign to the resource.
- zones List<String>
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers
Group
Container Args[] 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
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns
Config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns
Name stringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns
Name stringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed
Ports GroupExposed Port Args[] Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- fqdn string
The FQDN of the container group derived from
dns_name_label
.- identity
Group
Identity Args An
identity
block as defined below.- image
Registry GroupCredentials Image Registry Credential Args[] An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init
Containers GroupInit Container Args[] The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip
Address string The IP address allocated to the container group.
- ip
Address stringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key
Vault stringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- network
Profile stringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- os
Type string The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource
Group stringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- restart
Policy string Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet
Ids string The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- zones string[]
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers
Sequence[Group
Container Args] 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
Group
Diagnostics Args A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns_
config GroupDns Config Args A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns_
name_ strlabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns_
name_ strlabel_ reuse_ policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed_
ports Sequence[GroupExposed Port Args] Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- fqdn str
The FQDN of the container group derived from
dns_name_label
.- identity
Group
Identity Args An
identity
block as defined below.- image_
registry_ Sequence[Groupcredentials Image Registry Credential Args] An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init_
containers Sequence[GroupInit Container Args] The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip_
address str The IP address allocated to the container group.
- ip_
address_ strtype Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key_
vault_ strkey_ id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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_ strid the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- os_
type str The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource_
group_ strname 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 toAlways
. Changing this forces a new resource to be created.- subnet_
ids str The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- zones Sequence[str]
A list of Availability Zones in which this Container Group is located. Changing this forces a new resource to be created.
- containers List<Property Map>
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 Property Map
A
diagnostics
block as documented below. Changing this forces a new resource to be created.- dns
Config Property Map A
dns_config
block as documented below. Changing this forces a new resource to be created.- dns
Name StringLabel The DNS label/name for the container group's IP. Changing this forces a new resource to be created.
- dns
Name StringLabel Reuse Policy The value representing the security enum.
Noreuse
,ResourceGroupReuse
,SubscriptionReuse
,TenantReuse
orUnsecure
. Defaults toUnsecure
.- exposed
Ports List<Property Map> Zero or more
exposed_port
blocks as defined below. Changing this forces a new resource to be created.- fqdn String
The FQDN of the container group derived from
dns_name_label
.- identity Property Map
An
identity
block as defined below.- image
Registry List<Property Map>Credentials An
image_registry_credential
block as documented below. Changing this forces a new resource to be created.- init
Containers List<Property Map> The definition of an init container that is part of the group as documented in the
init_container
block below. Changing this forces a new resource to be created.- ip
Address String The IP address allocated to the container group.
- ip
Address StringType Specifies the IP address type of the container.
Public
,Private
orNone
. Changing this forces a new resource to be created. If set toPrivate
,subnet_ids
also needs to be set.- key
Vault StringKey Id The Key Vault key URI for CMK encryption. Changing this forces a new resource to be created.
- 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.
- network
Profile StringId the 'network_profile_id' has been removed from the latest versions of the container instance API and has been deprecated. It no longer functions and will be removed from the 4.0 AzureRM provider. Please use the 'subnet_ids' field instead
- os
Type String The OS for the container group. Allowed values are
Linux
andWindows
. Changing this forces a new resource to be created.- resource
Group StringName The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.
- restart
Policy String Restart policy for the container group. Allowed values are
Always
,Never
,OnFailure
. Defaults toAlways
. Changing this forces a new resource to be created.- subnet
Ids String The subnet resource IDs for a container group. Changing this forces a new resource to be created.
- Map<String>
A mapping of tags to assign to the resource.
- zones List<String>
A list of Availability Zones in which this Container Group is located. 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. 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.
- Cpu
Limit double The upper limit of the number of CPU cores of the containers.
- Environment
Variables 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
Group
Container Gpu A
gpu
block as defined below. Changing this forces a new resource to be created.- Gpu
Limit GroupContainer Gpu Limit A
gpu_limit
block as defined below.- Liveness
Probe GroupContainer Liveness Probe 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.- Memory
Limit double The the upper limit of the memory of the containers in GB.
- Ports
List<Group
Container Port> 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.- Readiness
Probe GroupContainer Readiness Probe 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.- Secure
Environment Dictionary<string, string>Variables 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<Group
Container Volume> 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. 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.
- Cpu
Limit float64 The upper limit of the number of CPU cores of the containers.
- Environment
Variables 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
Group
Container Gpu A
gpu
block as defined below. Changing this forces a new resource to be created.- Gpu
Limit GroupContainer Gpu Limit A
gpu_limit
block as defined below.- Liveness
Probe GroupContainer Liveness Probe 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.- Memory
Limit float64 The the upper limit of the memory of the containers in GB.
- Ports
[]Group
Container Port 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.- Readiness
Probe GroupContainer Readiness Probe 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.- Secure
Environment map[string]stringVariables 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
[]Group
Container Volume 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 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. 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.
- cpu
Limit Double The upper limit of the number of CPU cores of the containers.
- environment
Variables 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
Group
Container Gpu A
gpu
block as defined below. Changing this forces a new resource to be created.- gpu
Limit GroupContainer Gpu Limit A
gpu_limit
block as defined below.- liveness
Probe GroupContainer Liveness Probe 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.- memory
Limit Double The the upper limit of the memory of the containers in GB.
- ports
List<Group
Container Port> 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.- readiness
Probe GroupContainer Readiness Probe 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.- secure
Environment Map<String,String>Variables 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<Group
Container Volume> 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. 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.
- cpu
Limit number The upper limit of the number of CPU cores of the containers.
- environment
Variables {[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
Group
Container Gpu A
gpu
block as defined below. Changing this forces a new resource to be created.- gpu
Limit GroupContainer Gpu Limit A
gpu_limit
block as defined below.- liveness
Probe GroupContainer Liveness Probe 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.- memory
Limit number The the upper limit of the memory of the containers in GB.
- ports
Group
Container Port[] 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.- readiness
Probe GroupContainer Readiness Probe 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.- secure
Environment {[key: string]: string}Variables 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
Group
Container Volume[] 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. Changing this forces a new resource to be created.
- commands Sequence[str]
A list of commands which should be run on the container. Changing this forces a new resource to be created.
- cpu_
limit float The upper limit of the number of CPU cores of the containers.
- environment_
variables Mapping[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
Group
Container Gpu A
gpu
block as defined below. Changing this forces a new resource to be created.- gpu_
limit GroupContainer Gpu Limit A
gpu_limit
block as defined below.- liveness_
probe GroupContainer Liveness Probe 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.- memory_
limit float The the upper limit of the memory of the containers in GB.
- ports
Sequence[Group
Container Port] 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.- readiness_
probe GroupContainer Readiness Probe 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.- secure_
environment_ Mapping[str, str]variables 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
Sequence[Group
Container Volume] 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. 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.
- cpu
Limit Number The upper limit of the number of CPU cores of the containers.
- environment
Variables Map<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 Property Map
A
gpu
block as defined below. Changing this forces a new resource to be created.- gpu
Limit Property Map A
gpu_limit
block as defined below.- liveness
Probe Property Map 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.- memory
Limit Number The the upper limit of the memory of the containers in GB.
- ports List<Property Map>
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.- readiness
Probe Property Map 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.- secure
Environment Map<String>Variables 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<Property Map>
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
GroupContainerGpuLimit
GroupContainerLivenessProbe
- Execs List<string>
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- Failure
Threshold 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 is1
. Changing this forces a new resource to be created.- Http
Gets List<GroupContainer Liveness Probe Http Get> The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- Initial
Delay intSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- Period
Seconds int How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- Success
Threshold int Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- Timeout
Seconds int Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. 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.
- Failure
Threshold 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 is1
. Changing this forces a new resource to be created.- Http
Gets []GroupContainer Liveness Probe Http Get The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- Initial
Delay intSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- Period
Seconds int How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- Success
Threshold int Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- Timeout
Seconds int Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
- execs List<String>
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- failure
Threshold Integer 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 is1
. Changing this forces a new resource to be created.- http
Gets List<GroupContainer Liveness Probe Http Get> The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial
Delay IntegerSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period
Seconds Integer How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success
Threshold Integer Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout
Seconds Integer Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. 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.
- failure
Threshold 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 is1
. Changing this forces a new resource to be created.- http
Gets GroupContainer Liveness Probe Http Get[] The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial
Delay numberSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period
Seconds number How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success
Threshold number Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout
Seconds number Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
- execs Sequence[str]
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- failure_
threshold 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 is1
. Changing this forces a new resource to be created.- http_
gets Sequence[GroupContainer Liveness Probe Http Get] The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial_
delay_ intseconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period_
seconds int How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success_
threshold int Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout_
seconds int Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
- execs List<String>
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- failure
Threshold 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 is1
. Changing this forces a new resource to be created.- http
Gets List<Property Map> The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial
Delay NumberSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period
Seconds Number How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success
Threshold Number Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout
Seconds Number Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
GroupContainerLivenessProbeHttpGet
- Http
Headers Dictionary<string, string> A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- Scheme string
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- Http
Headers map[string]string A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- Scheme string
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http
Headers Map<String,String> A map of HTTP headers used to access on the container. 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 Integer
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme String
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http
Headers {[key: string]: string} A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme string
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http_
headers Mapping[str, str] A map of HTTP headers used to access on the container. 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 int
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme str
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http
Headers Map<String> A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme String
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
GroupContainerPort
GroupContainerReadinessProbe
- Execs List<string>
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- Failure
Threshold 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 is1
. Changing this forces a new resource to be created.- Http
Gets List<GroupContainer Readiness Probe Http Get> The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- Initial
Delay intSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- Period
Seconds int How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- Success
Threshold int Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- Timeout
Seconds int Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. 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.
- Failure
Threshold 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 is1
. Changing this forces a new resource to be created.- Http
Gets []GroupContainer Readiness Probe Http Get The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- Initial
Delay intSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- Period
Seconds int How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- Success
Threshold int Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- Timeout
Seconds int Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
- execs List<String>
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- failure
Threshold Integer 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 is1
. Changing this forces a new resource to be created.- http
Gets List<GroupContainer Readiness Probe Http Get> The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial
Delay IntegerSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period
Seconds Integer How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success
Threshold Integer Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout
Seconds Integer Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. 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.
- failure
Threshold 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 is1
. Changing this forces a new resource to be created.- http
Gets GroupContainer Readiness Probe Http Get[] The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial
Delay numberSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period
Seconds number How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success
Threshold number Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout
Seconds number Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
- execs Sequence[str]
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- failure_
threshold 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 is1
. Changing this forces a new resource to be created.- http_
gets Sequence[GroupContainer Readiness Probe Http Get] The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial_
delay_ intseconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period_
seconds int How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success_
threshold int Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout_
seconds int Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
- execs List<String>
Commands to be run to validate container readiness. Changing this forces a new resource to be created.
- failure
Threshold 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 is1
. Changing this forces a new resource to be created.- http
Gets List<Property Map> The definition of the http_get for this container as documented in the
http_get
block below. Changing this forces a new resource to be created.- initial
Delay NumberSeconds Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.
- period
Seconds Number How often (in seconds) to perform the probe. The default value is
10
and the minimum value is1
. Changing this forces a new resource to be created.- success
Threshold Number Minimum consecutive successes for the probe to be considered successful after having failed. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.- timeout
Seconds Number Number of seconds after which the probe times out. The default value is
1
and the minimum value is1
. Changing this forces a new resource to be created.
GroupContainerReadinessProbeHttpGet
- Http
Headers Dictionary<string, string> A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- Scheme string
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- Http
Headers map[string]string A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- Scheme string
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http
Headers Map<String,String> A map of HTTP headers used to access on the container. 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 Integer
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme String
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http
Headers {[key: string]: string} A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme string
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http_
headers Mapping[str, str] A map of HTTP headers used to access on the container. 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 int
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme str
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
- http
Headers Map<String> A map of HTTP headers used to access on the container. 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
Number of the port to access on the container. Changing this forces a new resource to be created.
- scheme String
Scheme to use for connecting to the host. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.
GroupContainerVolume
- Mount
Path string The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- Name string
The name of the volume mount. Changing this forces a new resource to be created.
- Empty
Dir bool Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- Git
Repo GroupContainer Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- Read
Only 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.- Secret Dictionary<string, string>
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- Storage
Account stringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- Storage
Account stringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- Mount
Path string The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- Name string
The name of the volume mount. Changing this forces a new resource to be created.
- Empty
Dir bool Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- Git
Repo GroupContainer Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- Read
Only 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.- Secret map[string]string
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- Storage
Account stringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- Storage
Account stringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount
Path String The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name String
The name of the volume mount. Changing this forces a new resource to be created.
- empty
Dir Boolean Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git
Repo GroupContainer Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- read
Only 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.- secret Map<String,String>
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- storage
Account StringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage
Account StringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount
Path string The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name string
The name of the volume mount. Changing this forces a new resource to be created.
- empty
Dir boolean Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git
Repo GroupContainer Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- read
Only 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.- secret {[key: string]: string}
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- storage
Account stringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage
Account stringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount_
path str The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name str
The name of the volume mount. Changing this forces a new resource to be created.
- empty_
dir bool Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git_
repo GroupContainer Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- read_
only 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.- secret Mapping[str, str]
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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_ strkey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage_
account_ strname The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount
Path String The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name String
The name of the volume mount. Changing this forces a new resource to be created.
- empty
Dir Boolean Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git
Repo Property Map A
git_repo
block as defined below. Changing this forces a new resource to be created.- read
Only 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.- secret Map<String>
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- storage
Account StringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage
Account StringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
GroupContainerVolumeGitRepo
- Url string
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- Directory string
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- Revision string
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- Url string
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- Directory string
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- Revision string
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url String
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory String
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision String
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url string
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory string
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision string
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url str
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory str
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision str
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url String
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory String
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision String
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
GroupDiagnostics
- Log
Analytics GroupDiagnostics Log Analytics A
log_analytics
block as defined below. Changing this forces a new resource to be created.
- Log
Analytics GroupDiagnostics Log Analytics A
log_analytics
block as defined below. Changing this forces a new resource to be created.
- log
Analytics GroupDiagnostics Log Analytics A
log_analytics
block as defined below. Changing this forces a new resource to be created.
- log
Analytics GroupDiagnostics Log Analytics A
log_analytics
block as defined below. Changing this forces a new resource to be created.
- log_
analytics GroupDiagnostics Log Analytics A
log_analytics
block as defined below. Changing this forces a new resource to be created.
- log
Analytics Property Map A
log_analytics
block as defined below. Changing this forces a new resource to be created.
GroupDiagnosticsLogAnalytics
- Workspace
Id string The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
- Workspace
Key string The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
- Log
Type string The log type which should be used. Possible values are
ContainerInsights
andContainerInstanceLogs
. 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.
- Workspace
Id string The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
- Workspace
Key string The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
- Log
Type string The log type which should be used. Possible values are
ContainerInsights
andContainerInstanceLogs
. 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.
- workspace
Id String The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
- workspace
Key String The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
- log
Type String The log type which should be used. Possible values are
ContainerInsights
andContainerInstanceLogs
. 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.
- workspace
Id string The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
- workspace
Key string The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
- log
Type string The log type which should be used. Possible values are
ContainerInsights
andContainerInstanceLogs
. 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.
- workspace_
id str The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
- workspace_
key str The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
- log_
type str The log type which should be used. Possible values are
ContainerInsights
andContainerInstanceLogs
. Changing this forces a new resource to be created.- metadata Mapping[str, str]
Any metadata required for Log Analytics. Changing this forces a new resource to be created.
- workspace
Id String The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.
- workspace
Key String The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.
- log
Type String The log type which should be used. Possible values are
ContainerInsights
andContainerInstanceLogs
. Changing this forces a new resource to be created.- metadata Map<String>
Any metadata required for Log Analytics. Changing this forces a new resource to be created.
GroupDnsConfig
- Nameservers List<string>
A list of nameservers the containers will search out to resolve requests. Changing this forces a new resource to be created.
- Options List<string>
A list of resolver configuration options. Changing this forces a new resource to be created.
- Search
Domains List<string> A list of search domains that DNS requests will search along. Changing this forces a new resource to be created.
- Nameservers []string
A list of nameservers the containers will search out to resolve requests. Changing this forces a new resource to be created.
- Options []string
A list of resolver configuration options. Changing this forces a new resource to be created.
- Search
Domains []string A list of search domains that DNS requests will search along. Changing this forces a new resource to be created.
- nameservers List<String>
A list of nameservers the containers will search out to resolve requests. Changing this forces a new resource to be created.
- options List<String>
A list of resolver configuration options. Changing this forces a new resource to be created.
- search
Domains List<String> A list of search domains that DNS requests will search along. Changing this forces a new resource to be created.
- nameservers string[]
A list of nameservers the containers will search out to resolve requests. Changing this forces a new resource to be created.
- options string[]
A list of resolver configuration options. Changing this forces a new resource to be created.
- search
Domains string[] A list of search domains that DNS requests will search along. Changing this forces a new resource to be created.
- nameservers Sequence[str]
A list of nameservers the containers will search out to resolve requests. Changing this forces a new resource to be created.
- options Sequence[str]
A list of resolver configuration options. Changing this forces a new resource to be created.
- search_
domains Sequence[str] A list of search domains that DNS requests will search along. Changing this forces a new resource to be created.
- nameservers List<String>
A list of nameservers the containers will search out to resolve requests. Changing this forces a new resource to be created.
- options List<String>
A list of resolver configuration options. Changing this forces a new resource to be created.
- search
Domains List<String> A list of search domains that DNS requests will search along. Changing this forces a new resource to be created.
GroupExposedPort
GroupIdentity
- Type string
Specifies the type of Managed Service Identity that should be configured on this Container Group. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids List<string> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Container Group.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- Type string
Specifies the type of Managed Service Identity that should be configured on this Container Group. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids []string Specifies a list of User Assigned Managed Identity IDs to be assigned to this Container Group.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Container Group. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Container Group.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
- type string
Specifies the type of Managed Service Identity that should be configured on this Container Group. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids string[] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Container Group.
- principal
Id string The Principal ID associated with this Managed Service Identity.
- tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type str
Specifies the type of Managed Service Identity that should be configured on this Container Group. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity_
ids Sequence[str] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Container Group.
- principal_
id str The Principal ID associated with this Managed Service Identity.
- tenant_
id str The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Container Group. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Container Group.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
GroupImageRegistryCredential
- 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.
- Password string
The password with which to connect to the registry. Changing this forces a new resource to be created.
- User
Assigned stringIdentity Id The identity ID for the private registry. 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.
- 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.
- Password string
The password with which to connect to the registry. Changing this forces a new resource to be created.
- User
Assigned stringIdentity Id The identity ID for the private registry. 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.
- 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.
- password String
The password with which to connect to the registry. Changing this forces a new resource to be created.
- user
Assigned StringIdentity Id The identity ID for the private registry. 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.
- 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.
- password string
The password with which to connect to the registry. Changing this forces a new resource to be created.
- user
Assigned stringIdentity Id The identity ID for the private registry. 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.
- 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.
- password str
The password with which to connect to the registry. Changing this forces a new resource to be created.
- user_
assigned_ stridentity_ id The identity ID for the private registry. 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.
- 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.
- password String
The password with which to connect to the registry. Changing this forces a new resource to be created.
- user
Assigned StringIdentity Id The identity ID for the private registry. 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.
GroupInitContainer
- Image string
The container image name. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Container. 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.
- Environment
Variables 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.
- Secure
Environment Dictionary<string, string>Variables 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<Group
Init Container Volume> 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.
- Image string
The container image name. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Container. 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.
- Environment
Variables 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.
- Secure
Environment map[string]stringVariables 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
[]Group
Init Container Volume 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.
- image String
The container image name. Changing this forces a new resource to be created.
- name String
Specifies the name of the Container. 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.
- environment
Variables 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.
- secure
Environment Map<String,String>Variables 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<Group
Init Container Volume> 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.
- image string
The container image name. Changing this forces a new resource to be created.
- name string
Specifies the name of the Container. 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.
- environment
Variables {[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.
- secure
Environment {[key: string]: string}Variables 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
Group
Init Container Volume[] 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.
- image str
The container image name. Changing this forces a new resource to be created.
- name str
Specifies the name of the Container. Changing this forces a new resource to be created.
- commands Sequence[str]
A list of commands which should be run on the container. Changing this forces a new resource to be created.
- environment_
variables Mapping[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.
- secure_
environment_ Mapping[str, str]variables 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
Sequence[Group
Init Container Volume] 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.
- image String
The container image name. Changing this forces a new resource to be created.
- name String
Specifies the name of the Container. 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.
- environment
Variables Map<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.
- secure
Environment Map<String>Variables 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<Property Map>
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.
GroupInitContainerVolume
- Mount
Path string The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- Name string
The name of the volume mount. Changing this forces a new resource to be created.
- Empty
Dir bool Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- Git
Repo GroupInit Container Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- Read
Only 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.- Secret Dictionary<string, string>
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- Storage
Account stringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- Storage
Account stringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- Mount
Path string The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- Name string
The name of the volume mount. Changing this forces a new resource to be created.
- Empty
Dir bool Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- Git
Repo GroupInit Container Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- Read
Only 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.- Secret map[string]string
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- Storage
Account stringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- Storage
Account stringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount
Path String The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name String
The name of the volume mount. Changing this forces a new resource to be created.
- empty
Dir Boolean Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git
Repo GroupInit Container Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- read
Only 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.- secret Map<String,String>
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- storage
Account StringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage
Account StringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount
Path string The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name string
The name of the volume mount. Changing this forces a new resource to be created.
- empty
Dir boolean Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git
Repo GroupInit Container Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- read
Only 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.- secret {[key: string]: string}
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- storage
Account stringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage
Account stringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount_
path str The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name str
The name of the volume mount. Changing this forces a new resource to be created.
- empty_
dir bool Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git_
repo GroupInit Container Volume Git Repo A
git_repo
block as defined below. Changing this forces a new resource to be created.- read_
only 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.- secret Mapping[str, str]
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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_ strkey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage_
account_ strname The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
- mount
Path String The path on which this volume is to be mounted. Changing this forces a new resource to be created.
- name String
The name of the volume mount. Changing this forces a new resource to be created.
- empty
Dir Boolean Boolean as to whether the mounted volume should be an empty directory. Defaults to
false
. Changing this forces a new resource to be created.- git
Repo Property Map A
git_repo
block as defined below. Changing this forces a new resource to be created.- read
Only 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.- secret Map<String>
A map of secrets that will be mounted as files in the volume. Changing this forces a new resource to be created.
- 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.
- storage
Account StringKey The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.
- storage
Account StringName The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.
GroupInitContainerVolumeGitRepo
- Url string
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- Directory string
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- Revision string
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- Url string
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- Directory string
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- Revision string
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url String
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory String
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision String
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url string
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory string
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision string
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url str
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory str
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision str
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
- url String
Specifies the Git repository to be cloned. Changing this forces a new resource to be created.
- directory String
Specifies the directory into which the repository should be cloned. Changing this forces a new resource to be created.
- revision String
Specifies the commit hash of the revision to be cloned. If unspecified, the HEAD revision is cloned. Changing this forces a new resource to be created.
Import
Container Group’s can be imported using the resource id
, e.g.
$ pulumi import azure:containerservice/group:Group containerGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ContainerInstance/containerGroups/myContainerGroup1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.