configuration_profiles

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

Overview

Name	configuration_profiles
Type	Resource
Id	azure.automanage.configuration_profiles

Fields

The following fields are returned by SELECT queries:

get

OK. The configuration profile was returned successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the configuration profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

list_by_resource_group

OK. List of configuration profiles.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the configuration profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

list_by_subscription

OK. List of configuration profiles.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the configuration profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	configurationProfileName, subscriptionId, resourceGroupName		Get information about a configuration profile
list_by_resource_group	select	subscriptionId, resourceGroupName		Retrieve a list of configuration profile within a given resource group
list_by_subscription	select	subscriptionId		Retrieve a list of configuration profile within a subscription
create_or_update	insert	configurationProfileName, subscriptionId, resourceGroupName		Creates a configuration profile
update	update	configurationProfileName, subscriptionId, resourceGroupName		Updates a configuration profile
delete	delete	resourceGroupName, configurationProfileName, subscriptionId		Delete a configuration profile

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
configurationProfileName	string	Name of the configuration profile
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get information about a configuration profile

SELECT
location,
properties,
systemData,
tags
FROM azure.automanage.configuration_profiles
WHERE configurationProfileName = '{{ configurationProfileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_resource_group

Retrieve a list of configuration profile within a given resource group

SELECT
location,
properties,
systemData,
tags
FROM azure.automanage.configuration_profiles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Retrieve a list of configuration profile within a subscription

SELECT
location,
properties,
systemData,
tags
FROM azure.automanage.configuration_profiles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a configuration profile

INSERT INTO azure.automanage.configuration_profiles (
data__properties,
data__tags,
data__location,
configurationProfileName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ configurationProfileName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: configuration_profiles
  props:
    - name: configurationProfileName
      value: string
      description: Required parameter for the configuration_profiles resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the configuration_profiles resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_profiles resource.
    - name: properties
      value: object
      description: |
        Properties of the configuration profile.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates a configuration profile

UPDATE azure.automanage.configuration_profiles
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
configurationProfileName = '{{ configurationProfileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete a configuration profile

DELETE FROM azure.automanage.configuration_profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND configurationProfileName = '{{ configurationProfileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;