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

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.
createdBy	string	CreatedBy property, which only appears in the response.
creationTime	string (date-time)	Creation time of the resource, which only appears in the response.
error	object	Details of provisioning error.
lastModifiedBy	string	LastModifiedBy property, which only appears in the response.
lastModifiedTime	string (date-time)	Last time resource was modified, which only appears in the response.
provisioningState	string	Provisioning state for the software update configuration, which only appears in the response.
scheduleInfo	object	Schedule information for the Software update configuration. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tasks	object	Tasks information for the Software update configuration.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateConfiguration	object	update specific properties for the Software update configuration. Required.

list

Name	Datatype	Description
id	string	Resource Id of the software update configuration.
name	string	Name of the software update configuration.
creationTime	string (date-time)	Creation time of the software update configuration, which only appears in the response.
frequency	string	execution frequency of the schedule associated with the software update configuration. Known values are: "OneTime", "Day", "Hour", "Week", "Month", and "Minute". (OneTime, Day, Hour, Week, Month, Minute)
lastModifiedTime	string (date-time)	Last time software update configuration was modified, which only appears in the response.
nextRun	string (date-time)	ext run time of the update.
provisioningState	string	Provisioning state for the software update configuration, which only appears in the response.
startTime	string (date-time)	the start time of the update.
tasks	object	Pre and Post Tasks defined.
updateConfiguration	object	Update specific properties of the software update configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	resource_group_name, automation_account_name, software_update_configuration_name, subscription_id	clientRequestId	Get a single software update configuration by name.
list	select	resource_group_name, automation_account_name, subscription_id	clientRequestId, $filter	Get all software update configurations for the account.
create	insert	resource_group_name, automation_account_name, software_update_configuration_name, subscription_id, properties	clientRequestId	Create a new software update configuration with the name given in the URI.
delete	delete	resource_group_name, automation_account_name, software_update_configuration_name, subscription_id	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
automation_account_name	string	The name of the automation account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
software_update_configuration_name	string	The name of the software update configuration to be created. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.
clientRequestId	string	Identifies this specific client request. Default value is None.

SELECT examples

get_by_name

Get a single software update configuration by name.

SELECT
id,
name,
createdBy,
creationTime,
error,
lastModifiedBy,
lastModifiedTime,
provisioningState,
scheduleInfo,
systemData,
tasks,
type,
updateConfiguration
FROM azure.automation.software_update_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND software_update_configuration_name = '{{ software_update_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
;

list

Get all software update configurations for the account.

SELECT
id,
name,
creationTime,
frequency,
lastModifiedTime,
nextRun,
provisioningState,
startTime,
tasks,
updateConfiguration
FROM azure.automation.software_update_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
automation_account_name,
software_update_configuration_name,
subscription_id,
clientRequestId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ software_update_configuration_name }}',
'{{ subscription_id }}',
'{{ clientRequestId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: software_update_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the software_update_configurations resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the software_update_configurations resource.
  - name: software_update_configuration_name
    value: "{{ software_update_configuration_name }}"
    description: Required parameter for the software_update_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the software_update_configurations resource.
  - name: properties
    description: |
      Software update configuration properties. Required.
    value:
      updateConfiguration:
        operatingSystem: "{{ operatingSystem }}"
        windows:
          includedUpdateClassifications: "{{ includedUpdateClassifications }}"
          excludedKbNumbers:
            - "{{ excludedKbNumbers }}"
          includedKbNumbers:
            - "{{ includedKbNumbers }}"
          rebootSetting: "{{ rebootSetting }}"
        linux:
          includedPackageClassifications: "{{ includedPackageClassifications }}"
          excludedPackageNameMasks:
            - "{{ excludedPackageNameMasks }}"
          includedPackageNameMasks:
            - "{{ includedPackageNameMasks }}"
          rebootSetting: "{{ rebootSetting }}"
        duration: "{{ duration }}"
        azureVirtualMachines:
          - "{{ azureVirtualMachines }}"
        nonAzureComputerNames:
          - "{{ nonAzureComputerNames }}"
        targets:
          azureQueries:
            - scope: "{{ scope }}"
              locations: "{{ locations }}"
              tagSettings:
                tags: "{{ tags }}"
                filterOperator: "{{ filterOperator }}"
          nonAzureQueries:
            - functionAlias: "{{ functionAlias }}"
              workspaceId: "{{ workspaceId }}"
      scheduleInfo:
        startTime: "{{ startTime }}"
        startTimeOffsetMinutes: {{ startTimeOffsetMinutes }}
        expiryTime: "{{ expiryTime }}"
        expiryTimeOffsetMinutes: {{ expiryTimeOffsetMinutes }}
        isEnabled: {{ isEnabled }}
        nextRun: "{{ nextRun }}"
        nextRunOffsetMinutes: {{ nextRunOffsetMinutes }}
        interval: {{ interval }}
        frequency: "{{ frequency }}"
        timeZone: "{{ timeZone }}"
        advancedSchedule:
          weekDays:
            - "{{ weekDays }}"
          monthDays:
            - {{ monthDays }}
          monthlyOccurrences:
            - occurrence: {{ occurrence }}
              day: "{{ day }}"
        creationTime: "{{ creationTime }}"
        lastModifiedTime: "{{ lastModifiedTime }}"
        description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"
      error:
        code: "{{ code }}"
        message: "{{ message }}"
      creationTime: "{{ creationTime }}"
      createdBy: "{{ createdBy }}"
      lastModifiedTime: "{{ lastModifiedTime }}"
      lastModifiedBy: "{{ lastModifiedBy }}"
      tasks:
        preTask:
          parameters: "{{ parameters }}"
          source: "{{ source }}"
        postTask:
          parameters: "{{ parameters }}"
          source: "{{ source }}"
  - name: clientRequestId
    value: "{{ clientRequestId }}"
    description: Identifies this specific client request. Default value is None.
    description: Identifies this specific client request. Default value is None.

DELETE examples

delete

delete a specific software update configuration.

DELETE FROM azure.automation.software_update_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND software_update_configuration_name = '{{ software_update_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND clientRequestId = '{{ clientRequestId }}'
;