containerinstance.azure.com/v1beta20211001

containerinstance.azure.com/v1beta20211001

Package v1beta20211001 contains API Schema definitions for the containerinstance v1beta20211001 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-10-01"

    AzureFileVolume

    (Appears on:Volume)

    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.

    AzureFileVolumeARM

    (Appears on:VolumeARM)

    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)

    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_StatusARM

    (Appears on:Volume_StatusARM)

    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.

    ContainerExec

    (Appears on:ContainerProbe)

    Field Description
    command
    []string

    Command: The commands to execute within the container.

    ContainerExecARM

    (Appears on:ContainerProbeARM)

    Field Description
    command
    []string

    Command: The commands to execute within the container.

    ContainerExec_Status

    (Appears on:ContainerProbe_Status)

    Field Description
    command
    []string

    Command: The commands to execute within the container.

    ContainerExec_StatusARM

    (Appears on:ContainerProbe_StatusARM)

    Field Description
    command
    []string

    Command: The commands to execute within the container.

    ContainerGroup

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ContainerGroups_Spec


    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
    []ContainerGroups_Spec_Properties_Containers

    Containers: The containers within the container group.

    diagnostics
    ContainerGroupDiagnostics

    Diagnostics: Container group diagnostic information.

    dnsConfig
    DnsConfiguration

    DnsConfig: DNS configuration for the container group.

    encryptionProperties
    EncryptionProperties

    EncryptionProperties: The container group encryption properties.

    identity
    ContainerGroupIdentity

    Identity: Identity for the container group.

    imageRegistryCredentials
    []ContainerGroups_Spec_Properties_ImageRegistryCredentials

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

    initContainers
    []ContainerGroups_Spec_Properties_InitContainers

    InitContainers: The init containers for a container group.

    ipAddress
    IpAddress

    IpAddress: IP address for the container group.

    location
    string

    Location: Location to deploy resource to

    osType
    ContainerGroupsSpecPropertiesOsType

    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
    ContainerGroupsSpecPropertiesRestartPolicy

    RestartPolicy: Restart policy for all containers within the container group. - Always Always restart - OnFailure Restart on failure - Never Never restart .

    sku
    ContainerGroupsSpecPropertiesSku

    Sku: The SKU for a container group.

    subnetIds
    []ContainerGroupSubnetId

    SubnetIds: The subnet resource IDs for a container group.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    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.

    status
    ContainerGroup_Status

    ContainerGroupDiagnostics

    (Appears on:ContainerGroups_Spec)

    Field Description
    logAnalytics
    LogAnalytics

    LogAnalytics: Container group log analytics information.

    ContainerGroupDiagnosticsARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    logAnalytics
    LogAnalyticsARM

    LogAnalytics: Container group log analytics information.

    ContainerGroupDiagnostics_Status

    (Appears on:ContainerGroup_Status)

    Field Description
    logAnalytics
    LogAnalytics_Status

    LogAnalytics: Container group log analytics information.

    ContainerGroupDiagnostics_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    logAnalytics
    LogAnalytics_StatusARM

    LogAnalytics: Container group log analytics information.

    ContainerGroupIdentity

    (Appears on:ContainerGroups_Spec)

    Field Description
    type
    ContainerGroupIdentityType

    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.

    ContainerGroupIdentityARM

    (Appears on:ContainerGroups_SpecARM)

    Field Description
    type
    ContainerGroupIdentityType

    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.

    ContainerGroupIdentityStatusType (string alias)

    (Appears on:ContainerGroupIdentity_Status, ContainerGroupIdentity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    ContainerGroupIdentityType (string alias)

    (Appears on:ContainerGroupIdentity, ContainerGroupIdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    ContainerGroupIdentity_Status

    (Appears on:ContainerGroup_Status)

    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
    ContainerGroupIdentityStatusType

    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/v1beta20211001.ContainerGroupIdentity_Status_UserAssignedIdentities

    UserAssignedIdentities: 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}’.

    ContainerGroupIdentity_StatusARM

    (Appears on:ContainerGroup_StatusARM)

    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
    ContainerGroupIdentityStatusType

    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/v1beta20211001.ContainerGroupIdentity_Status_UserAssignedIdentitiesARM

    UserAssignedIdentities: 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}’.

    ContainerGroupIdentity_Status_UserAssignedIdentities

    (Appears on:ContainerGroupIdentity_Status)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    ContainerGroupIdentity_Status_UserAssignedIdentitiesARM

    (Appears on:ContainerGroupIdentity_StatusARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    ContainerGroupSku_Status (string alias)

    (Appears on:ContainerGroup_Status, ContainerGroup_Status_PropertiesARM)

    Value Description

    "Dedicated"

    "Standard"

    ContainerGroupStatusPropertiesOsType (string alias)

    (Appears on:ContainerGroup_Status, ContainerGroup_Status_PropertiesARM)

    Value Description

    "Linux"

    "Windows"

    ContainerGroupStatusPropertiesRestartPolicy (string alias)

    (Appears on:ContainerGroup_Status, ContainerGroup_Status_PropertiesARM)

    Value Description

    "Always"

    "Never"

    "OnFailure"

    ContainerGroupSubnetId

    (Appears on:ContainerGroups_Spec)

    Field Description
    name
    string

    Name: Friendly name for the subnet.

    reference
    genruntime.ResourceReference

    Reference: Resource ID of virtual network and subnet.

    ContainerGroupSubnetIdARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    id
    string
    name
    string

    Name: Friendly name for the subnet.

    ContainerGroupSubnetId_Status

    (Appears on:ContainerGroup_Status)

    Field Description
    id
    string

    Id: Resource ID of virtual network and subnet.

    name
    string

    Name: Friendly name for the subnet.

    ContainerGroupSubnetId_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    id
    string

    Id: Resource ID of virtual network and subnet.

    name
    string

    Name: Friendly name for the subnet.

    ContainerGroup_Status

    (Appears on:ContainerGroup)

    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_Status_Properties_InstanceView

    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
    ContainerGroupStatusPropertiesOsType

    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
    ContainerGroupStatusPropertiesRestartPolicy

    RestartPolicy: Restart policy for all containers within the container group. - Always Always restart - OnFailure Restart on failure - Never Never restart

    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_StatusARM

    Field Description
    id
    string

    Id: The resource id.

    identity
    ContainerGroupIdentity_StatusARM

    Identity: The identity of the container group, if configured.

    location
    string

    Location: The resource location.

    name
    string

    Name: The resource name.

    properties
    ContainerGroup_Status_PropertiesARM

    Properties: The container group properties

    tags
    map[string]string

    Tags: The resource tags.

    type
    string

    Type: The resource type.

    zones
    []string

    Zones: The zones for the container group.

    ContainerGroup_Status_PropertiesARM

    (Appears on:ContainerGroup_StatusARM)

    Field Description
    containers
    []Container_StatusARM

    Containers: The containers within the container group.

    diagnostics
    ContainerGroupDiagnostics_StatusARM

    Diagnostics: The diagnostic information for a container group.

    dnsConfig
    DnsConfiguration_StatusARM

    DnsConfig: The DNS config information for a container group.

    encryptionProperties
    EncryptionProperties_StatusARM

    EncryptionProperties: The encryption properties for a container group.

    imageRegistryCredentials
    []ImageRegistryCredential_StatusARM

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

    initContainers
    []InitContainerDefinition_StatusARM

    InitContainers: The init containers for a container group.

    instanceView
    ContainerGroup_Status_Properties_InstanceViewARM

    InstanceView: The instance view of the container group. Only valid in response.

    ipAddress
    IpAddress_StatusARM

    IpAddress: The IP address type of the container group.

    osType
    ContainerGroupStatusPropertiesOsType

    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
    ContainerGroupStatusPropertiesRestartPolicy

    RestartPolicy: Restart policy for all containers within the container group. - Always Always restart - OnFailure Restart on failure - Never Never restart

    sku
    ContainerGroupSku_Status

    Sku: The SKU for a container group.

    subnetIds
    []ContainerGroupSubnetId_StatusARM

    SubnetIds: The subnet resource IDs for a container group.

    volumes
    []Volume_StatusARM

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

    ContainerGroup_Status_Properties_InstanceView

    (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_Status_Properties_InstanceViewARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    events
    []Event_StatusARM

    Events: The events of this container group.

    state
    string

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

    ContainerGroupsSpecPropertiesOsType (string alias)

    (Appears on:ContainerGroups_Spec, ContainerGroups_Spec_PropertiesARM)

    Value Description

    "Linux"

    "Windows"

    ContainerGroupsSpecPropertiesRestartPolicy (string alias)

    (Appears on:ContainerGroups_Spec, ContainerGroups_Spec_PropertiesARM)

    Value Description

    "Always"

    "Never"

    "OnFailure"

    ContainerGroupsSpecPropertiesSku (string alias)

    (Appears on:ContainerGroups_Spec, ContainerGroups_Spec_PropertiesARM)

    Value Description

    "Dedicated"

    "Standard"

    ContainerGroups_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
    []ContainerGroups_Spec_Properties_Containers

    Containers: The containers within the container group.

    diagnostics
    ContainerGroupDiagnostics

    Diagnostics: Container group diagnostic information.

    dnsConfig
    DnsConfiguration

    DnsConfig: DNS configuration for the container group.

    encryptionProperties
    EncryptionProperties

    EncryptionProperties: The container group encryption properties.

    identity
    ContainerGroupIdentity

    Identity: Identity for the container group.

    imageRegistryCredentials
    []ContainerGroups_Spec_Properties_ImageRegistryCredentials

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

    initContainers
    []ContainerGroups_Spec_Properties_InitContainers

    InitContainers: The init containers for a container group.

    ipAddress
    IpAddress

    IpAddress: IP address for the container group.

    location
    string

    Location: Location to deploy resource to

    osType
    ContainerGroupsSpecPropertiesOsType

    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
    ContainerGroupsSpecPropertiesRestartPolicy

    RestartPolicy: Restart policy for all containers within the container group. - Always Always restart - OnFailure Restart on failure - Never Never restart .

    sku
    ContainerGroupsSpecPropertiesSku

    Sku: The SKU for a container group.

    subnetIds
    []ContainerGroupSubnetId

    SubnetIds: The subnet resource IDs for a container group.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    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.

    ContainerGroups_SpecARM

    Field Description
    identity
    ContainerGroupIdentityARM

    Identity: Identity for the container group.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the container group.

    properties
    ContainerGroups_Spec_PropertiesARM

    Properties: The container group properties

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The zones for the container group.

    ContainerGroups_Spec_PropertiesARM

    (Appears on:ContainerGroups_SpecARM)

    Field Description
    containers
    []ContainerGroups_Spec_Properties_ContainersARM

    Containers: The containers within the container group.

    diagnostics
    ContainerGroupDiagnosticsARM

    Diagnostics: Container group diagnostic information.

    dnsConfig
    DnsConfigurationARM

    DnsConfig: DNS configuration for the container group.

    encryptionProperties
    EncryptionPropertiesARM

    EncryptionProperties: The container group encryption properties.

    imageRegistryCredentials
    []ContainerGroups_Spec_Properties_ImageRegistryCredentialsARM

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

    initContainers
    []ContainerGroups_Spec_Properties_InitContainersARM

    InitContainers: The init containers for a container group.

    ipAddress
    IpAddressARM

    IpAddress: IP address for the container group.

    osType
    ContainerGroupsSpecPropertiesOsType

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

    restartPolicy
    ContainerGroupsSpecPropertiesRestartPolicy

    RestartPolicy: Restart policy for all containers within the container group. - Always Always restart - OnFailure Restart on failure - Never Never restart .

    sku
    ContainerGroupsSpecPropertiesSku

    Sku: The SKU for a container group.

    subnetIds
    []ContainerGroupSubnetIdARM

    SubnetIds: The subnet resource IDs for a container group.

    volumes
    []VolumeARM

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

    ContainerGroups_Spec_Properties_Containers

    (Appears on:ContainerGroups_Spec)

    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 container probe, for liveness or readiness

    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 container probe, for liveness or readiness

    resources
    ResourceRequirements

    Resources: The resource requirements.

    volumeMounts
    []VolumeMount

    VolumeMounts: The volume mounts available to the container instance.

    ContainerGroups_Spec_Properties_ContainersARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    name
    string

    Name: The user-provided name of the container instance.

    properties
    ContainerPropertiesARM

    Properties: The container instance properties.

    ContainerGroups_Spec_Properties_ImageRegistryCredentials

    (Appears on:ContainerGroups_Spec)

    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.

    ContainerGroups_Spec_Properties_ImageRegistryCredentialsARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    identity
    string

    Identity: The identity for the private registry.

    identityUrl
    string

    IdentityUrl: The identity URL for the private registry.

    password
    string

    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.

    ContainerGroups_Spec_Properties_InitContainers

    (Appears on:ContainerGroups_Spec)

    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.

    ContainerGroups_Spec_Properties_InitContainersARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    name
    string

    Name: The name for the init container.

    properties
    InitContainerPropertiesDefinitionARM

    Properties: The init container definition properties.

    ContainerHttpGet

    (Appears on:ContainerProbe)

    Field Description
    httpHeaders
    []HttpHeader

    HttpHeaders: The HTTP headers.

    path
    string

    Path: The path to probe.

    port
    int

    Port: The port number to probe.

    scheme
    ContainerHttpGetScheme

    Scheme: The scheme.

    ContainerHttpGetARM

    (Appears on:ContainerProbeARM)

    Field Description
    httpHeaders
    []HttpHeaderARM

    HttpHeaders: The HTTP headers.

    path
    string

    Path: The path to probe.

    port
    int

    Port: The port number to probe.

    scheme
    ContainerHttpGetScheme

    Scheme: The scheme.

    ContainerHttpGetScheme (string alias)

    (Appears on:ContainerHttpGet, ContainerHttpGetARM)

    Value Description

    "http"

    "https"

    ContainerHttpGetStatusScheme (string alias)

    (Appears on:ContainerHttpGet_Status, ContainerHttpGet_StatusARM)

    Value Description

    "http"

    "https"

    ContainerHttpGet_Status

    (Appears on:ContainerProbe_Status)

    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
    ContainerHttpGetStatusScheme

    Scheme: The scheme.

    ContainerHttpGet_StatusARM

    (Appears on:ContainerProbe_StatusARM)

    Field Description
    httpHeaders
    []HttpHeader_StatusARM

    HttpHeaders: The HTTP headers.

    path
    string

    Path: The path to probe.

    port
    int

    Port: The port number to probe.

    scheme
    ContainerHttpGetStatusScheme

    Scheme: The scheme.

    ContainerPort

    (Appears on:ContainerGroups_Spec_Properties_Containers)

    Field Description
    port
    int

    Port: The port number exposed within the container group.

    protocol
    ContainerPortProtocol

    Protocol: The protocol associated with the port.

    ContainerPortARM

    (Appears on:ContainerPropertiesARM)

    Field Description
    port
    int

    Port: The port number exposed within the container group.

    protocol
    ContainerPortProtocol

    Protocol: The protocol associated with the port.

    ContainerPortProtocol (string alias)

    (Appears on:ContainerPort, ContainerPortARM)

    Value Description

    "TCP"

    "UDP"

    ContainerPortStatusProtocol (string alias)

    (Appears on:ContainerPort_Status, ContainerPort_StatusARM)

    Value Description

    "TCP"

    "UDP"

    ContainerPort_Status

    (Appears on:Container_Status)

    Field Description
    port
    int

    Port: The port number exposed within the container group.

    protocol
    ContainerPortStatusProtocol

    Protocol: The protocol associated with the port.

    ContainerPort_StatusARM

    (Appears on:ContainerProperties_StatusARM)

    Field Description
    port
    int

    Port: The port number exposed within the container group.

    protocol
    ContainerPortStatusProtocol

    Protocol: The protocol associated with the port.

    ContainerProbe

    (Appears on:ContainerGroups_Spec_Properties_Containers)

    Field Description
    exec
    ContainerExec

    Exec: The container execution command, for liveness or readiness probe

    failureThreshold
    int

    FailureThreshold: The failure threshold.

    httpGet
    ContainerHttpGet

    HttpGet: The container Http Get settings, for liveness or readiness 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.

    ContainerProbeARM

    (Appears on:ContainerPropertiesARM)

    Field Description
    exec
    ContainerExecARM

    Exec: The container execution command, for liveness or readiness probe

    failureThreshold
    int

    FailureThreshold: The failure threshold.

    httpGet
    ContainerHttpGetARM

    HttpGet: The container Http Get settings, for liveness or readiness 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)

    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.

    ContainerProbe_StatusARM

    (Appears on:ContainerProperties_StatusARM)

    Field Description
    exec
    ContainerExec_StatusARM

    Exec: The execution command to probe

    failureThreshold
    int

    FailureThreshold: The failure threshold.

    httpGet
    ContainerHttpGet_StatusARM

    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.

    ContainerPropertiesARM

    (Appears on:ContainerGroups_Spec_Properties_ContainersARM)

    Field Description
    command
    []string

    Command: The commands to execute within the container instance in exec form.

    environmentVariables
    []EnvironmentVariableARM

    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
    ContainerProbeARM

    LivenessProbe: The container probe, for liveness or readiness

    ports
    []ContainerPortARM

    Ports: The exposed ports on the container instance.

    readinessProbe
    ContainerProbeARM

    ReadinessProbe: The container probe, for liveness or readiness

    resources
    ResourceRequirementsARM

    Resources: The resource requirements.

    volumeMounts
    []VolumeMountARM

    VolumeMounts: The volume mounts available to the container instance.

    ContainerProperties_StatusARM

    (Appears on:Container_StatusARM)

    Field Description
    command
    []string

    Command: The commands to execute within the container instance in exec form.

    environmentVariables
    []EnvironmentVariable_StatusARM

    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_Status_InstanceViewARM

    InstanceView: The instance view of the container instance. Only valid in response.

    livenessProbe
    ContainerProbe_StatusARM

    LivenessProbe: The liveness probe.

    ports
    []ContainerPort_StatusARM

    Ports: The exposed ports on the container instance.

    readinessProbe
    ContainerProbe_StatusARM

    ReadinessProbe: The readiness probe.

    resources
    ResourceRequirements_StatusARM

    Resources: The resource requirements of the container instance.

    volumeMounts
    []VolumeMount_StatusARM

    VolumeMounts: The volume mounts available to the container instance.

    ContainerProperties_Status_InstanceView

    (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.

    ContainerProperties_Status_InstanceViewARM

    (Appears on:ContainerProperties_StatusARM)

    Field Description
    currentState
    ContainerState_StatusARM

    CurrentState: Current container instance state.

    events
    []Event_StatusARM

    Events: The events of the container instance.

    previousState
    ContainerState_StatusARM

    PreviousState: Previous container instance state.

    restartCount
    int

    RestartCount: The number of times that the container instance has been restarted.

    ContainerState_Status

    (Appears on:ContainerProperties_Status_InstanceView, InitContainerPropertiesDefinition_Status_InstanceView)

    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 docker run command.

    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.

    ContainerState_StatusARM

    (Appears on:ContainerProperties_Status_InstanceViewARM, InitContainerPropertiesDefinition_Status_InstanceViewARM)

    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 docker run command.

    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)

    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_Status_InstanceView

    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.

    Container_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    name
    string

    Name: The user-provided name of the container instance.

    properties
    ContainerProperties_StatusARM

    Properties: The properties of the container instance.

    DnsConfiguration

    (Appears on:ContainerGroups_Spec)

    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.

    DnsConfigurationARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    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)

    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_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    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:ContainerGroups_Spec)

    Field Description
    keyName
    string

    KeyName: The encryption key name.

    keyVersion
    string

    KeyVersion: The encryption key version.

    vaultBaseUrl
    string

    VaultBaseUrl: The keyvault base url.

    EncryptionPropertiesARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    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)

    Field Description
    keyName
    string

    KeyName: The encryption key name.

    keyVersion
    string

    KeyVersion: The encryption key version.

    vaultBaseUrl
    string

    VaultBaseUrl: The keyvault base url.

    EncryptionProperties_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    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:ContainerGroups_Spec_Properties_Containers, ContainerGroups_Spec_Properties_InitContainers)

    Field Description
    name
    string

    Name: The name of the environment variable.

    secureValue
    string

    SecureValue: The value of the secure environment variable.

    value
    string

    Value: The value of the environment variable.

    EnvironmentVariableARM

    (Appears on:ContainerPropertiesARM, InitContainerPropertiesDefinitionARM)

    Field Description
    name
    string

    Name: The name of the environment variable.

    secureValue
    string

    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)

    Field Description
    name
    string

    Name: The name of the environment variable.

    secureValue
    string

    SecureValue: The value of the secure environment variable.

    value
    string

    Value: The value of the environment variable.

    EnvironmentVariable_StatusARM

    (Appears on:ContainerProperties_StatusARM, InitContainerPropertiesDefinition_StatusARM)

    Field Description
    name
    string

    Name: The name of the environment variable.

    secureValue
    string

    SecureValue: The value of the secure environment variable.

    value
    string

    Value: The value of the environment variable.

    Event_Status

    (Appears on:ContainerGroup_Status_Properties_InstanceView, ContainerProperties_Status_InstanceView, InitContainerPropertiesDefinition_Status_InstanceView)

    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.

    Event_StatusARM

    (Appears on:ContainerGroup_Status_Properties_InstanceViewARM, ContainerProperties_Status_InstanceViewARM, InitContainerPropertiesDefinition_Status_InstanceViewARM)

    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)

    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.

    GitRepoVolumeARM

    (Appears on:VolumeARM)

    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)

    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_StatusARM

    (Appears on:Volume_StatusARM)

    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)

    Field Description
    count
    int

    Count: The count of the GPU resource.

    sku
    GpuResourceSku

    Sku: The SKU of the GPU resource.

    GpuResourceARM

    (Appears on:ResourceLimitsARM, ResourceRequestsARM)

    Field Description
    count
    int

    Count: The count of the GPU resource.

    sku
    GpuResourceSku

    Sku: The SKU of the GPU resource.

    GpuResourceSku (string alias)

    (Appears on:GpuResource, GpuResourceARM)

    Value Description

    "K80"

    "P100"

    "V100"

    GpuResourceStatusSku (string alias)

    (Appears on:GpuResource_Status, GpuResource_StatusARM)

    Value Description

    "K80"

    "P100"

    "V100"

    GpuResource_Status

    (Appears on:ResourceLimits_Status, ResourceRequests_Status)

    Field Description
    count
    int

    Count: The count of the GPU resource.

    sku
    GpuResourceStatusSku

    Sku: The SKU of the GPU resource.

    GpuResource_StatusARM

    (Appears on:ResourceLimits_StatusARM, ResourceRequests_StatusARM)

    Field Description
    count
    int

    Count: The count of the GPU resource.

    sku
    GpuResourceStatusSku

    Sku: The SKU of the GPU resource.

    HttpHeader

    (Appears on:ContainerHttpGet)

    Field Description
    name
    string

    Name: The header name.

    value
    string

    Value: The header value.

    HttpHeaderARM

    (Appears on:ContainerHttpGetARM)

    Field Description
    name
    string

    Name: The header name.

    value
    string

    Value: The header value.

    HttpHeader_Status

    (Appears on:ContainerHttpGet_Status)

    Field Description
    name
    string

    Name: The header name.

    value
    string

    Value: The header value.

    HttpHeader_StatusARM

    (Appears on:ContainerHttpGet_StatusARM)

    Field Description
    name
    string

    Name: The header name.

    value
    string

    Value: The header value.

    ImageRegistryCredential_Status

    (Appears on:ContainerGroup_Status)

    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.

    ImageRegistryCredential_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    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_Status

    (Appears on:ContainerGroup_Status)

    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_Status_InstanceView

    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.

    InitContainerDefinition_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    name
    string

    Name: The name for the init container.

    properties
    InitContainerPropertiesDefinition_StatusARM

    Properties: The properties for the init container.

    InitContainerPropertiesDefinitionARM

    (Appears on:ContainerGroups_Spec_Properties_InitContainersARM)

    Field Description
    command
    []string

    Command: The command to execute within the init container in exec form.

    environmentVariables
    []EnvironmentVariableARM

    EnvironmentVariables: The environment variables to set in the init container.

    image
    string

    Image: The image of the init container.

    volumeMounts
    []VolumeMountARM

    VolumeMounts: The volume mounts available to the init container.

    InitContainerPropertiesDefinition_StatusARM

    (Appears on:InitContainerDefinition_StatusARM)

    Field Description
    command
    []string

    Command: The command to execute within the init container in exec form.

    environmentVariables
    []EnvironmentVariable_StatusARM

    EnvironmentVariables: The environment variables to set in the init container.

    image
    string

    Image: The image of the init container.

    instanceView
    InitContainerPropertiesDefinition_Status_InstanceViewARM

    InstanceView: The instance view of the init container. Only valid in response.

    volumeMounts
    []VolumeMount_StatusARM

    VolumeMounts: The volume mounts available to the init container.

    InitContainerPropertiesDefinition_Status_InstanceView

    (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.

    InitContainerPropertiesDefinition_Status_InstanceViewARM

    (Appears on:InitContainerPropertiesDefinition_StatusARM)

    Field Description
    currentState
    ContainerState_StatusARM

    CurrentState: The current state of the init container.

    events
    []Event_StatusARM

    Events: The events of the init container.

    previousState
    ContainerState_StatusARM

    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:ContainerGroups_Spec)

    Field Description
    dnsNameLabel
    string

    DnsNameLabel: The Dns name label for the IP.

    dnsNameLabelReusePolicy
    IpAddressDnsNameLabelReusePolicy

    DnsNameLabelReusePolicy: The value representing the security enum.

    ip
    string

    Ip: The IP exposed to the public internet.

    ports
    []Port

    Ports: The list of ports exposed on the container group.

    type
    IpAddressType

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

    IpAddressARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    dnsNameLabel
    string

    DnsNameLabel: The Dns name label for the IP.

    dnsNameLabelReusePolicy
    IpAddressDnsNameLabelReusePolicy

    DnsNameLabelReusePolicy: The value representing the security enum.

    ip
    string

    Ip: The IP exposed to the public internet.

    ports
    []PortARM

    Ports: The list of ports exposed on the container group.

    type
    IpAddressType

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

    IpAddressDnsNameLabelReusePolicy (string alias)

    (Appears on:IpAddress, IpAddressARM)

    Value Description

    "Noreuse"

    "ResourceGroupReuse"

    "SubscriptionReuse"

    "TenantReuse"

    "Unsecure"

    IpAddressStatusDnsNameLabelReusePolicy (string alias)

    (Appears on:IpAddress_Status, IpAddress_StatusARM)

    Value Description

    "Noreuse"

    "ResourceGroupReuse"

    "SubscriptionReuse"

    "TenantReuse"

    "Unsecure"

    IpAddressStatusType (string alias)

    (Appears on:IpAddress_Status, IpAddress_StatusARM)

    Value Description

    "Private"

    "Public"

    IpAddressType (string alias)

    (Appears on:IpAddress, IpAddressARM)

    Value Description

    "Private"

    "Public"

    IpAddress_Status

    (Appears on:ContainerGroup_Status)

    Field Description
    dnsNameLabel
    string

    DnsNameLabel: The Dns name label for the IP.

    dnsNameLabelReusePolicy
    IpAddressStatusDnsNameLabelReusePolicy

    DnsNameLabelReusePolicy: The value representing the security enum.

    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
    IpAddressStatusType

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

    IpAddress_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    dnsNameLabel
    string

    DnsNameLabel: The Dns name label for the IP.

    dnsNameLabelReusePolicy
    IpAddressStatusDnsNameLabelReusePolicy

    DnsNameLabelReusePolicy: The value representing the security enum.

    fqdn
    string

    Fqdn: The FQDN for the IP.

    ip
    string

    Ip: The IP exposed to the public internet.

    ports
    []Port_StatusARM

    Ports: The list of ports exposed on the container group.

    type
    IpAddressStatusType

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

    LogAnalytics

    (Appears on:ContainerGroupDiagnostics)

    Field Description
    logType
    LogAnalyticsLogType

    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
    string

    WorkspaceKey: The workspace key for log analytics

    workspaceResourceReference
    genruntime.ResourceReference

    WorkspaceResourceReference: The workspace resource id for log analytics

    LogAnalyticsARM

    (Appears on:ContainerGroupDiagnosticsARM)

    Field Description
    logType
    LogAnalyticsLogType

    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
    string

    WorkspaceKey: The workspace key for log analytics

    workspaceResourceId
    string

    LogAnalyticsLogType (string alias)

    (Appears on:LogAnalytics, LogAnalyticsARM)

    Value Description

    "ContainerInsights"

    "ContainerInstanceLogs"

    LogAnalyticsStatusLogType (string alias)

    (Appears on:LogAnalytics_Status, LogAnalytics_StatusARM)

    Value Description

    "ContainerInsights"

    "ContainerInstanceLogs"

    LogAnalytics_Status

    (Appears on:ContainerGroupDiagnostics_Status)

    Field Description
    logType
    LogAnalyticsStatusLogType

    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
    string

    WorkspaceKey: The workspace key for log analytics

    workspaceResourceId
    string

    WorkspaceResourceId: The workspace resource id for log analytics

    LogAnalytics_StatusARM

    (Appears on:ContainerGroupDiagnostics_StatusARM)

    Field Description
    logType
    LogAnalyticsStatusLogType

    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
    string

    WorkspaceKey: The workspace key for log analytics

    workspaceResourceId
    string

    WorkspaceResourceId: The workspace resource id for log analytics

    Port

    (Appears on:IpAddress)

    Field Description
    port
    int

    Port: The port number.

    protocol
    PortProtocol

    Protocol: The protocol associated with the port.

    PortARM

    (Appears on:IpAddressARM)

    Field Description
    port
    int

    Port: The port number.

    protocol
    PortProtocol

    Protocol: The protocol associated with the port.

    PortProtocol (string alias)

    (Appears on:Port, PortARM)

    Value Description

    "TCP"

    "UDP"

    PortStatusProtocol (string alias)

    (Appears on:Port_Status, Port_StatusARM)

    Value Description

    "TCP"

    "UDP"

    Port_Status

    (Appears on:IpAddress_Status)

    Field Description
    port
    int

    Port: The port number.

    protocol
    PortStatusProtocol

    Protocol: The protocol associated with the port.

    Port_StatusARM

    (Appears on:IpAddress_StatusARM)

    Field Description
    port
    int

    Port: The port number.

    protocol
    PortStatusProtocol

    Protocol: The protocol associated with the port.

    ResourceLimits

    (Appears on:ResourceRequirements)

    Field Description
    cpu
    float64

    Cpu: The CPU limit of this container instance.

    gpu
    GpuResource

    Gpu: The GPU resource.

    memoryInGB
    float64

    MemoryInGB: The memory limit in GB of this container instance.

    ResourceLimitsARM

    (Appears on:ResourceRequirementsARM)

    Field Description
    cpu
    float64

    Cpu: The CPU limit of this container instance.

    gpu
    GpuResourceARM

    Gpu: The GPU resource.

    memoryInGB
    float64

    MemoryInGB: The memory limit in GB of this container instance.

    ResourceLimits_Status

    (Appears on:ResourceRequirements_Status)

    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.

    ResourceLimits_StatusARM

    (Appears on:ResourceRequirements_StatusARM)

    Field Description
    cpu
    float64

    Cpu: The CPU limit of this container instance.

    gpu
    GpuResource_StatusARM

    Gpu: The GPU limit of this container instance.

    memoryInGB
    float64

    MemoryInGB: The memory limit in GB of this container instance.

    ResourceRequests

    (Appears on:ResourceRequirements)

    Field Description
    cpu
    float64

    Cpu: The CPU request of this container instance.

    gpu
    GpuResource

    Gpu: The GPU resource.

    memoryInGB
    float64

    MemoryInGB: The memory request in GB of this container instance.

    ResourceRequestsARM

    (Appears on:ResourceRequirementsARM)

    Field Description
    cpu
    float64

    Cpu: The CPU request of this container instance.

    gpu
    GpuResourceARM

    Gpu: The GPU resource.

    memoryInGB
    float64

    MemoryInGB: The memory request in GB of this container instance.

    ResourceRequests_Status

    (Appears on:ResourceRequirements_Status)

    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.

    ResourceRequests_StatusARM

    (Appears on:ResourceRequirements_StatusARM)

    Field Description
    cpu
    float64

    Cpu: The CPU request of this container instance.

    gpu
    GpuResource_StatusARM

    Gpu: The GPU request of this container instance.

    memoryInGB
    float64

    MemoryInGB: The memory request in GB of this container instance.

    ResourceRequirements

    (Appears on:ContainerGroups_Spec_Properties_Containers)

    Field Description
    limits
    ResourceLimits

    Limits: The resource limits.

    requests
    ResourceRequests

    Requests: The resource requests.

    ResourceRequirementsARM

    (Appears on:ContainerPropertiesARM)

    Field Description
    limits
    ResourceLimitsARM

    Limits: The resource limits.

    requests
    ResourceRequestsARM

    Requests: The resource requests.

    ResourceRequirements_Status

    (Appears on:Container_Status)

    Field Description
    limits
    ResourceLimits_Status

    Limits: The resource limits of this container instance.

    requests
    ResourceRequests_Status

    Requests: The resource requests of this container instance.

    ResourceRequirements_StatusARM

    (Appears on:ContainerProperties_StatusARM)

    Field Description
    limits
    ResourceLimits_StatusARM

    Limits: The resource limits of this container instance.

    requests
    ResourceRequests_StatusARM

    Requests: The resource requests of this container instance.

    Volume

    (Appears on:ContainerGroups_Spec)

    Field Description
    azureFile
    AzureFileVolume

    AzureFile: The properties of the Azure File volume. Azure File shares are mounted as volumes.

    emptyDir
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    EmptyDir: The empty directory volume.

    gitRepo
    GitRepoVolume

    GitRepo: Represents a volume that is populated with the contents of a git repository

    name
    string

    Name: The name of the volume.

    secret
    map[string]string

    Secret: The secret volume.

    VolumeARM

    (Appears on:ContainerGroups_Spec_PropertiesARM)

    Field Description
    azureFile
    AzureFileVolumeARM

    AzureFile: The properties of the Azure File volume. Azure File shares are mounted as volumes.

    emptyDir
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    EmptyDir: The empty directory volume.

    gitRepo
    GitRepoVolumeARM

    GitRepo: Represents a volume that is populated with the contents of a git repository

    name
    string

    Name: The name of the volume.

    secret
    map[string]string

    Secret: The secret volume.

    VolumeMount

    (Appears on:ContainerGroups_Spec_Properties_Containers, ContainerGroups_Spec_Properties_InitContainers)

    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.

    VolumeMountARM

    (Appears on:ContainerPropertiesARM, InitContainerPropertiesDefinitionARM)

    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)

    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_StatusARM

    (Appears on:ContainerProperties_StatusARM, InitContainerPropertiesDefinition_StatusARM)

    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)

    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.

    Volume_StatusARM

    (Appears on:ContainerGroup_Status_PropertiesARM)

    Field Description
    azureFile
    AzureFileVolume_StatusARM

    AzureFile: The Azure File volume.

    emptyDir
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    EmptyDir: The empty directory volume.

    gitRepo
    GitRepoVolume_StatusARM

    GitRepo: The git repo volume.

    name
    string

    Name: The name of the volume.

    secret
    map[string]string

    Secret: The secret volume.