container_apps

Creates, updates, deletes, gets or lists a container_apps resource.

Overview

Name	container_apps
Type	Resource
Id	azure.app_containers.container_apps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configuration	object	Non versioned Container App configuration properties.
customDomainVerificationId	string	Id used to verify domain name ownership.
environmentId	string	Resource ID of environment.
eventStreamEndpoint	string	The endpoint of the eventstream of the container app.
extendedLocation	object	The complex type of the extended location.
identity	object	managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.
kind	string	Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp. Known values are: "workflowapp" and "functionapp". (workflowapp, functionapp)
latestReadyRevisionName	string	Name of the latest ready revision of the Container App.
latestRevisionFqdn	string	Fully Qualified Domain Name of the latest revision of the Container App.
latestRevisionName	string	Name of the latest revision of the Container App.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managedEnvironmentId	string	Deprecated. Resource ID of the Container App's environment.
outboundIpAddresses	array	Outbound IP Addresses for container app.
provisioningState	string	Provisioning state of the Container App. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
runningStatus	string	Running status of the Container App. Known values are: "Progressing", "Running", "Stopped", "Suspended", and "Ready". (Progressing, Running, Stopped, Suspended, Ready)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	Container App versioned application definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadProfileName	string	Workload profile name to pin for container app execution.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configuration	object	Non versioned Container App configuration properties.
customDomainVerificationId	string	Id used to verify domain name ownership.
environmentId	string	Resource ID of environment.
eventStreamEndpoint	string	The endpoint of the eventstream of the container app.
extendedLocation	object	The complex type of the extended location.
identity	object	managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.
kind	string	Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp. Known values are: "workflowapp" and "functionapp". (workflowapp, functionapp)
latestReadyRevisionName	string	Name of the latest ready revision of the Container App.
latestRevisionFqdn	string	Fully Qualified Domain Name of the latest revision of the Container App.
latestRevisionName	string	Name of the latest revision of the Container App.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managedEnvironmentId	string	Deprecated. Resource ID of the Container App's environment.
outboundIpAddresses	array	Outbound IP Addresses for container app.
provisioningState	string	Provisioning state of the Container App. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
runningStatus	string	Running status of the Container App. Known values are: "Progressing", "Running", "Stopped", "Suspended", and "Ready". (Progressing, Running, Stopped, Suspended, Ready)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	Container App versioned application definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadProfileName	string	Workload profile name to pin for container app execution.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configuration	object	Non versioned Container App configuration properties.
customDomainVerificationId	string	Id used to verify domain name ownership.
environmentId	string	Resource ID of environment.
eventStreamEndpoint	string	The endpoint of the eventstream of the container app.
extendedLocation	object	The complex type of the extended location.
identity	object	managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.
kind	string	Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp. Known values are: "workflowapp" and "functionapp". (workflowapp, functionapp)
latestReadyRevisionName	string	Name of the latest ready revision of the Container App.
latestRevisionFqdn	string	Fully Qualified Domain Name of the latest revision of the Container App.
latestRevisionName	string	Name of the latest revision of the Container App.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managedEnvironmentId	string	Deprecated. Resource ID of the Container App's environment.
outboundIpAddresses	array	Outbound IP Addresses for container app.
provisioningState	string	Provisioning state of the Container App. Known values are: "InProgress", "Succeeded", "Failed", "Canceled", and "Deleting". (InProgress, Succeeded, Failed, Canceled, Deleting)
runningStatus	string	Running status of the Container App. Known values are: "Progressing", "Running", "Stopped", "Suspended", and "Ready". (Progressing, Running, Stopped, Suspended, Ready)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
template	object	Container App versioned application definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadProfileName	string	Workload profile name to pin for container app execution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, container_app_name, subscription_id		Get the properties of a Container App. Get the properties of a Container App.
list_by_resource_group	select	resource_group_name, subscription_id		Get the Container Apps in a given resource group. Get the Container Apps in a given resource group.
list_by_subscription	select	subscription_id		Get the Container Apps in a given subscription. Get the Container Apps in a given subscription.
create_or_update	insert	resource_group_name, container_app_name, subscription_id, location		Create or update a Container App. Create or update a Container App.
update	update	resource_group_name, container_app_name, subscription_id, location		Update properties of a Container App. Patches a Container App using JSON Merge Patch.
create_or_update	replace	resource_group_name, container_app_name, subscription_id, location		Create or update a Container App. Create or update a Container App.
delete	delete	resource_group_name, container_app_name, subscription_id		Delete a Container App. Delete a Container App.
list_custom_host_name_analysis	exec	resource_group_name, container_app_name, subscription_id	customHostname	Analyzes a custom hostname for a Container App. Analyzes a custom hostname for a Container App.
list_secrets	exec	resource_group_name, container_app_name, subscription_id		List secrets for a container app. List secrets for a container app.
get_auth_token	exec	resource_group_name, container_app_name, subscription_id		Get auth token for a container app. Get auth token for a container app.
start	exec	resource_group_name, container_app_name, subscription_id		Start a container app. Start a container app.
stop	exec	resource_group_name, container_app_name, subscription_id		Stop a container app. Stop a container app.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
container_app_name	string	Name of the Container App. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
customHostname	string	Custom hostname. Default value is None.

