assignments_vm_sse

Creates, updates, deletes, gets or lists an assignments_vm_sse resource.

Overview

Name	assignments_vm_sse
Type	Resource
Id	azure.guest_configuration.assignments_vm_sse

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, vmssName, name		Get information about a guest configuration assignment for VMSS
list	select	resourceGroupName, subscriptionId, vmssName		List all guest configuration assignments for VMSS.
create_or_update	insert	subscriptionId, resourceGroupName, vmssName, name		Creates an association between a VMSS and guest configuration
delete	delete	subscriptionId, resourceGroupName, vmssName, name		Delete a guest configuration assignment for VMSS

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
name	string	The guest configuration assignment name.
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.
vmssName	string	The name of the virtual machine scale set.

SELECT examples

get

Get information about a guest configuration assignment for VMSS

SELECT
properties,
systemData
FROM azure.guest_configuration.assignments_vm_sse
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmssName = '{{ vmssName }}' -- required
AND name = '{{ name }}' -- required
;

list

List all guest configuration assignments for VMSS.

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

INSERT examples

create_or_update

Creates an association between a VMSS and guest configuration

INSERT INTO azure.guest_configuration.assignments_vm_sse (
data__properties,
subscriptionId,
resourceGroupName,
vmssName,
name
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vmssName }}',
'{{ name }}'
RETURNING
properties,
systemData
;

Manifest

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

DELETE examples

delete

Delete a guest configuration assignment for VMSS

DELETE FROM azure.guest_configuration.assignments_vm_sse
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vmssName = '{{ vmssName }}' --required
AND name = '{{ name }}' --required
;