containerinstance.azure.com/v1api20211001
containerinstance.azure.com/v1api20211001
Package v1api20211001 contains API Schema definitions for the containerinstance v1api20211001 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-10-01" |
AzureFileVolume
(Appears on:Volume)
The properties of the Azure File volume. Azure File shares are mounted as volumes.
Field | Description |
---|---|
readOnly bool |
ReadOnly: The flag indicating whether the Azure File shared mounted as a volume is read-only. |
shareName string |
ShareName: The name of the Azure File share to be mounted as a volume. |
storageAccountKey string |
StorageAccountKey: The storage account access key used to access the Azure File share. |
storageAccountName string |
StorageAccountName: The name of the storage account that contains the Azure File share. |
AzureFileVolume_STATUS
(Appears on:Volume_STATUS)
The properties of the Azure File volume. Azure File shares are mounted as volumes.
Field | Description |
---|---|
readOnly bool |
ReadOnly: The flag indicating whether the Azure File shared mounted as a volume is read-only. |
shareName string |
ShareName: The name of the Azure File share to be mounted as a volume. |
storageAccountKey string |
StorageAccountKey: The storage account access key used to access the Azure File share. |
storageAccountName string |
StorageAccountName: The name of the storage account that contains the Azure File share. |
Container
(Appears on:ContainerGroup_Spec)
A container instance.
Field | Description |
---|---|
command []string |
Command: The commands to execute within the container instance in exec form. |
environmentVariables []EnvironmentVariable |
EnvironmentVariables: The environment variables to set in the container instance. |
image string |
Image: The name of the image used to create the container instance. |
livenessProbe ContainerProbe |
LivenessProbe: The liveness probe. |
name string |
Name: The user-provided name of the container instance. |
ports []ContainerPort |
Ports: The exposed ports on the container instance. |
readinessProbe ContainerProbe |
ReadinessProbe: The readiness probe. |
resources ResourceRequirements |
Resources: The resource requirements of the container instance. |
volumeMounts []VolumeMount |
VolumeMounts: The volume mounts available to the container instance. |
ContainerExec
(Appears on:ContainerProbe)
The container execution command, for liveness or readiness probe
Field | Description |
---|---|
command []string |
Command: The commands to execute within the container. |
ContainerExec_STATUS
(Appears on:ContainerProbe_STATUS)
The container execution command, for liveness or readiness probe
Field | Description |
---|---|
command []string |
Command: The commands to execute within the container. |
ContainerGroup
Generator information: - Generated from: /containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||
spec ContainerGroup_Spec |
|
||||||||||||||||||||||||||||||||||||||
status ContainerGroup_STATUS |
ContainerGroupDiagnostics
(Appears on:ContainerGroup_Spec)
Container group diagnostic information.
Field | Description |
---|---|
logAnalytics LogAnalytics |
LogAnalytics: Container group log analytics information. |
ContainerGroupDiagnostics_STATUS
(Appears on:ContainerGroup_STATUS)
Container group diagnostic information.
Field | Description |
---|---|
logAnalytics LogAnalytics_STATUS |
LogAnalytics: Container group log analytics information. |
ContainerGroupIdentity
(Appears on:ContainerGroup_Spec)
Identity for the container group.
Field | Description |
---|---|
type ContainerGroupIdentity_Type |
Type: 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. |
userAssignedIdentities []UserAssignedIdentityDetails |
UserAssignedIdentities: The list of user identities associated with the container group. |
ContainerGroupIdentity_STATUS
(Appears on:ContainerGroup_STATUS)
Identity for the container group.
Field | Description |
---|---|
principalId string |
PrincipalId: The principal id of the container group identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant id associated with the container group. This property will only be provided for a system assigned identity. |
type ContainerGroupIdentity_Type_STATUS |
Type: 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. |
userAssignedIdentities map[string]./api/containerinstance/v1api20211001.UserAssignedIdentities_STATUS |
UserAssignedIdentities: The list of user identities associated with the container group. |
ContainerGroupIdentity_Type
(string
alias)
(Appears on:ContainerGroupIdentity)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ContainerGroupIdentity_Type_STATUS
(string
alias)
(Appears on:ContainerGroupIdentity_STATUS)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ContainerGroupOperatorSpec
(Appears on:ContainerGroup_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
ContainerGroupSku
(string
alias)
(Appears on:ContainerGroup_Spec)
The container group SKU.
Value | Description |
---|---|
"Dedicated" |
|
"Standard" |
ContainerGroupSku_STATUS
(string
alias)
(Appears on:ContainerGroup_STATUS)
The container group SKU.
Value | Description |
---|---|
"Dedicated" |
|
"Standard" |
ContainerGroupSubnetId
(Appears on:ContainerGroup_Spec)
Container group subnet information.
Field | Description |
---|---|
name string |
Name: Friendly name for the subnet. |
reference genruntime.ResourceReference |
Reference: Resource ID of virtual network and subnet. |
ContainerGroupSubnetId_STATUS
(Appears on:ContainerGroup_STATUS)
Container group subnet information.
Field | Description |
---|---|
id string |
Id: Resource ID of virtual network and subnet. |
name string |
Name: Friendly name for the subnet. |
ContainerGroup_Properties_InstanceView_STATUS
(Appears on:ContainerGroup_STATUS)
Field | Description |
---|---|
events []Event_STATUS |
Events: The events of this container group. |
state string |
State: The state of the container group. Only valid in response. |
ContainerGroup_Properties_OsType_STATUS
(string
alias)
(Appears on:ContainerGroup_STATUS)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
ContainerGroup_Properties_OsType_Spec
(string
alias)
(Appears on:ContainerGroup_Spec)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
ContainerGroup_Properties_RestartPolicy_STATUS
(string
alias)
(Appears on:ContainerGroup_STATUS)
Value | Description |
---|---|
"Always" |
|
"Never" |
|
"OnFailure" |
ContainerGroup_Properties_RestartPolicy_Spec
(string
alias)
(Appears on:ContainerGroup_Spec)
Value | Description |
---|---|
"Always" |
|
"Never" |
|
"OnFailure" |
ContainerGroup_STATUS
(Appears on:ContainerGroup)
A container group.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
containers []Container_STATUS |
Containers: The containers within the container group. |
diagnostics ContainerGroupDiagnostics_STATUS |
Diagnostics: The diagnostic information for a container group. |
dnsConfig DnsConfiguration_STATUS |
DnsConfig: The DNS config information for a container group. |
encryptionProperties EncryptionProperties_STATUS |
EncryptionProperties: The encryption properties for a container group. |
id string |
Id: The resource id. |
identity ContainerGroupIdentity_STATUS |
Identity: The identity of the container group, if configured. |
imageRegistryCredentials []ImageRegistryCredential_STATUS |
ImageRegistryCredentials: The image registry credentials by which the container group is created from. |
initContainers []InitContainerDefinition_STATUS |
InitContainers: The init containers for a container group. |
instanceView ContainerGroup_Properties_InstanceView_STATUS |
InstanceView: The instance view of the container group. Only valid in response. |
ipAddress IpAddress_STATUS |
IpAddress: The IP address type of the container group. |
location string |
Location: The resource location. |
name string |
Name: The resource name. |
osType ContainerGroup_Properties_OsType_STATUS |
OsType: The operating system type required by the containers in the container group. |
provisioningState string |
ProvisioningState: The provisioning state of the container group. This only appears in the response. |
restartPolicy ContainerGroup_Properties_RestartPolicy_STATUS |
RestartPolicy: Restart policy for all containers within the container group.
- |
sku ContainerGroupSku_STATUS |
Sku: The SKU for a container group. |
subnetIds []ContainerGroupSubnetId_STATUS |
SubnetIds: The subnet resource IDs for a container group. |
tags map[string]string |
Tags: The resource tags. |
type string |
Type: The resource type. |
volumes []Volume_STATUS |
Volumes: The list of volumes that can be mounted by containers in this container group. |
zones []string |
Zones: The zones for the container group. |
ContainerGroup_Spec
(Appears on:ContainerGroup)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
containers []Container |
Containers: The containers within the container group. |
diagnostics ContainerGroupDiagnostics |
Diagnostics: The diagnostic information for a container group. |
dnsConfig DnsConfiguration |
DnsConfig: The DNS config information for a container group. |
encryptionProperties EncryptionProperties |
EncryptionProperties: The encryption properties for a container group. |
identity ContainerGroupIdentity |
Identity: The identity of the container group, if configured. |
imageRegistryCredentials []ImageRegistryCredential |
ImageRegistryCredentials: The image registry credentials by which the container group is created from. |
initContainers []InitContainerDefinition |
InitContainers: The init containers for a container group. |
ipAddress IpAddress |
IpAddress: The IP address type of the container group. |
location string |
Location: The resource location. |
operatorSpec ContainerGroupOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
osType ContainerGroup_Properties_OsType_Spec |
OsType: The operating system type required by the containers in the container group. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
restartPolicy ContainerGroup_Properties_RestartPolicy_Spec |
RestartPolicy: Restart policy for all containers within the container group.
- |
sku ContainerGroupSku |
Sku: The SKU for a container group. |
subnetIds []ContainerGroupSubnetId |
SubnetIds: The subnet resource IDs for a container group. |
tags map[string]string |
Tags: The resource tags. |
volumes []Volume |
Volumes: The list of volumes that can be mounted by containers in this container group. |
zones []string |
Zones: The zones for the container group. |
ContainerHttpGet
(Appears on:ContainerProbe)
The container Http Get settings, for liveness or readiness probe
Field | Description |
---|---|
httpHeaders []HttpHeader |
HttpHeaders: The HTTP headers. |
path string |
Path: The path to probe. |
port int |
Port: The port number to probe. |
scheme ContainerHttpGet_Scheme |
Scheme: The scheme. |
ContainerHttpGet_STATUS
(Appears on:ContainerProbe_STATUS)
The container Http Get settings, for liveness or readiness probe
Field | Description |
---|---|
httpHeaders []HttpHeader_STATUS |
HttpHeaders: The HTTP headers. |
path string |
Path: The path to probe. |
port int |
Port: The port number to probe. |
scheme ContainerHttpGet_Scheme_STATUS |
Scheme: The scheme. |
ContainerHttpGet_Scheme
(string
alias)
(Appears on:ContainerHttpGet)
Value | Description |
---|---|
"http" |
|
"https" |
ContainerHttpGet_Scheme_STATUS
(string
alias)
(Appears on:ContainerHttpGet_STATUS)
Value | Description |
---|---|
"http" |
|
"https" |
ContainerPort
(Appears on:Container)
The port exposed on the container instance.
Field | Description |
---|---|
port int |
Port: The port number exposed within the container group. |
protocol ContainerPort_Protocol |
Protocol: The protocol associated with the port. |
ContainerPort_Protocol
(string
alias)
(Appears on:ContainerPort)
Value | Description |
---|---|
"TCP" |
|
"UDP" |
ContainerPort_Protocol_STATUS
(string
alias)
(Appears on:ContainerPort_STATUS)
Value | Description |
---|---|
"TCP" |
|
"UDP" |
ContainerPort_STATUS
(Appears on:Container_STATUS)
The port exposed on the container instance.
Field | Description |
---|---|
port int |
Port: The port number exposed within the container group. |
protocol ContainerPort_Protocol_STATUS |
Protocol: The protocol associated with the port. |
ContainerProbe
(Appears on:Container)
The container probe, for liveness or readiness
Field | Description |
---|---|
exec ContainerExec |
Exec: The execution command to probe |
failureThreshold int |
FailureThreshold: The failure threshold. |
httpGet ContainerHttpGet |
HttpGet: The Http Get settings to probe |
initialDelaySeconds int |
InitialDelaySeconds: The initial delay seconds. |
periodSeconds int |
PeriodSeconds: The period seconds. |
successThreshold int |
SuccessThreshold: The success threshold. |
timeoutSeconds int |
TimeoutSeconds: The timeout seconds. |
ContainerProbe_STATUS
(Appears on:Container_STATUS)
The container probe, for liveness or readiness
Field | Description |
---|---|
exec ContainerExec_STATUS |
Exec: The execution command to probe |
failureThreshold int |
FailureThreshold: The failure threshold. |
httpGet ContainerHttpGet_STATUS |
HttpGet: The Http Get settings to probe |
initialDelaySeconds int |
InitialDelaySeconds: The initial delay seconds. |
periodSeconds int |
PeriodSeconds: The period seconds. |
successThreshold int |
SuccessThreshold: The success threshold. |
timeoutSeconds int |
TimeoutSeconds: The timeout seconds. |
ContainerProperties_InstanceView_STATUS
(Appears on:Container_STATUS)
Field | Description |
---|---|
currentState ContainerState_STATUS |
CurrentState: Current container instance state. |
events []Event_STATUS |
Events: The events of the container instance. |
previousState ContainerState_STATUS |
PreviousState: Previous container instance state. |
restartCount int |
RestartCount: The number of times that the container instance has been restarted. |
ContainerState_STATUS
(Appears on:ContainerProperties_InstanceView_STATUS, InitContainerPropertiesDefinition_InstanceView_STATUS)
The container instance state.
Field | Description |
---|---|
detailStatus string |
DetailStatus: The human-readable status of the container instance state. |
exitCode int |
ExitCode: The container instance exit codes correspond to those from the |
finishTime string |
FinishTime: The date-time when the container instance state finished. |
startTime string |
StartTime: The date-time when the container instance state started. |
state string |
State: The state of the container instance. |
Container_STATUS
(Appears on:ContainerGroup_STATUS)
A container instance.
Field | Description |
---|---|
command []string |
Command: The commands to execute within the container instance in exec form. |
environmentVariables []EnvironmentVariable_STATUS |
EnvironmentVariables: The environment variables to set in the container instance. |
image string |
Image: The name of the image used to create the container instance. |
instanceView ContainerProperties_InstanceView_STATUS |
InstanceView: The instance view of the container instance. Only valid in response. |
livenessProbe ContainerProbe_STATUS |
LivenessProbe: The liveness probe. |
name string |
Name: The user-provided name of the container instance. |
ports []ContainerPort_STATUS |
Ports: The exposed ports on the container instance. |
readinessProbe ContainerProbe_STATUS |
ReadinessProbe: The readiness probe. |
resources ResourceRequirements_STATUS |
Resources: The resource requirements of the container instance. |
volumeMounts []VolumeMount_STATUS |
VolumeMounts: The volume mounts available to the container instance. |
DnsConfiguration
(Appears on:ContainerGroup_Spec)
DNS configuration for the container group.
Field | Description |
---|---|
nameServers []string |
NameServers: The DNS servers for the container group. |
options string |
Options: The DNS options for the container group. |
searchDomains string |
SearchDomains: The DNS search domains for hostname lookup in the container group. |
DnsConfiguration_STATUS
(Appears on:ContainerGroup_STATUS)
DNS configuration for the container group.
Field | Description |
---|---|
nameServers []string |
NameServers: The DNS servers for the container group. |
options string |
Options: The DNS options for the container group. |
searchDomains string |
SearchDomains: The DNS search domains for hostname lookup in the container group. |
EncryptionProperties
(Appears on:ContainerGroup_Spec)
The container group encryption properties.
Field | Description |
---|---|
keyName string |
KeyName: The encryption key name. |
keyVersion string |
KeyVersion: The encryption key version. |
vaultBaseUrl string |
VaultBaseUrl: The keyvault base url. |
EncryptionProperties_STATUS
(Appears on:ContainerGroup_STATUS)
The container group encryption properties.
Field | Description |
---|---|
keyName string |
KeyName: The encryption key name. |
keyVersion string |
KeyVersion: The encryption key version. |
vaultBaseUrl string |
VaultBaseUrl: The keyvault base url. |
EnvironmentVariable
(Appears on:Container, InitContainerDefinition)
The environment variable to set within the container instance.
Field | Description |
---|---|
name string |
Name: The name of the environment variable. |
secureValue genruntime.SecretReference |
SecureValue: The value of the secure environment variable. |
value string |
Value: The value of the environment variable. |
EnvironmentVariable_STATUS
(Appears on:Container_STATUS, InitContainerDefinition_STATUS)
The environment variable to set within the container instance.
Field | Description |
---|---|
name string |
Name: The name of the environment variable. |
value string |
Value: The value of the environment variable. |
Event_STATUS
(Appears on:ContainerGroup_Properties_InstanceView_STATUS, ContainerProperties_InstanceView_STATUS, InitContainerPropertiesDefinition_InstanceView_STATUS)
A container group or container instance event.
Field | Description |
---|---|
count int |
Count: The count of the event. |
firstTimestamp string |
FirstTimestamp: The date-time of the earliest logged event. |
lastTimestamp string |
LastTimestamp: The date-time of the latest logged event. |
message string |
Message: The event message. |
name string |
Name: The event name. |
type string |
Type: The event type. |
GitRepoVolume
(Appears on:Volume)
Represents a volume that is populated with the contents of a git repository
Field | Description |
---|---|
directory string |
Directory: Target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
repository string |
Repository: Repository URL |
revision string |
Revision: Commit hash for the specified revision. |
GitRepoVolume_STATUS
(Appears on:Volume_STATUS)
Represents a volume that is populated with the contents of a git repository
Field | Description |
---|---|
directory string |
Directory: Target directory name. Must not contain or start with ‘..’. If ‘.’ is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
repository string |
Repository: Repository URL |
revision string |
Revision: Commit hash for the specified revision. |
GpuResource
(Appears on:ResourceLimits, ResourceRequests)
The GPU resource.
Field | Description |
---|---|
count int |
Count: The count of the GPU resource. |
sku GpuResource_Sku |
Sku: The SKU of the GPU resource. |
GpuResource_STATUS
(Appears on:ResourceLimits_STATUS, ResourceRequests_STATUS)
The GPU resource.
Field | Description |
---|---|
count int |
Count: The count of the GPU resource. |
sku GpuResource_Sku_STATUS |
Sku: The SKU of the GPU resource. |
GpuResource_Sku
(string
alias)
(Appears on:GpuResource)
Value | Description |
---|---|
"K80" |
|
"P100" |
|
"V100" |
GpuResource_Sku_STATUS
(string
alias)
(Appears on:GpuResource_STATUS)
Value | Description |
---|---|
"K80" |
|
"P100" |
|
"V100" |
HttpHeader
(Appears on:ContainerHttpGet)
The HTTP header.
Field | Description |
---|---|
name string |
Name: The header name. |
value string |
Value: The header value. |
HttpHeader_STATUS
(Appears on:ContainerHttpGet_STATUS)
The HTTP header.
Field | Description |
---|---|
name string |
Name: The header name. |
value string |
Value: The header value. |
ImageRegistryCredential
(Appears on:ContainerGroup_Spec)
Image registry credential.
Field | Description |
---|---|
identity string |
Identity: The identity for the private registry. |
identityUrl string |
IdentityUrl: The identity URL for the private registry. |
password genruntime.SecretReference |
Password: The password for the private registry. |
server string |
Server: The Docker image registry server without a protocol such as “http” and “https”. |
username string |
Username: The username for the private registry. |
ImageRegistryCredential_STATUS
(Appears on:ContainerGroup_STATUS)
Image registry credential.
Field | Description |
---|---|
identity string |
Identity: The identity for the private registry. |
identityUrl string |
IdentityUrl: The identity URL for the private registry. |
server string |
Server: The Docker image registry server without a protocol such as “http” and “https”. |
username string |
Username: The username for the private registry. |
InitContainerDefinition
(Appears on:ContainerGroup_Spec)
The init container definition.
Field | Description |
---|---|
command []string |
Command: The command to execute within the init container in exec form. |
environmentVariables []EnvironmentVariable |
EnvironmentVariables: The environment variables to set in the init container. |
image string |
Image: The image of the init container. |
name string |
Name: The name for the init container. |
volumeMounts []VolumeMount |
VolumeMounts: The volume mounts available to the init container. |
InitContainerDefinition_STATUS
(Appears on:ContainerGroup_STATUS)
The init container definition.
Field | Description |
---|---|
command []string |
Command: The command to execute within the init container in exec form. |
environmentVariables []EnvironmentVariable_STATUS |
EnvironmentVariables: The environment variables to set in the init container. |
image string |
Image: The image of the init container. |
instanceView InitContainerPropertiesDefinition_InstanceView_STATUS |
InstanceView: The instance view of the init container. Only valid in response. |
name string |
Name: The name for the init container. |
volumeMounts []VolumeMount_STATUS |
VolumeMounts: The volume mounts available to the init container. |
InitContainerPropertiesDefinition_InstanceView_STATUS
(Appears on:InitContainerDefinition_STATUS)
Field | Description |
---|---|
currentState ContainerState_STATUS |
CurrentState: The current state of the init container. |
events []Event_STATUS |
Events: The events of the init container. |
previousState ContainerState_STATUS |
PreviousState: The previous state of the init container. |
restartCount int |
RestartCount: The number of times that the init container has been restarted. |
IpAddress
(Appears on:ContainerGroup_Spec)
IP address for the container group.
Field | Description |
---|---|
autoGeneratedDomainNameLabelScope IpAddress_AutoGeneratedDomainNameLabelScope |
AutoGeneratedDomainNameLabelScope: 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. |
dnsNameLabel string |
DnsNameLabel: The Dns name label for the IP. |
ip string |
Ip: The IP exposed to the public internet. |
ports []Port |
Ports: The list of ports exposed on the container group. |
type IpAddress_Type |
Type: Specifies if the IP is exposed to the public internet or private VNET. |
IpAddress_AutoGeneratedDomainNameLabelScope
(string
alias)
(Appears on:IpAddress)
Value | Description |
---|---|
"Noreuse" |
|
"ResourceGroupReuse" |
|
"SubscriptionReuse" |
|
"TenantReuse" |
|
"Unsecure" |
IpAddress_AutoGeneratedDomainNameLabelScope_STATUS
(string
alias)
(Appears on:IpAddress_STATUS)
Value | Description |
---|---|
"Noreuse" |
|
"ResourceGroupReuse" |
|
"SubscriptionReuse" |
|
"TenantReuse" |
|
"Unsecure" |
IpAddress_STATUS
(Appears on:ContainerGroup_STATUS)
IP address for the container group.
Field | Description |
---|---|
autoGeneratedDomainNameLabelScope IpAddress_AutoGeneratedDomainNameLabelScope_STATUS |
AutoGeneratedDomainNameLabelScope: 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. |
dnsNameLabel string |
DnsNameLabel: The Dns name label for the IP. |
fqdn string |
Fqdn: The FQDN for the IP. |
ip string |
Ip: The IP exposed to the public internet. |
ports []Port_STATUS |
Ports: The list of ports exposed on the container group. |
type IpAddress_Type_STATUS |
Type: Specifies if the IP is exposed to the public internet or private VNET. |
IpAddress_Type
(string
alias)
(Appears on:IpAddress)
Value | Description |
---|---|
"Private" |
|
"Public" |
IpAddress_Type_STATUS
(string
alias)
(Appears on:IpAddress_STATUS)
Value | Description |
---|---|
"Private" |
|
"Public" |
LogAnalytics
(Appears on:ContainerGroupDiagnostics)
Container group log analytics information.
Field | Description |
---|---|
logType LogAnalytics_LogType |
LogType: The log type to be used. |
metadata map[string]string |
Metadata: Metadata for log analytics. |
workspaceId string |
WorkspaceId: The workspace id for log analytics |
workspaceKey genruntime.SecretReference |
WorkspaceKey: The workspace key for log analytics |
workspaceResourceReference genruntime.ResourceReference |
WorkspaceResourceReference: The workspace resource id for log analytics |
LogAnalytics_LogType
(string
alias)
(Appears on:LogAnalytics)
Value | Description |
---|---|
"ContainerInsights" |
|
"ContainerInstanceLogs" |
LogAnalytics_LogType_STATUS
(string
alias)
(Appears on:LogAnalytics_STATUS)
Value | Description |
---|---|
"ContainerInsights" |
|
"ContainerInstanceLogs" |
LogAnalytics_STATUS
(Appears on:ContainerGroupDiagnostics_STATUS)
Container group log analytics information.
Field | Description |
---|---|
logType LogAnalytics_LogType_STATUS |
LogType: The log type to be used. |
metadata map[string]string |
Metadata: Metadata for log analytics. |
workspaceId string |
WorkspaceId: The workspace id for log analytics |
Port
(Appears on:IpAddress)
The port exposed on the container group.
Field | Description |
---|---|
port int |
Port: The port number. |
protocol Port_Protocol |
Protocol: The protocol associated with the port. |
Port_Protocol
(string
alias)
(Appears on:Port)
Value | Description |
---|---|
"TCP" |
|
"UDP" |
Port_Protocol_STATUS
(string
alias)
(Appears on:Port_STATUS)
Value | Description |
---|---|
"TCP" |
|
"UDP" |
Port_STATUS
(Appears on:IpAddress_STATUS)
The port exposed on the container group.
Field | Description |
---|---|
port int |
Port: The port number. |
protocol Port_Protocol_STATUS |
Protocol: The protocol associated with the port. |
ResourceLimits
(Appears on:ResourceRequirements)
The resource limits.
Field | Description |
---|---|
cpu float64 |
Cpu: The CPU limit of this container instance. |
gpu GpuResource |
Gpu: The GPU limit of this container instance. |
memoryInGB float64 |
MemoryInGB: The memory limit in GB of this container instance. |
ResourceLimits_STATUS
(Appears on:ResourceRequirements_STATUS)
The resource limits.
Field | Description |
---|---|
cpu float64 |
Cpu: The CPU limit of this container instance. |
gpu GpuResource_STATUS |
Gpu: The GPU limit of this container instance. |
memoryInGB float64 |
MemoryInGB: The memory limit in GB of this container instance. |
ResourceRequests
(Appears on:ResourceRequirements)
The resource requests.
Field | Description |
---|---|
cpu float64 |
Cpu: The CPU request of this container instance. |
gpu GpuResource |
Gpu: The GPU request of this container instance. |
memoryInGB float64 |
MemoryInGB: The memory request in GB of this container instance. |
ResourceRequests_STATUS
(Appears on:ResourceRequirements_STATUS)
The resource requests.
Field | Description |
---|---|
cpu float64 |
Cpu: The CPU request of this container instance. |
gpu GpuResource_STATUS |
Gpu: The GPU request of this container instance. |
memoryInGB float64 |
MemoryInGB: The memory request in GB of this container instance. |
ResourceRequirements
(Appears on:Container)
The resource requirements.
Field | Description |
---|---|
limits ResourceLimits |
Limits: The resource limits of this container instance. |
requests ResourceRequests |
Requests: The resource requests of this container instance. |
ResourceRequirements_STATUS
(Appears on:Container_STATUS)
The resource requirements.
Field | Description |
---|---|
limits ResourceLimits_STATUS |
Limits: The resource limits of this container instance. |
requests ResourceRequests_STATUS |
Requests: The resource requests of this container instance. |
UserAssignedIdentities_STATUS
(Appears on:ContainerGroupIdentity_STATUS)
The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.p>
Field | Description |
---|---|
clientId string |
ClientId: The client id of user assigned identity. |
principalId string |
PrincipalId: The principal id of user assigned identity. |
UserAssignedIdentityDetails
(Appears on:ContainerGroupIdentity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
Volume
(Appears on:ContainerGroup_Spec)
The properties of the volume.
Field | Description |
---|---|
azureFile AzureFileVolume |
AzureFile: The Azure File volume. |
emptyDir map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
EmptyDir: The empty directory volume. |
gitRepo GitRepoVolume |
GitRepo: The git repo volume. |
name string |
Name: The name of the volume. |
secret map[string]string |
Secret: The secret volume. |
VolumeMount
(Appears on:Container, InitContainerDefinition)
The properties of the volume mount.
Field | Description |
---|---|
mountPath string |
MountPath: The path within the container where the volume should be mounted. Must not contain colon (:). |
name string |
Name: The name of the volume mount. |
readOnly bool |
ReadOnly: The flag indicating whether the volume mount is read-only. |
VolumeMount_STATUS
(Appears on:Container_STATUS, InitContainerDefinition_STATUS)
The properties of the volume mount.
Field | Description |
---|---|
mountPath string |
MountPath: The path within the container where the volume should be mounted. Must not contain colon (:). |
name string |
Name: The name of the volume mount. |
readOnly bool |
ReadOnly: The flag indicating whether the volume mount is read-only. |
Volume_STATUS
(Appears on:ContainerGroup_STATUS)
The properties of the volume.
Field | Description |
---|---|
azureFile AzureFileVolume_STATUS |
AzureFile: The Azure File volume. |
emptyDir map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
EmptyDir: The empty directory volume. |
gitRepo GitRepoVolume_STATUS |
GitRepo: The git repo volume. |
name string |
Name: The name of the volume. |
secret map[string]string |
Secret: The secret volume. |