software_update_configurations

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

Overview

Name	software_update_configurations
Type	Resource
Id	azure.automation.software_update_configurations

Fields

The following fields are returned by SELECT queries:

get_by_name

A single software update configuration.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
properties	object	Software update configuration properties.
type	string	Resource type

list

Return list of software update configurations.

Name	Datatype	Description
id	string	Resource Id of the software update configuration
name	string	Name of the software update configuration.
properties	object	Software update configuration properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	subscriptionId, resourceGroupName, automationAccountName, softwareUpdateConfigurationName	clientRequestId	Get a single software update configuration by name.
list	select	subscriptionId, resourceGroupName, automationAccountName	clientRequestId, $filter	Get all software update configurations for the account.
create	insert	subscriptionId, resourceGroupName, automationAccountName, softwareUpdateConfigurationName, data__properties	clientRequestId	Create a new software update configuration with the name given in the URI.
delete	delete	subscriptionId, resourceGroupName, automationAccountName, softwareUpdateConfigurationName	clientRequestId	delete a specific software update configuration.

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
automationAccountName	string	The name of the automation account.
resourceGroupName	string	Name of an Azure Resource group.
softwareUpdateConfigurationName	string	The name of the software update configuration to be created.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The filter to apply on the operation.
clientRequestId	string	Identifies this specific client request.

SELECT examples

get_by_name

Get a single software update configuration by name.

SELECT
id,
name,
properties,
type
FROM azure.automation.software_update_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND softwareUpdateConfigurationName = '{{ softwareUpdateConfigurationName }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
;

list

Get all software update configurations for the account.

SELECT
id,
name,
properties
FROM azure.automation.software_update_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a new software update configuration with the name given in the URI.

INSERT INTO azure.automation.software_update_configurations (
data__properties,
subscriptionId,
resourceGroupName,
automationAccountName,
softwareUpdateConfigurationName,
clientRequestId
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ softwareUpdateConfigurationName }}',
'{{ clientRequestId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: software_update_configurations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the software_update_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the software_update_configurations resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the software_update_configurations resource.
    - name: softwareUpdateConfigurationName
      value: string
      description: Required parameter for the software_update_configurations resource.
    - name: properties
      value: object
      description: |
        Software update configuration properties.
    - name: clientRequestId
      value: string
      description: Identifies this specific client request.

DELETE examples

delete

delete a specific software update configuration.

DELETE FROM azure.automation.software_update_configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND softwareUpdateConfigurationName = '{{ softwareUpdateConfigurationName }}' --required
AND clientRequestId = '{{ clientRequestId }}'
;