Azure Native

v1.88.1 published on Thursday, Dec 1, 2022 by Pulumi

getContainerGroup

A container group. API Version: 2021-03-01.

Using getContainerGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getContainerGroup(args: GetContainerGroupArgs, opts?: InvokeOptions): Promise<GetContainerGroupResult>
function getContainerGroupOutput(args: GetContainerGroupOutputArgs, opts?: InvokeOptions): Output<GetContainerGroupResult>
def get_container_group(container_group_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetContainerGroupResult
def get_container_group_output(container_group_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetContainerGroupResult]
func LookupContainerGroup(ctx *Context, args *LookupContainerGroupArgs, opts ...InvokeOption) (*LookupContainerGroupResult, error)
func LookupContainerGroupOutput(ctx *Context, args *LookupContainerGroupOutputArgs, opts ...InvokeOption) LookupContainerGroupResultOutput

> Note: This function is named LookupContainerGroup in the Go SDK.

public static class GetContainerGroup 
{
    public static Task<GetContainerGroupResult> InvokeAsync(GetContainerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerGroupResult> Invoke(GetContainerGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetContainerGroupResult> getContainerGroup(GetContainerGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:containerinstance:getContainerGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

ContainerGroupName string

The name of the container group.

ResourceGroupName string

The name of the resource group.

ContainerGroupName string

The name of the container group.

ResourceGroupName string

The name of the resource group.

containerGroupName String

The name of the container group.

resourceGroupName String

The name of the resource group.

containerGroupName string

The name of the container group.

resourceGroupName string

The name of the resource group.

container_group_name str

The name of the container group.

resource_group_name str

The name of the resource group.

containerGroupName String

The name of the container group.

resourceGroupName String

The name of the resource group.

getContainerGroup Result

The following output properties are available:

Containers List<Pulumi.AzureNative.ContainerInstance.Outputs.ContainerResponse>

The containers within the container group.

Id string

The resource id.

InstanceView Pulumi.AzureNative.ContainerInstance.Outputs.ContainerGroupResponseInstanceView

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

Name string

The resource name.

OsType string

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

ProvisioningState string

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

Type string

The resource type.

Diagnostics Pulumi.AzureNative.ContainerInstance.Outputs.ContainerGroupDiagnosticsResponse

The diagnostic information for a container group.

DnsConfig Pulumi.AzureNative.ContainerInstance.Outputs.DnsConfigurationResponse

The DNS config information for a container group.

EncryptionProperties Pulumi.AzureNative.ContainerInstance.Outputs.EncryptionPropertiesResponse

The encryption properties for a container group.

Identity Pulumi.AzureNative.ContainerInstance.Outputs.ContainerGroupIdentityResponse

The identity of the container group, if configured.

ImageRegistryCredentials List<Pulumi.AzureNative.ContainerInstance.Outputs.ImageRegistryCredentialResponse>

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

InitContainers List<Pulumi.AzureNative.ContainerInstance.Outputs.InitContainerDefinitionResponse>

The init containers for a container group.

IpAddress Pulumi.AzureNative.ContainerInstance.Outputs.IpAddressResponse

The IP address type of the container group.

Location string

The resource location.

NetworkProfile Pulumi.AzureNative.ContainerInstance.Outputs.ContainerGroupNetworkProfileResponse

The network profile information for a container group.

RestartPolicy string

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
Sku string

The SKU for a container group.

Tags Dictionary<string, string>

The resource tags.

Volumes List<Pulumi.AzureNative.ContainerInstance.Outputs.VolumeResponse>

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

Containers []ContainerResponse

The containers within the container group.

Id string

The resource id.

InstanceView ContainerGroupResponseInstanceView

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

Name string

The resource name.

OsType string

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

ProvisioningState string

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

Type string

The resource type.

Diagnostics ContainerGroupDiagnosticsResponse

The diagnostic information for a container group.

DnsConfig DnsConfigurationResponse

The DNS config information for a container group.

EncryptionProperties EncryptionPropertiesResponse

The encryption properties for a container group.

Identity ContainerGroupIdentityResponse

The identity of the container group, if configured.

ImageRegistryCredentials []ImageRegistryCredentialResponse

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

InitContainers []InitContainerDefinitionResponse

The init containers for a container group.

IpAddress IpAddressResponse

The IP address type of the container group.

Location string

The resource location.

NetworkProfile ContainerGroupNetworkProfileResponse

The network profile information for a container group.

RestartPolicy string

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
Sku string

The SKU for a container group.

Tags map[string]string

The resource tags.

Volumes []VolumeResponse

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

containers List<ContainerResponse>

The containers within the container group.

id String

The resource id.

instanceView ContainerGroupResponseInstanceView

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

name String

The resource name.

osType String

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

provisioningState String

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

type String

The resource type.

diagnostics ContainerGroupDiagnosticsResponse

The diagnostic information for a container group.

dnsConfig DnsConfigurationResponse

The DNS config information for a container group.

encryptionProperties EncryptionPropertiesResponse

The encryption properties for a container group.

identity ContainerGroupIdentityResponse

The identity of the container group, if configured.

imageRegistryCredentials List<ImageRegistryCredentialResponse>

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

initContainers List<InitContainerDefinitionResponse>

The init containers for a container group.

ipAddress IpAddressResponse

The IP address type of the container group.

location String

The resource location.

networkProfile ContainerGroupNetworkProfileResponse

The network profile information for a container group.

restartPolicy String

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
sku String

The SKU for a container group.

tags Map<String,String>

The resource tags.

volumes List<VolumeResponse>

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

containers ContainerResponse[]

The containers within the container group.

id string

The resource id.

instanceView ContainerGroupResponseInstanceView

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

name string

The resource name.

osType string

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

provisioningState string

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

type string

The resource type.

diagnostics ContainerGroupDiagnosticsResponse

The diagnostic information for a container group.

dnsConfig DnsConfigurationResponse

The DNS config information for a container group.

encryptionProperties EncryptionPropertiesResponse

The encryption properties for a container group.

identity ContainerGroupIdentityResponse

The identity of the container group, if configured.

imageRegistryCredentials ImageRegistryCredentialResponse[]

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

initContainers InitContainerDefinitionResponse[]

The init containers for a container group.

ipAddress IpAddressResponse

The IP address type of the container group.

location string

The resource location.

networkProfile ContainerGroupNetworkProfileResponse

The network profile information for a container group.

restartPolicy string

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
sku string

The SKU for a container group.

tags {[key: string]: string}

The resource tags.

volumes VolumeResponse[]

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

containers Sequence[ContainerResponse]

The containers within the container group.

id str

The resource id.

instance_view ContainerGroupResponseInstanceView

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

name str

The resource name.

os_type str

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

provisioning_state str

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

type str

The resource type.

diagnostics ContainerGroupDiagnosticsResponse

The diagnostic information for a container group.

dns_config DnsConfigurationResponse

The DNS config information for a container group.

encryption_properties EncryptionPropertiesResponse

The encryption properties for a container group.

identity ContainerGroupIdentityResponse

The identity of the container group, if configured.

image_registry_credentials Sequence[ImageRegistryCredentialResponse]

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

init_containers Sequence[InitContainerDefinitionResponse]

The init containers for a container group.

ip_address IpAddressResponse

The IP address type of the container group.

location str

The resource location.

network_profile ContainerGroupNetworkProfileResponse

The network profile information for a container group.

restart_policy str

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
sku str

The SKU for a container group.

tags Mapping[str, str]

The resource tags.

volumes Sequence[VolumeResponse]

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

containers List<Property Map>

The containers within the container group.

id String

The resource id.

instanceView Property Map

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

name String

The resource name.

osType String

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

provisioningState String

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

type String

The resource type.

diagnostics Property Map

The diagnostic information for a container group.

dnsConfig Property Map

The DNS config information for a container group.

encryptionProperties Property Map

The encryption properties for a container group.

identity Property Map

The identity of the container group, if configured.

imageRegistryCredentials List<Property Map>

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

initContainers List<Property Map>

The init containers for a container group.

ipAddress Property Map

The IP address type of the container group.

location String

The resource location.

networkProfile Property Map

The network profile information for a container group.

restartPolicy String

Restart policy for all containers within the container group.

  • Always Always restart
  • OnFailure Restart on failure
  • Never Never restart
sku String

The SKU for a container group.

tags Map<String>

The resource tags.

volumes List<Property Map>

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

Supporting Types

AzureFileVolumeResponse

ShareName string

The name of the Azure File share to be mounted as a volume.

StorageAccountName string

The name of the storage account that contains the Azure File share.

ReadOnly bool

The flag indicating whether the Azure File shared mounted as a volume is read-only.

StorageAccountKey string

The storage account access key used to access the Azure File share.

ShareName string

The name of the Azure File share to be mounted as a volume.

StorageAccountName string

The name of the storage account that contains the Azure File share.

ReadOnly bool

The flag indicating whether the Azure File shared mounted as a volume is read-only.

StorageAccountKey string

The storage account access key used to access the Azure File share.

shareName String

The name of the Azure File share to be mounted as a volume.

storageAccountName String

The name of the storage account that contains the Azure File share.

readOnly Boolean

The flag indicating whether the Azure File shared mounted as a volume is read-only.

storageAccountKey String

The storage account access key used to access the Azure File share.

shareName string

The name of the Azure File share to be mounted as a volume.

storageAccountName string

The name of the storage account that contains the Azure File share.

readOnly boolean

The flag indicating whether the Azure File shared mounted as a volume is read-only.

storageAccountKey string

The storage account access key used to access the Azure File share.

share_name str

The name of the Azure File share to be mounted as a volume.

storage_account_name str

The name of the storage account that contains the Azure File share.

read_only bool

The flag indicating whether the Azure File shared mounted as a volume is read-only.

storage_account_key str

The storage account access key used to access the Azure File share.

shareName String

The name of the Azure File share to be mounted as a volume.

storageAccountName String

The name of the storage account that contains the Azure File share.

readOnly Boolean

The flag indicating whether the Azure File shared mounted as a volume is read-only.

storageAccountKey String

The storage account access key used to access the Azure File share.

ContainerExecResponse

Command List<string>

The commands to execute within the container.

Command []string

The commands to execute within the container.

command List<String>

The commands to execute within the container.

command string[]

The commands to execute within the container.

command Sequence[str]

The commands to execute within the container.

command List<String>

The commands to execute within the container.

ContainerGroupDiagnosticsResponse

LogAnalytics LogAnalyticsResponse

Container group log analytics information.

logAnalytics LogAnalyticsResponse

Container group log analytics information.

logAnalytics LogAnalyticsResponse

Container group log analytics information.

log_analytics LogAnalyticsResponse

Container group log analytics information.

logAnalytics Property Map

Container group log analytics information.

ContainerGroupIdentityResponse

PrincipalId string

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

TenantId string

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

Type string

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 Dictionary<string, Pulumi.AzureNative.ContainerInstance.Inputs.ContainerGroupIdentityResponseUserAssignedIdentities>

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}'.

PrincipalId string

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

TenantId string

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

Type string

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]ContainerGroupIdentityResponseUserAssignedIdentities

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}'.

principalId String

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

tenantId String

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

type String

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,ContainerGroupIdentityResponseUserAssignedIdentities>

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}'.

principalId string

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

tenantId string

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

type string

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 {[key: string]: ContainerGroupIdentityResponseUserAssignedIdentities}

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}'.

