ContainerGroup Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A container group.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.ContainerGroupTypeConverter))]
public class ContainerGroup : Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.IContainerGroup, Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.ContainerGroupTypeConverter))>]
type ContainerGroup = class
interface IContainerGroup
interface IJsonSerializable
interface IResource
interface IContainerGroupProperties
interface IValidates
Public Class ContainerGroup
Implements IContainerGroup, IValidates
- Inheritance
-
ContainerGroup
- Attributes
- Implements
Constructors
ContainerGroup() |
Creates an new ContainerGroup instance. |
Properties
ConfidentialComputeProperty |
The properties for confidential container group |
ConfidentialComputePropertyCcePolicy |
The base64 encoded confidential compute enforcement policy |
Container |
The containers within the container group. |
Diagnostic |
The diagnostic information for a container group. |
DiagnosticLogAnalytic |
Container group log analytics information. |
DnsConfig |
The DNS config information for a container group. |
DnsConfigNameServer |
The DNS servers for the container group. |
DnsConfigOption |
The DNS options for the container group. |
DnsConfigSearchDomain |
The DNS search domains for hostname lookup in the container group. |
EncryptionProperty |
The encryption properties for a container group. |
EncryptionPropertyIdentity |
The keyvault managed identity. |
EncryptionPropertyKeyName |
The encryption key name. |
EncryptionPropertyKeyVersion |
The encryption key version. |
EncryptionPropertyVaultBaseUrl |
The keyvault base url. |
Extension |
extensions used by virtual kubelet |
Id |
The resource id. |
Identity |
The identity of the container group, if configured. |
IdentityPrincipalId |
The principal id of the container group identity. This property will only be provided for a system assigned identity. |
IdentityTenantId |
The tenant id associated with the container group. This property will only be provided for a system assigned identity. |
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. |
IdentityUserAssignedIdentity |
The list of user identities associated with the container group. |
ImageRegistryCredentials |
The image registry credentials by which the container group is created from. |
InitContainer |
The init containers for a container group. |
InstanceView |
The instance view of the container group. Only valid in response. |
InstanceViewEvent |
The events of this container group. |
InstanceViewState |
The state of the container group. Only valid in response. |
IPAddress |
The IP address type of the container group. |
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. |
IPAddressDnsNameLabel |
The Dns name label for the IP. |
IPAddressFqdn |
The FQDN for the IP. |
IPAddressIP |
The IP exposed to the public internet. |
IPAddressPort |
The list of ports exposed on the container group. |
IPAddressType |
Specifies if the IP is exposed to the public internet or private VNET. |
IsCreatedFromStandbyPool |
The flag indicating whether the container group is created by standby pool. |
Location |
The resource location. |
LogAnalyticLogType |
The log type to be used. |
LogAnalyticMetadata |
Metadata for log analytics. |
LogAnalyticWorkspaceId |
The workspace id for log analytics |
LogAnalyticWorkspaceKey |
The workspace key for log analytics |
LogAnalyticWorkspaceResourceId |
The workspace resource id for log analytics |
Name |
The resource name. |
OSType |
The operating system type required by the containers in the container group. |
Priority |
The priority of the container group. |
Profile |
The reference container group profile properties. |
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}'. |
ProfileRevision |
The container group profile reference revision. |
Property |
The container group properties |
ProvisioningState |
The provisioning state of the container group. This only appears in the response. |
ResourceGroupName |
Gets the resource group name |
RestartPolicy |
Restart policy for all containers within the container group.
|
Sku |
The SKU for a container group. |
StandbyPoolProfile |
The reference standby pool profile properties. |
StandbyPoolProfileFailContainerGroupCreateOnReuseFailure |
The flag to determine whether ACI should fail the create request if the container group can not be obtained from standby pool. |
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}'. |
SubnetId |
The subnet resource IDs for a container group. |
Tag |
The resource tags. |
Type |
The resource type. |
Volume |
The list of volumes that can be mounted by containers in this container group. |
Zone |
The zones for the container group. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ContainerGroup. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ContainerGroup. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.Api20240501Preview.IContainerGroup. |
FromJsonString(String) |
Creates a new instance of ContainerGroup, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of ContainerGroup into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() | |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |