container_apps_source_controls

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

Overview

Name	container_apps_source_controls
Type	Resource
Id	azure.app_containers.container_apps_source_controls

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.
branch	string	The branch which will trigger the auto deployment.
githubActionConfiguration	object	Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.
operationState	string	Current provisioning State of the operation. Known values are: "InProgress", "Succeeded", "Failed", and "Canceled". (InProgress, Succeeded, Failed, Canceled)
repoUrl	string	The repo url which will be integrated to ContainerApp.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_container_app

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.
branch	string	The branch which will trigger the auto deployment.
githubActionConfiguration	object	Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.
operationState	string	Current provisioning State of the operation. Known values are: "InProgress", "Succeeded", "Failed", and "Canceled". (InProgress, Succeeded, Failed, Canceled)
repoUrl	string	The repo url which will be integrated to ContainerApp.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, source_control_name, subscription_id		Get a SourceControl of a Container App. Get a SourceControl of a Container App.
list_by_container_app	select	resource_group_name, container_app_name, subscription_id		Get the Container App SourceControls in a given resource group. Get the Container App SourceControls in a given resource group.
create_or_update	insert	resource_group_name, container_app_name, source_control_name, subscription_id		Create or update the SourceControl for a Container App. Create or update the SourceControl for a Container App.
create_or_update	replace	resource_group_name, container_app_name, source_control_name, subscription_id		Create or update the SourceControl for a Container App. Create or update the SourceControl for a Container App.
delete	delete	resource_group_name, container_app_name, source_control_name, subscription_id		Delete a Container App SourceControl. Delete a Container App SourceControl.

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.
source_control_name	string	Name of the Container App SourceControl. Required.
subscription_id	string

SELECT examples

get

Get a SourceControl of a Container App. Get a SourceControl of a Container App.

SELECT
id,
name,
branch,
githubActionConfiguration,
operationState,
repoUrl,
systemData,
type
FROM azure.app_containers.container_apps_source_controls
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND source_control_name = '{{ source_control_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_container_app

Get the Container App SourceControls in a given resource group. Get the Container App SourceControls in a given resource group.

SELECT
id,
name,
branch,
githubActionConfiguration,
operationState,
repoUrl,
systemData,
type
FROM azure.app_containers.container_apps_source_controls
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the SourceControl for a Container App. Create or update the SourceControl for a Container App.

INSERT INTO azure.app_containers.container_apps_source_controls (
properties,
resource_group_name,
container_app_name,
source_control_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ container_app_name }}',
'{{ source_control_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: container_apps_source_controls
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the container_apps_source_controls resource.
  - name: container_app_name
    value: "{{ container_app_name }}"
    description: Required parameter for the container_apps_source_controls resource.
  - name: source_control_name
    value: "{{ source_control_name }}"
    description: Required parameter for the container_apps_source_controls resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the container_apps_source_controls resource.
  - name: properties
    description: |
      SourceControl resource specific properties.
    value:
      operationState: "{{ operationState }}"
      repoUrl: "{{ repoUrl }}"
      branch: "{{ branch }}"
      githubActionConfiguration:
        registryInfo:
          registryUrl: "{{ registryUrl }}"
          registryUserName: "{{ registryUserName }}"
          registryPassword: "{{ registryPassword }}"
        azureCredentials:
          clientId: "{{ clientId }}"
          clientSecret: "{{ clientSecret }}"
          tenantId: "{{ tenantId }}"
          kind: "{{ kind }}"
          subscriptionId: "{{ subscriptionId }}"
        contextPath: "{{ contextPath }}"
        githubPersonalAccessToken: "{{ githubPersonalAccessToken }}"
        image: "{{ image }}"
        publishType: "{{ publishType }}"
        os: "{{ os }}"
        runtimeStack: "{{ runtimeStack }}"
        runtimeVersion: "{{ runtimeVersion }}"

REPLACE examples

create_or_update

Create or update the SourceControl for a Container App. Create or update the SourceControl for a Container App.

REPLACE azure.app_containers.container_apps_source_controls
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND container_app_name = '{{ container_app_name }}' --required
AND source_control_name = '{{ source_control_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Container App SourceControl. Delete a Container App SourceControl.

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