configuration_profile_hci_assignments

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

Overview

Name	configuration_profile_hci_assignments
Type	Resource
Id	azure.automanage.configuration_profile_hci_assignments

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.
configurationProfile	string	The Automanage configurationProfile ARM Resource URI.
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
status	string	The status of onboarding, which only appears in the response.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetId	string	The target VM resource URI.
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, cluster_name, configuration_profile_assignment_name, subscription_id		Get information about a configuration profile assignment.
create_or_update	insert	resource_group_name, cluster_name, configuration_profile_assignment_name, subscription_id		Creates an association between a AzureStackHCI cluster and Automanage configuration profile.
create_or_update	replace	resource_group_name, cluster_name, configuration_profile_assignment_name, subscription_id		Creates an association between a AzureStackHCI cluster and Automanage configuration profile.
delete	delete	resource_group_name, cluster_name, configuration_profile_assignment_name, subscription_id		Delete a configuration profile assignment.

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
cluster_name	string	The name of the Arc machine. Required.
configuration_profile_assignment_name	string	Name of the configuration profile assignment. 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 assignment.

SELECT
id,
name,
configurationProfile,
managedBy,
status,
systemData,
targetId,
type
FROM azure.automanage.configuration_profile_hci_assignments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND configuration_profile_assignment_name = '{{ configuration_profile_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates an association between a AzureStackHCI cluster and Automanage configuration profile.

INSERT INTO azure.automanage.configuration_profile_hci_assignments (
properties,
resource_group_name,
cluster_name,
configuration_profile_assignment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ configuration_profile_assignment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
managedBy,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_profile_hci_assignments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_profile_hci_assignments resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the configuration_profile_hci_assignments resource.
  - name: configuration_profile_assignment_name
    value: "{{ configuration_profile_assignment_name }}"
    description: Required parameter for the configuration_profile_hci_assignments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_profile_hci_assignments resource.
  - name: properties
    description: |
      Properties of the configuration profile assignment.
    value:
      configurationProfile: "{{ configurationProfile }}"
      targetId: "{{ targetId }}"
      status: "{{ status }}"

REPLACE examples

create_or_update

Creates an association between a AzureStackHCI cluster and Automanage configuration profile.

REPLACE azure.automanage.configuration_profile_hci_assignments
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND configuration_profile_assignment_name = '{{ configuration_profile_assignment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
managedBy,
properties,
systemData,
type;

DELETE examples

delete

Delete a configuration profile assignment.

DELETE FROM azure.automanage.configuration_profile_hci_assignments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND configuration_profile_assignment_name = '{{ configuration_profile_assignment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;