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

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	configuration dictionary of the configuration profile.
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
configuration	object	configuration dictionary of the configuration profile.
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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	configuration dictionary of the configuration profile.
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	configuration_profile_name, resource_group_name, subscription_id		Get information about a configuration profile.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieve a list of configuration profile within a given resource group.
list_by_subscription	select	subscription_id		Retrieve a list of configuration profile within a subscription.
create_or_update	insert	configuration_profile_name, resource_group_name, subscription_id, location		Creates a configuration profile.
update	update	configuration_profile_name, resource_group_name, subscription_id		Updates a configuration profile.
create_or_update	replace	configuration_profile_name, resource_group_name, subscription_id, location		Creates a configuration profile.
delete	delete	resource_group_name, configuration_profile_name, subscription_id		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
configuration_profile_name	string	Name of the configuration profile. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get information about a configuration profile.

SELECT
id,
name,
configuration,
location,
systemData,
tags,
type
FROM azure.automanage.configuration_profiles
WHERE configuration_profile_name = '{{ configuration_profile_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieve a list of configuration profile within a given resource group.

SELECT
id,
name,
configuration,
location,
systemData,
tags,
type
FROM azure.automanage.configuration_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Retrieve a list of configuration profile within a subscription.

SELECT
id,
name,
configuration,
location,
systemData,
tags,
type
FROM azure.automanage.configuration_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a configuration profile.

INSERT INTO azure.automanage.configuration_profiles (
tags,
location,
properties,
configuration_profile_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ configuration_profile_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_profiles
props:
  - name: configuration_profile_name
    value: "{{ configuration_profile_name }}"
    description: Required parameter for the configuration_profiles resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_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 the configuration profile.
    value:
      configuration: "{{ configuration }}"

UPDATE examples

update

Updates a configuration profile.

UPDATE azure.automanage.configuration_profiles
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
configuration_profile_name = '{{ configuration_profile_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates a configuration profile.

REPLACE azure.automanage.configuration_profiles
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
configuration_profile_name = '{{ configuration_profile_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a configuration profile.

DELETE FROM azure.automanage.configuration_profiles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND configuration_profile_name = '{{ configuration_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;