SELECT examples

get

Get the properties of a Container App. Get the properties of a Container App.

SELECT
id,
name,
configuration,
customDomainVerificationId,
environmentId,
eventStreamEndpoint,
extendedLocation,
identity,
kind,
latestReadyRevisionName,
latestRevisionFqdn,
latestRevisionName,
location,
managedBy,
managedEnvironmentId,
outboundIpAddresses,
provisioningState,
runningStatus,
systemData,
tags,
template,
type,
workloadProfileName
FROM azure.app_containers.container_apps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get the Container Apps in a given resource group. Get the Container Apps in a given resource group.

SELECT
id,
name,
configuration,
customDomainVerificationId,
environmentId,
eventStreamEndpoint,
extendedLocation,
identity,
kind,
latestReadyRevisionName,
latestRevisionFqdn,
latestRevisionName,
location,
managedBy,
managedEnvironmentId,
outboundIpAddresses,
provisioningState,
runningStatus,
systemData,
tags,
template,
type,
workloadProfileName
FROM azure.app_containers.container_apps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get the Container Apps in a given subscription. Get the Container Apps in a given subscription.

SELECT
id,
name,
configuration,
customDomainVerificationId,
environmentId,
eventStreamEndpoint,
extendedLocation,
identity,
kind,
latestReadyRevisionName,
latestRevisionFqdn,
latestRevisionName,
location,
managedBy,
managedEnvironmentId,
outboundIpAddresses,
provisioningState,
runningStatus,
systemData,
tags,
template,
type,
workloadProfileName
FROM azure.app_containers.container_apps
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Container App. Create or update a Container App.

