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
OK. The configuration profile assignment was returned successfully.
Name | Datatype | Description |
---|---|---|
managedBy | string | Azure resource id. Indicates if this resource is managed by another Azure resource. |
properties | object | Properties of the configuration profile assignment. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | resourceGroupName , subscriptionId , clusterName , configurationProfileAssignmentName | Get information about a configuration profile assignment | |
create_or_update | insert | subscriptionId , resourceGroupName , clusterName , configurationProfileAssignmentName | Creates an association between a AzureStackHCI cluster and Automanage configuration profile | |
delete | delete | subscriptionId , resourceGroupName , clusterName , configurationProfileAssignmentName | 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 |
---|---|---|
clusterName | string | The name of the Arc machine. |
configurationProfileAssignmentName | string | Name of the configuration profile assignment |
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 assignment
SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_hci_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND configurationProfileAssignmentName = '{{ configurationProfileAssignmentName }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
Creates an association between a AzureStackHCI cluster and Automanage configuration profile
INSERT INTO azure.automanage.configuration_profile_hci_assignments (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
configurationProfileAssignmentName
)
SELECT
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ configurationProfileAssignmentName }}'
RETURNING
managedBy,
properties,
systemData
;
# Description fields are for documentation purposes
- name: configuration_profile_hci_assignments
props:
- name: subscriptionId
value: string
description: Required parameter for the configuration_profile_hci_assignments resource.
- name: resourceGroupName
value: string
description: Required parameter for the configuration_profile_hci_assignments resource.
- name: clusterName
value: string
description: Required parameter for the configuration_profile_hci_assignments resource.
- name: configurationProfileAssignmentName
value: string
description: Required parameter for the configuration_profile_hci_assignments resource.
- name: properties
value: object
description: |
Properties of the configuration profile assignment.
DELETE
examples
- delete
Delete a configuration profile assignment
DELETE FROM azure.automanage.configuration_profile_hci_assignments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND configurationProfileAssignmentName = '{{ configurationProfileAssignmentName }}' --required
;