Share via


IContainerGroup Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.ContainerGroupTypeConverter))]
public interface IContainerGroup : Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.IContainerGroupProperties, Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.IResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.ContainerGroupTypeConverter))>]
type IContainerGroup = interface
    interface IJsonSerializable
    interface IResource
    interface IContainerGroupProperties
Public Interface IContainerGroup
Implements IContainerGroupProperties, IResource
Derived
Attributes
Implements

Properties

ConfidentialComputePropertyCcePolicy

The base64 encoded confidential compute enforcement policy

(Inherited from IContainerGroupProperties)
Container

The containers within the container group.

(Inherited from IContainerGroupProperties)
DnsConfigNameServer

The DNS servers for the container group.

(Inherited from IContainerGroupProperties)
DnsConfigOption

The DNS options for the container group.

(Inherited from IContainerGroupProperties)
DnsConfigSearchDomain

The DNS search domains for hostname lookup in the container group.

(Inherited from IContainerGroupProperties)
EncryptionPropertyIdentity

The keyvault managed identity.

(Inherited from IContainerGroupProperties)
EncryptionPropertyKeyName

The encryption key name.

(Inherited from IContainerGroupProperties)
EncryptionPropertyKeyVersion

The encryption key version.

(Inherited from IContainerGroupProperties)
EncryptionPropertyVaultBaseUrl

The keyvault base url.

(Inherited from IContainerGroupProperties)
Extension

extensions used by virtual kubelet

(Inherited from IContainerGroupProperties)
Id

The resource id.

(Inherited from IResource)
IdentityPrincipalId

The principal id of the container group identity. This property will only be provided for a system assigned identity.

(Inherited from IContainerGroupProperties)
IdentityTenantId

The tenant id associated with the container group. This property will only be provided for a system assigned identity.

(Inherited from IContainerGroupProperties)
IdentityType

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

(Inherited from IContainerGroupProperties)
IdentityUserAssignedIdentity

The list of user identities associated with the container group.

(Inherited from IContainerGroupProperties)
ImageRegistryCredentials

The image registry credentials by which the container group is created from.

(Inherited from IContainerGroupProperties)
InitContainer

The init containers for a container group.

(Inherited from IContainerGroupProperties)
InstanceViewEvent

The events of this container group.

(Inherited from IContainerGroupProperties)
InstanceViewState

The state of the container group. Only valid in response.

(Inherited from IContainerGroupProperties)
IPAddressAutoGeneratedDomainNameLabelScope

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

(Inherited from IContainerGroupProperties)
IPAddressDnsNameLabel

The Dns name label for the IP.

(Inherited from IContainerGroupProperties)
IPAddressFqdn

The FQDN for the IP.

(Inherited from IContainerGroupProperties)
IPAddressIP

The IP exposed to the public internet.

(Inherited from IContainerGroupProperties)
IPAddressPort

The list of ports exposed on the container group.

(Inherited from IContainerGroupProperties)
IPAddressType

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

(Inherited from IContainerGroupProperties)
IsCreatedFromStandbyPool

The flag indicating whether the container group is created by standby pool.

(Inherited from IContainerGroupProperties)
Location

The resource location.

(Inherited from IResource)
LogAnalyticLogType

The log type to be used.

(Inherited from IContainerGroupProperties)
LogAnalyticMetadata

Metadata for log analytics.

(Inherited from IContainerGroupProperties)
LogAnalyticWorkspaceId

The workspace id for log analytics

(Inherited from IContainerGroupProperties)
LogAnalyticWorkspaceKey

The workspace key for log analytics

(Inherited from IContainerGroupProperties)
LogAnalyticWorkspaceResourceId

The workspace resource id for log analytics

(Inherited from IContainerGroupProperties)
Name

The resource name.

(Inherited from IResource)
OSType

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

(Inherited from IContainerGroupProperties)
Priority

The priority of the container group.

(Inherited from IContainerGroupProperties)
ProfileId

The container group profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}'.

(Inherited from IContainerGroupProperties)
ProfileRevision

The container group profile reference revision.

(Inherited from IContainerGroupProperties)
ProvisioningState

The provisioning state of the container group. This only appears in the response.

(Inherited from IContainerGroupProperties)
RestartPolicy

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
(Inherited from IContainerGroupProperties)
Sku

The SKU for a container group.

(Inherited from IContainerGroupProperties)
StandbyPoolProfileFailContainerGroupCreateOnReuseFailure

The flag to determine whether ACI should fail the create request if the container group can not be obtained from standby pool.

(Inherited from IContainerGroupProperties)
StandbyPoolProfileId

The standby pool profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyPoolName}'.

(Inherited from IContainerGroupProperties)
SubnetId

The subnet resource IDs for a container group.

(Inherited from IContainerGroupProperties)
Tag

The resource tags.

(Inherited from IResource)
Type

The resource type.

(Inherited from IResource)
Volume

The list of volumes that can be mounted by containers in this container group.

(Inherited from IContainerGroupProperties)
Zone

The zones for the container group.

(Inherited from IResource)

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to