principal_id str

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

tenant_id str

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

type str

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.

user_assigned_identities Mapping[str, ContainerGroupIdentityResponseUserAssignedIdentities]

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}'.

principalId String

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

tenantId String

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

type String

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<Property Map>

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}'.

ContainerGroupIdentityResponseUserAssignedIdentities

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId string

The principal id of user assigned identity.

client_id str

The client id of user assigned identity.

principal_id str

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

ContainerGroupNetworkProfileResponse

Id string

The identifier for a network profile.

Id string

The identifier for a network profile.

id String

The identifier for a network profile.

id string

The identifier for a network profile.

id str

The identifier for a network profile.

id String

The identifier for a network profile.

ContainerGroupResponseInstanceView

Events List<Pulumi.AzureNative.ContainerInstance.Inputs.EventResponse>

The events of this container group.

State string

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

Events []EventResponse

The events of this container group.

State string

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

events List<EventResponse>

The events of this container group.

state String

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

events EventResponse[]

The events of this container group.

state string

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

events Sequence[EventResponse]

The events of this container group.

state str

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

events List<Property Map>

The events of this container group.

state String

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

ContainerHttpGetResponse

Port int

The port number to probe.

HttpHeaders List<Pulumi.AzureNative.ContainerInstance.Inputs.HttpHeaderResponse>

The HTTP headers.

Path string

The path to probe.

Scheme string

The scheme.

Port int

The port number to probe.

HttpHeaders []HttpHeaderResponse

The HTTP headers.

Path string

The path to probe.

Scheme string

The scheme.

port Integer

The port number to probe.

httpHeaders List<HttpHeaderResponse>

The HTTP headers.

path String

The path to probe.

scheme String

The scheme.

port number

The port number to probe.

httpHeaders HttpHeaderResponse[]

The HTTP headers.

path string

The path to probe.

scheme string

The scheme.

port int

The port number to probe.

http_headers Sequence[HttpHeaderResponse]

The HTTP headers.

path str

The path to probe.

scheme str

The scheme.

port Number

The port number to probe.

httpHeaders List<Property Map>

The HTTP headers.

path String

The path to probe.

scheme String

The scheme.

ContainerPortResponse

Port int

The port number exposed within the container group.

Protocol string

The protocol associated with the port.

Port int

The port number exposed within the container group.

Protocol string

The protocol associated with the port.

port Integer

The port number exposed within the container group.

protocol String

The protocol associated with the port.

port number

The port number exposed within the container group.

protocol string

The protocol associated with the port.

port int

The port number exposed within the container group.

protocol str

The protocol associated with the port.

port Number

The port number exposed within the container group.

protocol String

The protocol associated with the port.

ContainerProbeResponse

Exec Pulumi.AzureNative.ContainerInstance.Inputs.ContainerExecResponse

The execution command to probe

FailureThreshold int

The failure threshold.

HttpGet Pulumi.AzureNative.ContainerInstance.Inputs.ContainerHttpGetResponse

The Http Get settings to probe

InitialDelaySeconds int

The initial delay seconds.

PeriodSeconds int

The period seconds.

SuccessThreshold int

The success threshold.

TimeoutSeconds int

The timeout seconds.

Exec ContainerExecResponse

The execution command to probe

FailureThreshold int

The failure threshold.

HttpGet ContainerHttpGetResponse

The Http Get settings to probe

InitialDelaySeconds int

The initial delay seconds.

PeriodSeconds int

The period seconds.

SuccessThreshold int

The success threshold.

TimeoutSeconds int

The timeout seconds.

exec ContainerExecResponse

The execution command to probe

failureThreshold Integer

The failure threshold.

httpGet ContainerHttpGetResponse

The Http Get settings to probe

initialDelaySeconds Integer

The initial delay seconds.

periodSeconds Integer

The period seconds.

successThreshold Integer

The success threshold.

timeoutSeconds Integer

The timeout seconds.

exec ContainerExecResponse

The execution command to probe

