iac_profiles

Creates, updates, deletes, gets or lists an iac_profiles resource.

Overview

Name	iac_profiles
Type	Resource
Id	azure_extras.devhub.iac_profiles

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.
etag	string	A unique read-only string that changes whenever the resource is updated.
githubProfile	object	GitHub Profile of a IacProfile.
location	string	The geo-location where the resource lives. Required.
stages	array	:vartype stages: list[~azure.mgmt.devhub.models.StageProperties]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templates	array	:vartype templates: list[~azure.mgmt.devhub.models.IacTemplateProperties]
terraformProfile	object	Terraform Profile of a IacProfile.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
etag	string	A unique read-only string that changes whenever the resource is updated.
githubProfile	object	GitHub Profile of a IacProfile.
location	string	The geo-location where the resource lives. Required.
stages	array	:vartype stages: list[~azure.mgmt.devhub.models.StageProperties]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templates	array	:vartype templates: list[~azure.mgmt.devhub.models.IacTemplateProperties]
terraformProfile	object	Terraform Profile of a IacProfile.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
etag	string	A unique read-only string that changes whenever the resource is updated.
githubProfile	object	GitHub Profile of a IacProfile.
location	string	The geo-location where the resource lives. Required.
stages	array	:vartype stages: list[~azure.mgmt.devhub.models.StageProperties]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templates	array	:vartype templates: list[~azure.mgmt.devhub.models.IacTemplateProperties]
terraformProfile	object	Terraform Profile of a IacProfile.
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, iac_profile_name, subscription_id		Gets a IacProfile. Gets a IacProfile.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of iacProfiles within a resource group. Gets a list of iacProfiles within a resource group.
list	select	subscription_id		Gets a list of IacProfiles associated with the specified subscription. Gets a list of IacProfiles associated with the specified subscription.
create_or_update	insert	resource_group_name, iac_profile_name, subscription_id, location		Creates or updates a IacProfile. Creates or updates a IacProfile.
update_tags	update	resource_group_name, iac_profile_name, subscription_id		Updates tags on a IacProfile. Updates tags on a IacProfile.
create_or_update	replace	resource_group_name, iac_profile_name, subscription_id, location		Creates or updates a IacProfile. Creates or updates a IacProfile.
delete	delete	resource_group_name, iac_profile_name, subscription_id		Deletes a IacProfile. Deletes a IacProfile.
export	exec	resource_group_name, iac_profile_name, subscription_id		Export a template. Export a template.
scale	exec	resource_group_name, iac_profile_name, subscription_id		Scale by template. Scale by template.
sync	exec	resource_group_name, iac_profile_name, subscription_id		Sync template. Sync template.

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
iac_profile_name	string	The name of the IacProfile. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a IacProfile. Gets a IacProfile.

SELECT
id,
name,
etag,
githubProfile,
location,
stages,
systemData,
tags,
templates,
terraformProfile,
type
FROM azure_extras.devhub.iac_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND iac_profile_name = '{{ iac_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of iacProfiles within a resource group. Gets a list of iacProfiles within a resource group.

SELECT
id,
name,
etag,
githubProfile,
location,
stages,
systemData,
tags,
templates,
terraformProfile,
type
FROM azure_extras.devhub.iac_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of IacProfiles associated with the specified subscription. Gets a list of IacProfiles associated with the specified subscription.

SELECT
id,
name,
etag,
githubProfile,
location,
stages,
systemData,
tags,
templates,
terraformProfile,
type
FROM azure_extras.devhub.iac_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a IacProfile. Creates or updates a IacProfile.

INSERT INTO azure_extras.devhub.iac_profiles (
tags,
location,
properties,
resource_group_name,
iac_profile_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ iac_profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: iac_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the iac_profiles resource.
  - name: iac_profile_name
    value: "{{ iac_profile_name }}"
    description: Required parameter for the iac_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the iac_profiles resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of a IacProfile.
    value:
      githubProfile:
        repositoryName: "{{ repositoryName }}"
        repositoryMainBranch: "{{ repositoryMainBranch }}"
        repositoryOwner: "{{ repositoryOwner }}"
        authStatus: "{{ authStatus }}"
        pullNumber: {{ pullNumber }}
        prStatus: "{{ prStatus }}"
        branchName: "{{ branchName }}"
      terraformProfile:
        storageAccountSubscription: "{{ storageAccountSubscription }}"
        storageAccountResourceGroup: "{{ storageAccountResourceGroup }}"
        storageAccountName: "{{ storageAccountName }}"
        storageContainerName: "{{ storageContainerName }}"
      stages:
        - stageName: "{{ stageName }}"
          dependencies: "{{ dependencies }}"
          gitEnvironment: "{{ gitEnvironment }}"
      templates:
        - templateName: "{{ templateName }}"
          sourceResourceId: "{{ sourceResourceId }}"
          instanceStage: "{{ instanceStage }}"
          instanceName: "{{ instanceName }}"
          templateDetails: "{{ templateDetails }}"
          quickStartTemplateType: "{{ quickStartTemplateType }}"

UPDATE examples

update_tags

Updates tags on a IacProfile. Updates tags on a IacProfile.

UPDATE azure_extras.devhub.iac_profiles
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND iac_profile_name = '{{ iac_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a IacProfile. Creates or updates a IacProfile.

REPLACE azure_extras.devhub.iac_profiles
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND iac_profile_name = '{{ iac_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a IacProfile. Deletes a IacProfile.

DELETE FROM azure_extras.devhub.iac_profiles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND iac_profile_name = '{{ iac_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

export

Export a template. Export a template.

EXEC azure_extras.devhub.iac_profiles.export 
@resource_group_name='{{ resource_group_name }}' --required, 
@iac_profile_name='{{ iac_profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"templateName": "{{ templateName }}", 
"resourceGroupIds": "{{ resourceGroupIds }}", 
"siteId": "{{ siteId }}", 
"instanceName": "{{ instanceName }}", 
"instanceStage": "{{ instanceStage }}"
}'
;

scale

Scale by template. Scale by template.

EXEC azure_extras.devhub.iac_profiles.scale 
@resource_group_name='{{ resource_group_name }}' --required, 
@iac_profile_name='{{ iac_profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"templateName": "{{ templateName }}", 
"scaleRequirement": "{{ scaleRequirement }}"
}'
;

sync

Sync template. Sync template.

EXEC azure_extras.devhub.iac_profiles.sync 
@resource_group_name='{{ resource_group_name }}' --required, 
@iac_profile_name='{{ iac_profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;