Class Group

Manages as an Azure Container Group instance.

Inheritance

System.Object

Resource

CustomResource

Group

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ContainerService

Assembly: Pulumi.Azure.dll

Syntax

public class Group : CustomResource

Constructors

Group(String, GroupArgs, CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Containers

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.

Declaration

public Output<ImmutableArray<GroupContainer>> Containers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GroupContainer>>

Diagnostics

A diagnostics block as documented below.

Declaration

public Output<GroupDiagnostics> Diagnostics { get; }

Property Value

Type	Description
Output<GroupDiagnostics>

DnsNameLabel

The DNS label/name for the container groups IP. Changing this forces a new resource to be created.

Declaration

public Output<string> DnsNameLabel { get; }

Property Value

Type	Description
Output<System.String>

Fqdn

The FQDN of the container group derived from dns_name_label.

Declaration

public Output<string> Fqdn { get; }

Property Value

Type	Description
Output<System.String>

Identity

An identity block as defined below.

Declaration

public Output<GroupIdentity> Identity { get; }

Property Value

Type	Description
Output<GroupIdentity>

ImageRegistryCredentials

A image_registry_credential block as documented below. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableArray<GroupImageRegistryCredential>> ImageRegistryCredentials { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GroupImageRegistryCredential>>

IpAddress

The IP address allocated to the container group.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

IpAddressType

Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.

Declaration

public Output<string> IpAddressType { get; }

Property Value

Type	Description
Output<System.String>

Location

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

Specifies the name of the Container Group. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NetworkProfileId

Network profile ID for deploying to virtual network.

Declaration

public Output<string> NetworkProfileId { get; }

Property Value

Type	Description
Output<System.String>

OsType

The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.

Declaration

public Output<string> OsType { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

RestartPolicy

Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.

Declaration

public Output<string> RestartPolicy { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, GroupState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Group