failureThreshold number

The failure threshold.

httpGet ContainerHttpGetResponse

The Http Get settings to probe

initialDelaySeconds number

The initial delay seconds.

periodSeconds number

The period seconds.

successThreshold number

The success threshold.

timeoutSeconds number

The timeout seconds.

exec_ ContainerExecResponse

The execution command to probe

failure_threshold int

The failure threshold.

http_get ContainerHttpGetResponse

The Http Get settings to probe

initial_delay_seconds int

The initial delay seconds.

period_seconds int

The period seconds.

success_threshold int

The success threshold.

timeout_seconds int

The timeout seconds.

exec Property Map

The execution command to probe

failureThreshold Number

The failure threshold.

httpGet Property Map

The Http Get settings to probe

initialDelaySeconds Number

The initial delay seconds.

periodSeconds Number

The period seconds.

successThreshold Number

The success threshold.

timeoutSeconds Number

The timeout seconds.

ContainerPropertiesResponseInstanceView

CurrentState Pulumi.AzureNative.ContainerInstance.Inputs.ContainerStateResponse

Current container instance state.

Events List<Pulumi.AzureNative.ContainerInstance.Inputs.EventResponse>

The events of the container instance.

PreviousState Pulumi.AzureNative.ContainerInstance.Inputs.ContainerStateResponse

Previous container instance state.

RestartCount int

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

CurrentState ContainerStateResponse

Current container instance state.

Events []EventResponse

The events of the container instance.

PreviousState ContainerStateResponse

Previous container instance state.

RestartCount int

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

currentState ContainerStateResponse

Current container instance state.

events List<EventResponse>

The events of the container instance.

previousState ContainerStateResponse

Previous container instance state.

restartCount Integer

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

currentState ContainerStateResponse

Current container instance state.

events EventResponse[]

The events of the container instance.

previousState ContainerStateResponse

Previous container instance state.

restartCount number

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

current_state ContainerStateResponse

Current container instance state.

events Sequence[EventResponse]

The events of the container instance.

previous_state ContainerStateResponse

Previous container instance state.

restart_count int

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

currentState Property Map

Current container instance state.

events List<Property Map>

The events of the container instance.

previousState Property Map

Previous container instance state.

restartCount Number

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

ContainerResponse

Image string

The name of the image used to create the container instance.

InstanceView Pulumi.AzureNative.ContainerInstance.Inputs.ContainerPropertiesResponseInstanceView

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

Name string

The user-provided name of the container instance.

Resources Pulumi.AzureNative.ContainerInstance.Inputs.ResourceRequirementsResponse

The resource requirements of the container instance.

Command List<string>

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

EnvironmentVariables List<Pulumi.AzureNative.ContainerInstance.Inputs.EnvironmentVariableResponse>

The environment variables to set in the container instance.

LivenessProbe Pulumi.AzureNative.ContainerInstance.Inputs.ContainerProbeResponse

The liveness probe.

Ports List<Pulumi.AzureNative.ContainerInstance.Inputs.ContainerPortResponse>

The exposed ports on the container instance.

ReadinessProbe Pulumi.AzureNative.ContainerInstance.Inputs.ContainerProbeResponse

The readiness probe.

VolumeMounts List<Pulumi.AzureNative.ContainerInstance.Inputs.VolumeMountResponse>

The volume mounts available to the container instance.

Image string

The name of the image used to create the container instance.

InstanceView ContainerPropertiesResponseInstanceView

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

Name string

The user-provided name of the container instance.

Resources ResourceRequirementsResponse

The resource requirements of the container instance.

Command []string

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

EnvironmentVariables []EnvironmentVariableResponse

The environment variables to set in the container instance.

LivenessProbe ContainerProbeResponse

The liveness probe.

Ports []ContainerPortResponse

The exposed ports on the container instance.

ReadinessProbe ContainerProbeResponse

The readiness probe.

VolumeMounts []VolumeMountResponse

The volume mounts available to the container instance.

image String

The name of the image used to create the container instance.

instanceView ContainerPropertiesResponseInstanceView

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

name String

The user-provided name of the container instance.

resources ResourceRequirementsResponse

The resource requirements of the container instance.

command List<String>

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

environmentVariables List<EnvironmentVariableResponse>

The environment variables to set in the container instance.

livenessProbe ContainerProbeResponse

The liveness probe.

ports List<ContainerPortResponse>

The exposed ports on the container instance.

readinessProbe ContainerProbeResponse

The readiness probe.

volumeMounts List<VolumeMountResponse>

The volume mounts available to the container instance.

image string

The name of the image used to create the container instance.

instanceView ContainerPropertiesResponseInstanceView

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

name string

The user-provided name of the container instance.

resources ResourceRequirementsResponse

The resource requirements of the container instance.

command string[]

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

environmentVariables EnvironmentVariableResponse[]

The environment variables to set in the container instance.

livenessProbe ContainerProbeResponse

The liveness probe.

ports ContainerPortResponse[]

The exposed ports on the container instance.

readinessProbe ContainerProbeResponse

The readiness probe.

volumeMounts VolumeMountResponse[]

The volume mounts available to the container instance.

image str

The name of the image used to create the container instance.