INSERT INTO azure.app_containers.container_apps (
tags,
location,
properties,
extendedLocation,
identity,
managedBy,
kind,
resource_group_name,
container_app_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ identity }}',
'{{ managedBy }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ container_app_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
identity,
kind,
location,
managedBy,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: container_apps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the container_apps resource.
  - name: container_app_name
    value: "{{ container_app_name }}"
    description: Required parameter for the container_apps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the container_apps resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      ContainerApp resource specific properties.
    value:
      provisioningState: "{{ provisioningState }}"
      runningStatus: "{{ runningStatus }}"
      managedEnvironmentId: "{{ managedEnvironmentId }}"
      environmentId: "{{ environmentId }}"
      workloadProfileName: "{{ workloadProfileName }}"
      latestRevisionName: "{{ latestRevisionName }}"
      latestReadyRevisionName: "{{ latestReadyRevisionName }}"
      latestRevisionFqdn: "{{ latestRevisionFqdn }}"
      customDomainVerificationId: "{{ customDomainVerificationId }}"
      configuration:
        secrets:
          - name: "{{ name }}"
            value: "{{ value }}"
            identity: "{{ identity }}"
            keyVaultUrl: "{{ keyVaultUrl }}"
        activeRevisionsMode: "{{ activeRevisionsMode }}"
        ingress:
          fqdn: "{{ fqdn }}"
          external: {{ external }}
          targetPort: {{ targetPort }}
          exposedPort: {{ exposedPort }}
          transport: "{{ transport }}"
          traffic:
            - revisionName: "{{ revisionName }}"
              weight: {{ weight }}
              latestRevision: {{ latestRevision }}
              label: "{{ label }}"
          customDomains:
            - name: "{{ name }}"
              bindingType: "{{ bindingType }}"
              certificateId: "{{ certificateId }}"
          allowInsecure: {{ allowInsecure }}
          ipSecurityRestrictions:
            - name: "{{ name }}"
              description: "{{ description }}"
              ipAddressRange: "{{ ipAddressRange }}"
              action: "{{ action }}"
          stickySessions:
            affinity: "{{ affinity }}"
          clientCertificateMode: "{{ clientCertificateMode }}"
          corsPolicy:
            allowedOrigins:
              - "{{ allowedOrigins }}"
            allowedMethods:
              - "{{ allowedMethods }}"
            allowedHeaders:
              - "{{ allowedHeaders }}"
            exposeHeaders:
              - "{{ exposeHeaders }}"
            maxAge: {{ maxAge }}
            allowCredentials: {{ allowCredentials }}
          additionalPortMappings:
            - external: {{ external }}
              targetPort: {{ targetPort }}
              exposedPort: {{ exposedPort }}
        registries:
          - server: "{{ server }}"
            username: "{{ username }}"
            passwordSecretRef: "{{ passwordSecretRef }}"
            identity: "{{ identity }}"
        dapr:
          enabled: {{ enabled }}
          appId: "{{ appId }}"
          appProtocol: "{{ appProtocol }}"
          appPort: {{ appPort }}
          httpReadBufferSize: {{ httpReadBufferSize }}
          httpMaxRequestSize: {{ httpMaxRequestSize }}
          logLevel: "{{ logLevel }}"
          enableApiLogging: {{ enableApiLogging }}
          appHealth:
            enabled: {{ enabled }}
            path: "{{ path }}"
            probeIntervalSeconds: {{ probeIntervalSeconds }}
            probeTimeoutMilliseconds: {{ probeTimeoutMilliseconds }}
            threshold: {{ threshold }}
          maxConcurrency: {{ maxConcurrency }}
        runtime:
          java:
            enableMetrics: {{ enableMetrics }}
        maxInactiveRevisions: {{ maxInactiveRevisions }}
        service:
          type: "{{ type }}"
        identitySettings:
          - identity: "{{ identity }}"
            lifecycle: "{{ lifecycle }}"
      template:
        revisionSuffix: "{{ revisionSuffix }}"
        terminationGracePeriodSeconds: {{ terminationGracePeriodSeconds }}
        initContainers:
          - image: "{{ image }}"
            name: "{{ name }}"
            command: "{{ command }}"
            args: "{{ args }}"
            env: "{{ env }}"
            resources:
              cpu: {{ cpu }}
              memory: "{{ memory }}"
              ephemeralStorage: "{{ ephemeralStorage }}"
            volumeMounts: "{{ volumeMounts }}"
        containers:
          - image: "{{ image }}"
            name: "{{ name }}"
            command: "{{ command }}"
            args: "{{ args }}"
            env: "{{ env }}"
            resources:
              cpu: {{ cpu }}
              memory: "{{ memory }}"
              ephemeralStorage: "{{ ephemeralStorage }}"
            volumeMounts: "{{ volumeMounts }}"
            probes: "{{ probes }}"
        scale:
          minReplicas: {{ minReplicas }}
          maxReplicas: {{ maxReplicas }}
          cooldownPeriod: {{ cooldownPeriod }}
          pollingInterval: {{ pollingInterval }}
          rules:
            - name: "{{ name }}"
              azureQueue:
                accountName: "{{ accountName }}"
                queueName: "{{ queueName }}"
                queueLength: {{ queueLength }}
                auth: "{{ auth }}"
                identity: "{{ identity }}"
              custom:
                type: "{{ type }}"
                metadata: "{{ metadata }}"
                auth: "{{ auth }}"
                identity: "{{ identity }}"
              http:
                metadata: "{{ metadata }}"
                auth: "{{ auth }}"
                identity: "{{ identity }}"
              tcp:
                metadata: "{{ metadata }}"
                auth: "{{ auth }}"
                identity: "{{ identity }}"
        volumes:
          - name: "{{ name }}"
            storageType: "{{ storageType }}"
            storageName: "{{ storageName }}"
            secrets: "{{ secrets }}"
            mountOptions: "{{ mountOptions }}"
        serviceBinds:
          - serviceId: "{{ serviceId }}"
            name: "{{ name }}"
      outboundIpAddresses:
        - "{{ outboundIpAddresses }}"
      eventStreamEndpoint: "{{ eventStreamEndpoint }}"
  - name: extendedLocation
    description: |
      The complex type of the extended location.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: identity
    description: |
      managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp. Known values are: "workflowapp" and "functionapp".
    valid_values: ['workflowapp', 'functionapp']

UPDATE examples

update

Update properties of a Container App. Patches a Container App using JSON Merge Patch.

UPDATE azure.app_containers.container_apps
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
identity = '{{ identity }}',
managedBy = '{{ managedBy }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND container_app_name = '{{ container_app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
kind,
location,
managedBy,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a Container App. Create or update a Container App.

REPLACE azure.app_containers.container_apps
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
identity = '{{ identity }}',
managedBy = '{{ managedBy }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND container_app_name = '{{ container_app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
kind,
location,
managedBy,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Container App. Delete a Container App.

DELETE FROM azure.app_containers.container_apps
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND container_app_name = '{{ container_app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_custom_host_name_analysis

Analyzes a custom hostname for a Container App. Analyzes a custom hostname for a Container App.

EXEC azure.app_containers.container_apps.list_custom_host_name_analysis 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@customHostname='{{ customHostname }}'
;

list_secrets

List secrets for a container app. List secrets for a container app.

EXEC azure.app_containers.container_apps.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_auth_token

Get auth token for a container app. Get auth token for a container app.

EXEC azure.app_containers.container_apps.get_auth_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Start a container app. Start a container app.

EXEC azure.app_containers.container_apps.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stop a container app. Stop a container app.

EXEC azure.app_containers.container_apps.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;