connected_vmwarev_sphere_assignments

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

Overview

Name	connected_vmwarev_sphere_assignments
Type	Resource
Id	azure.guest_configuration.connected_vmwarev_sphere_assignments

Fields

The following fields are returned by SELECT queries:

get

OK. The guest configuration assignment was returned successfully.

Name	Datatype	Description
properties	object	Properties of the Guest configuration assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list

Name	Datatype	Description
properties	object	Properties of the Guest configuration 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	subscriptionId, resourceGroupName, vmName, guestConfigurationAssignmentName		Get information about a guest configuration assignment
list	select	subscriptionId, resourceGroupName, vmName		List all guest configuration assignments for an ARC machine.
create_or_update	insert	subscriptionId, resourceGroupName, vmName, guestConfigurationAssignmentName		Creates an association between a Connected VM Sphere machine and guest configuration
delete	delete	subscriptionId, resourceGroupName, vmName, guestConfigurationAssignmentName		Delete a guest configuration 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
guestConfigurationAssignmentName	string	Name of the guest configuration assignment
resourceGroupName	string	The resource group name.
subscriptionId	string	Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmName	string	The name of the virtual machine.

SELECT examples

get

Get information about a guest configuration assignment

SELECT
properties,
systemData
FROM azure.guest_configuration.connected_vmwarev_sphere_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmName = '{{ vmName }}' -- required
AND guestConfigurationAssignmentName = '{{ guestConfigurationAssignmentName }}' -- required
;

list

List all guest configuration assignments for an ARC machine.

SELECT
properties,
systemData
FROM azure.guest_configuration.connected_vmwarev_sphere_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmName = '{{ vmName }}' -- required
;

INSERT examples

create_or_update

Creates an association between a Connected VM Sphere machine and guest configuration

INSERT INTO azure.guest_configuration.connected_vmwarev_sphere_assignments (
data__properties,
subscriptionId,
resourceGroupName,
vmName,
guestConfigurationAssignmentName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vmName }}',
'{{ guestConfigurationAssignmentName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: connected_vmwarev_sphere_assignments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the connected_vmwarev_sphere_assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connected_vmwarev_sphere_assignments resource.
    - name: vmName
      value: string
      description: Required parameter for the connected_vmwarev_sphere_assignments resource.
    - name: guestConfigurationAssignmentName
      value: string
      description: Required parameter for the connected_vmwarev_sphere_assignments resource.
    - name: properties
      value: object
      description: |
        Properties of the Guest configuration assignment.

DELETE examples

delete

Delete a guest configuration assignment

DELETE FROM azure.guest_configuration.connected_vmwarev_sphere_assignments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vmName = '{{ vmName }}' --required
AND guestConfigurationAssignmentName = '{{ guestConfigurationAssignmentName }}' --required
;