instance_view ContainerPropertiesResponseInstanceView

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

name str

The user-provided name of the container instance.

resources ResourceRequirementsResponse

The resource requirements of the container instance.

command Sequence[str]

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

environment_variables Sequence[EnvironmentVariableResponse]

The environment variables to set in the container instance.

liveness_probe ContainerProbeResponse

The liveness probe.

ports Sequence[ContainerPortResponse]

The exposed ports on the container instance.

readiness_probe ContainerProbeResponse

The readiness probe.

volume_mounts Sequence[VolumeMountResponse]

The volume mounts available to the container instance.

image String

The name of the image used to create the container instance.

instanceView Property Map

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

name String

The user-provided name of the container instance.

resources Property Map

The resource requirements of the container instance.

command List<String>

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

environmentVariables List<Property Map>

The environment variables to set in the container instance.

livenessProbe Property Map

The liveness probe.

ports List<Property Map>

The exposed ports on the container instance.

readinessProbe Property Map

The readiness probe.

volumeMounts List<Property Map>

The volume mounts available to the container instance.

ContainerStateResponse

DetailStatus string

The human-readable status of the container instance state.

ExitCode int

The container instance exit codes correspond to those from the docker run command.

FinishTime string

The date-time when the container instance state finished.

StartTime string

The date-time when the container instance state started.

State string

The state of the container instance.

DetailStatus string

The human-readable status of the container instance state.

ExitCode int

The container instance exit codes correspond to those from the docker run command.

FinishTime string

The date-time when the container instance state finished.

StartTime string

The date-time when the container instance state started.

State string

The state of the container instance.

detailStatus String

The human-readable status of the container instance state.

exitCode Integer

The container instance exit codes correspond to those from the docker run command.

finishTime String

The date-time when the container instance state finished.

startTime String

The date-time when the container instance state started.

state String

The state of the container instance.

detailStatus string

The human-readable status of the container instance state.

exitCode number

The container instance exit codes correspond to those from the docker run command.

finishTime string

The date-time when the container instance state finished.

startTime string

The date-time when the container instance state started.

state string

The state of the container instance.

detail_status str

The human-readable status of the container instance state.

exit_code int

The container instance exit codes correspond to those from the docker run command.

finish_time str

The date-time when the container instance state finished.

start_time str

The date-time when the container instance state started.

state str

The state of the container instance.

detailStatus String

The human-readable status of the container instance state.

exitCode Number

The container instance exit codes correspond to those from the docker run command.

finishTime String

The date-time when the container instance state finished.

startTime String

The date-time when the container instance state started.

state String

The state of the container instance.

DnsConfigurationResponse

NameServers List<string>

The DNS servers for the container group.

Options string

The DNS options for the container group.

SearchDomains string

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

NameServers []string

The DNS servers for the container group.

Options string

The DNS options for the container group.

SearchDomains string

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

nameServers List<String>

The DNS servers for the container group.

options String

The DNS options for the container group.

searchDomains String

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

nameServers string[]

The DNS servers for the container group.

options string

The DNS options for the container group.

searchDomains string

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

name_servers Sequence[str]

The DNS servers for the container group.

options str

The DNS options for the container group.

search_domains str

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

nameServers List<String>

The DNS servers for the container group.

options String

The DNS options for the container group.

searchDomains String

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

EncryptionPropertiesResponse

KeyName string

The encryption key name.

KeyVersion string

The encryption key version.

VaultBaseUrl string

The keyvault base url.

KeyName string

The encryption key name.

KeyVersion string

The encryption key version.

VaultBaseUrl string

The keyvault base url.

keyName String

The encryption key name.

keyVersion String

The encryption key version.

vaultBaseUrl String

The keyvault base url.

keyName string

The encryption key name.

keyVersion string

The encryption key version.

vaultBaseUrl string

The keyvault base url.

key_name str

The encryption key name.

key_version str

The encryption key version.

vault_base_url str

The keyvault base url.

keyName String

The encryption key name.

keyVersion String

The encryption key version.

vaultBaseUrl String

The keyvault base url.

EnvironmentVariableResponse

Name string

The name of the environment variable.

SecureValue string

The value of the secure environment variable.

Value string

The value of the environment variable.

Name string

The name of the environment variable.

SecureValue string

The value of the secure environment variable.

Value string

The value of the environment variable.

name String

The name of the environment variable.

secureValue String

The value of the secure environment variable.

value String

The value of the environment variable.

name string

The name of the environment variable.

secureValue string

The value of the secure environment variable.

value string

The value of the environment variable.

name str

The name of the environment variable.

secure_value str

The value of the secure environment variable.

value str

The value of the environment variable.

name String

The name of the environment variable.

secureValue String

The value of the secure environment variable.

value String

The value of the environment variable.

EventResponse

Count int

The count of the event.

FirstTimestamp string

The date-time of the earliest logged event.

LastTimestamp string

The date-time of the latest logged event.

Message string

The event message.

Name string

The event name.

Type string

The event type.

Count int

The count of the event.

FirstTimestamp string

The date-time of the earliest logged event.

LastTimestamp string

The date-time of the latest logged event.

Message string

The event message.

Name string

The event name.

Type string

The event type.

count Integer

The count of the event.

firstTimestamp String

The date-time of the earliest logged event.

lastTimestamp String

The date-time of the latest logged event.

message String

The event message.

name String

The event name.

type String

The event type.

count number

The count of the event.

firstTimestamp string

The date-time of the earliest logged event.

lastTimestamp string

The date-time of the latest logged event.

message string

The event message.

name string

The event name.

type string

The event type.

count int

The count of the event.

first_timestamp str

The date-time of the earliest logged event.

last_timestamp str

The date-time of the latest logged event.

message str

The event message.

name str

The event name.

type str

The event type.

count Number

The count of the event.

firstTimestamp String

The date-time of the earliest logged event.

lastTimestamp String

The date-time of the latest logged event.

message String

The event message.

name String

The event name.

type String

The event type.

GitRepoVolumeResponse

Repository string

Repository URL

Directory string

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.

Revision string

Commit hash for the specified revision.

Repository string

Repository URL

Directory string

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.

Revision string

Commit hash for the specified revision.

repository String

Repository URL

directory String

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.

revision String

Commit hash for the specified revision.

repository string

Repository URL

directory string

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.

revision string

Commit hash for the specified revision.

repository str

Repository URL

directory str

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.

revision str

Commit hash for the specified revision.

repository String

Repository URL

directory String

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.

revision String

Commit hash for the specified revision.

GpuResourceResponse

Count int

The count of the GPU resource.

Sku string

The SKU of the GPU resource.

Count int

The count of the GPU resource.

Sku string

The SKU of the GPU resource.

count Integer

The count of the GPU resource.

sku String

The SKU of the GPU resource.

count number

The count of the GPU resource.

sku string

The SKU of the GPU resource.

count int

The count of the GPU resource.

sku str

The SKU of the GPU resource.

count Number

The count of the GPU resource.

sku String

The SKU of the GPU resource.

HttpHeaderResponse

Name string

The header name.

Value string

The header value.

Name string

The header name.

Value string

The header value.

name String

The header name.

value String

The header value.

name string

The header name.

value string

The header value.

name str

The header name.

value str

The header value.

name String

The header name.

value String

The header value.

ImageRegistryCredentialResponse

Server string

The Docker image registry server without a protocol such as "http" and "https".

Username string

The username for the private registry.

Password string

The password for the private registry.

Server string

The Docker image registry server without a protocol such as "http" and "https".

Username string

The username for the private registry.

Password string

The password for the private registry.

server String

The Docker image registry server without a protocol such as "http" and "https".

username String

The username for the private registry.

password String

The password for the private registry.

server string

The Docker image registry server without a protocol such as "http" and "https".

username string

The username for the private registry.

password string

The password for the private registry.

server str

The Docker image registry server without a protocol such as "http" and "https".

username str

The username for the private registry.

password str

The password for the private registry.

server String

The Docker image registry server without a protocol such as "http" and "https".

username String

The username for the private registry.

password String

The password for the private registry.

InitContainerDefinitionResponse

InstanceView Pulumi.AzureNative.ContainerInstance.Inputs.InitContainerPropertiesDefinitionResponseInstanceView

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

Name string

The name for the init container.

Command List<string>

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

EnvironmentVariables List<Pulumi.AzureNative.ContainerInstance.Inputs.EnvironmentVariableResponse>

The environment variables to set in the init container.

Image string

The image of the init container.

VolumeMounts List<Pulumi.AzureNative.ContainerInstance.Inputs.VolumeMountResponse>

The volume mounts available to the init container.

InstanceView InitContainerPropertiesDefinitionResponseInstanceView

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

Name string

The name for the init container.

Command []string

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

EnvironmentVariables []EnvironmentVariableResponse

The environment variables to set in the init container.

Image string

The image of the init container.

VolumeMounts []VolumeMountResponse

The volume mounts available to the init container.

instanceView InitContainerPropertiesDefinitionResponseInstanceView

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

name String

The name for the init container.

command List<String>

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

environmentVariables List<EnvironmentVariableResponse>

The environment variables to set in the init container.

image String

The image of the init container.

volumeMounts List<VolumeMountResponse>

The volume mounts available to the init container.

instanceView InitContainerPropertiesDefinitionResponseInstanceView

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

name string

The name for the init container.

command string[]

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

environmentVariables EnvironmentVariableResponse[]

The environment variables to set in the init container.

image string

The image of the init container.

volumeMounts VolumeMountResponse[]

The volume mounts available to the init container.

instance_view InitContainerPropertiesDefinitionResponseInstanceView

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

name str

The name for the init container.

command Sequence[str]

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

environment_variables Sequence[EnvironmentVariableResponse]

The environment variables to set in the init container.

image str

The image of the init container.

volume_mounts Sequence[VolumeMountResponse]

The volume mounts available to the init container.

instanceView Property Map

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

name String

The name for the init container.

command List<String>

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

environmentVariables List<Property Map>

The environment variables to set in the init container.

image String

The image of the init container.

volumeMounts List<Property Map>

The volume mounts available to the init container.

InitContainerPropertiesDefinitionResponseInstanceView

CurrentState Pulumi.AzureNative.ContainerInstance.Inputs.ContainerStateResponse

The current state of the init container.

Events List<Pulumi.AzureNative.ContainerInstance.Inputs.EventResponse>

The events of the init container.

PreviousState Pulumi.AzureNative.ContainerInstance.Inputs.ContainerStateResponse

The previous state of the init container.

RestartCount int

The number of times that the init container has been restarted.

CurrentState ContainerStateResponse

The current state of the init container.

Events []EventResponse

The events of the init container.

PreviousState ContainerStateResponse

The previous state of the init container.

RestartCount int

The number of times that the init container has been restarted.

currentState ContainerStateResponse

The current state of the init container.

events List<EventResponse>

The events of the init container.

previousState ContainerStateResponse

The previous state of the init container.

restartCount Integer

The number of times that the init container has been restarted.

currentState ContainerStateResponse

The current state of the init container.

events EventResponse[]

The events of the init container.

previousState ContainerStateResponse

The previous state of the init container.

restartCount number

The number of times that the init container has been restarted.

current_state ContainerStateResponse

The current state of the init container.

events Sequence[EventResponse]

The events of the init container.

previous_state ContainerStateResponse

The previous state of the init container.

restart_count int

The number of times that the init container has been restarted.

currentState Property Map

The current state of the init container.

events List<Property Map>

The events of the init container.

previousState Property Map

The previous state of the init container.

restartCount Number

The number of times that the init container has been restarted.

IpAddressResponse

Fqdn string

The FQDN for the IP.

Ports List<Pulumi.AzureNative.ContainerInstance.Inputs.PortResponse>

The list of ports exposed on the container group.

Type string

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

DnsNameLabel string

The Dns name label for the IP.

Ip string

The IP exposed to the public internet.

Fqdn string

The FQDN for the IP.

Ports []PortResponse

The list of ports exposed on the container group.

Type string

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

DnsNameLabel string

The Dns name label for the IP.

Ip string

The IP exposed to the public internet.

fqdn String

The FQDN for the IP.

ports List<PortResponse>

The list of ports exposed on the container group.

type String

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

dnsNameLabel String

The Dns name label for the IP.

ip String

The IP exposed to the public internet.

fqdn string

The FQDN for the IP.

ports PortResponse[]

The list of ports exposed on the container group.

type string

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

dnsNameLabel string

The Dns name label for the IP.

ip string

The IP exposed to the public internet.

fqdn str

The FQDN for the IP.

ports Sequence[PortResponse]

The list of ports exposed on the container group.

type str

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

dns_name_label str

The Dns name label for the IP.

ip str

The IP exposed to the public internet.

fqdn String

The FQDN for the IP.

ports List<Property Map>

The list of ports exposed on the container group.

type String

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

dnsNameLabel String

The Dns name label for the IP.

ip String

The IP exposed to the public internet.

LogAnalyticsResponse

WorkspaceId string

The workspace id for log analytics

WorkspaceKey string

The workspace key for log analytics

LogType string

The log type to be used.

Metadata Dictionary<string, string>

Metadata for log analytics.

WorkspaceResourceId Dictionary<string, string>

The workspace resource id for log analytics

WorkspaceId string

The workspace id for log analytics

WorkspaceKey string

The workspace key for log analytics

LogType string

The log type to be used.

Metadata map[string]string

Metadata for log analytics.

WorkspaceResourceId map[string]string

The workspace resource id for log analytics

workspaceId String

The workspace id for log analytics

workspaceKey String

The workspace key for log analytics

logType String

The log type to be used.

metadata Map<String,String>

Metadata for log analytics.

workspaceResourceId Map<String,String>

The workspace resource id for log analytics

workspaceId string

The workspace id for log analytics

workspaceKey string

The workspace key for log analytics

logType string

The log type to be used.

metadata {[key: string]: string}

Metadata for log analytics.

workspaceResourceId {[key: string]: string}

The workspace resource id for log analytics

workspace_id str

The workspace id for log analytics

workspace_key str

The workspace key for log analytics

log_type str

The log type to be used.

metadata Mapping[str, str]

Metadata for log analytics.

workspace_resource_id Mapping[str, str]

The workspace resource id for log analytics

workspaceId String

The workspace id for log analytics

workspaceKey String

The workspace key for log analytics

logType String

The log type to be used.

metadata Map<String>

Metadata for log analytics.

workspaceResourceId Map<String>

The workspace resource id for log analytics

PortResponse

Port int

The port number.

Protocol string

The protocol associated with the port.

Port int

The port number.

Protocol string

The protocol associated with the port.

port Integer

The port number.

protocol String

The protocol associated with the port.

port number

The port number.

protocol string

The protocol associated with the port.

port int

The port number.

protocol str

The protocol associated with the port.

port Number

The port number.

protocol String

The protocol associated with the port.

ResourceLimitsResponse

Cpu double

The CPU limit of this container instance.

Gpu Pulumi.AzureNative.ContainerInstance.Inputs.GpuResourceResponse

The GPU limit of this container instance.

MemoryInGB double

The memory limit in GB of this container instance.

Cpu float64

The CPU limit of this container instance.

Gpu GpuResourceResponse

The GPU limit of this container instance.

MemoryInGB float64

The memory limit in GB of this container instance.

cpu Double

The CPU limit of this container instance.

gpu GpuResourceResponse

The GPU limit of this container instance.

memoryInGB Double

The memory limit in GB of this container instance.

cpu number

The CPU limit of this container instance.

gpu GpuResourceResponse

The GPU limit of this container instance.

memoryInGB number

The memory limit in GB of this container instance.

cpu float

The CPU limit of this container instance.

gpu GpuResourceResponse

The GPU limit of this container instance.

memory_in_gb float

The memory limit in GB of this container instance.

cpu Number

The CPU limit of this container instance.

gpu Property Map

The GPU limit of this container instance.

memoryInGB Number

The memory limit in GB of this container instance.

ResourceRequestsResponse

Cpu double

The CPU request of this container instance.

MemoryInGB double

The memory request in GB of this container instance.

Gpu Pulumi.AzureNative.ContainerInstance.Inputs.GpuResourceResponse

The GPU request of this container instance.

Cpu float64

The CPU request of this container instance.

MemoryInGB float64

The memory request in GB of this container instance.

Gpu GpuResourceResponse

The GPU request of this container instance.

cpu Double

The CPU request of this container instance.

memoryInGB Double

The memory request in GB of this container instance.

gpu GpuResourceResponse

The GPU request of this container instance.

cpu number

The CPU request of this container instance.

memoryInGB number

The memory request in GB of this container instance.

gpu GpuResourceResponse

The GPU request of this container instance.

cpu float

The CPU request of this container instance.

memory_in_gb float

The memory request in GB of this container instance.

gpu GpuResourceResponse

The GPU request of this container instance.

cpu Number

The CPU request of this container instance.

memoryInGB Number

The memory request in GB of this container instance.

gpu Property Map

The GPU request of this container instance.

ResourceRequirementsResponse

Requests ResourceRequestsResponse

The resource requests of this container instance.

Limits ResourceLimitsResponse

The resource limits of this container instance.

requests ResourceRequestsResponse

The resource requests of this container instance.

limits ResourceLimitsResponse

The resource limits of this container instance.

requests ResourceRequestsResponse

The resource requests of this container instance.

limits ResourceLimitsResponse

The resource limits of this container instance.

requests ResourceRequestsResponse

The resource requests of this container instance.

limits ResourceLimitsResponse

The resource limits of this container instance.

requests Property Map

The resource requests of this container instance.

limits Property Map

The resource limits of this container instance.

VolumeMountResponse

MountPath string

The path within the container where the volume should be mounted. Must not contain colon (:).

Name string

The name of the volume mount.

ReadOnly bool

The flag indicating whether the volume mount is read-only.

MountPath string

The path within the container where the volume should be mounted. Must not contain colon (:).

Name string

The name of the volume mount.

ReadOnly bool

The flag indicating whether the volume mount is read-only.

mountPath String

The path within the container where the volume should be mounted. Must not contain colon (:).

name String

The name of the volume mount.

readOnly Boolean

The flag indicating whether the volume mount is read-only.

mountPath string

The path within the container where the volume should be mounted. Must not contain colon (:).

name string

The name of the volume mount.

readOnly boolean

The flag indicating whether the volume mount is read-only.

mount_path str

The path within the container where the volume should be mounted. Must not contain colon (:).

name str

The name of the volume mount.

read_only bool

The flag indicating whether the volume mount is read-only.

mountPath String

The path within the container where the volume should be mounted. Must not contain colon (:).

name String

The name of the volume mount.

readOnly Boolean

The flag indicating whether the volume mount is read-only.

VolumeResponse

Name string

The name of the volume.

AzureFile Pulumi.AzureNative.ContainerInstance.Inputs.AzureFileVolumeResponse

The Azure File volume.

EmptyDir object

The empty directory volume.

GitRepo Pulumi.AzureNative.ContainerInstance.Inputs.GitRepoVolumeResponse

The git repo volume.

Secret Dictionary<string, string>

The secret volume.

Name string

The name of the volume.

AzureFile AzureFileVolumeResponse

The Azure File volume.

EmptyDir interface{}

The empty directory volume.

GitRepo GitRepoVolumeResponse

The git repo volume.

Secret map[string]string

The secret volume.

name String

The name of the volume.

azureFile AzureFileVolumeResponse

The Azure File volume.

emptyDir Object

The empty directory volume.

gitRepo GitRepoVolumeResponse

The git repo volume.

secret Map<String,String>

The secret volume.

name string

The name of the volume.

azureFile AzureFileVolumeResponse

The Azure File volume.

emptyDir any

The empty directory volume.

gitRepo GitRepoVolumeResponse

The git repo volume.

secret {[key: string]: string}

The secret volume.

name str

The name of the volume.

azure_file AzureFileVolumeResponse

The Azure File volume.

empty_dir Any

The empty directory volume.

git_repo GitRepoVolumeResponse

The git repo volume.

secret Mapping[str, str]

The secret volume.

name String

The name of the volume.

azureFile Property Map

The Azure File volume.

emptyDir Any

The empty directory volume.

gitRepo Property Map

The git repo volume.

secret Map<String>

The secret volume.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0