Software Update Configurations - Get By Name

Service:

Automation

API Version:

2019-06-01

Get a single software update configuration by name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}?api-version=2019-06-01

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
softwareUpdateConfigurationName	path	True	string	The name of the software update configuration to be created.
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Header

Name	Required	Type	Description
clientRequestId		string	Identifies this specific client request.

Responses

Name	Type	Description
200 OK	softwareUpdateConfiguration	A single software update configuration.
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get software update configuration by name

Sample request

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/mypatch?api-version=2019-06-01

Java

/**
 * Samples for SoftwareUpdateConfigurations GetByName.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/
     * softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json
     */
    /**
     * Sample code: Get software update configuration by name.
     * 
     * @param manager Entry point to AutomationManager.
     */
    public static void
        getSoftwareUpdateConfigurationByName(com.azure.resourcemanager.automation.AutomationManager manager) {
        manager.softwareUpdateConfigurations().getByNameWithResponse("mygroup", "myaccount", "mypatch", null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python get_software_update_configuration_by_name.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AutomationClient(
        credential=DefaultAzureCredential(),
        subscription_id="51766542-3ed7-4a72-a187-0c8ab644ddab",
    )

    response = client.software_update_configurations.get_by_name(
        resource_group_name="mygroup",
        automation_account_name="myaccount",
        software_update_configuration_name="mypatch",
    )
    print(response)


# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/432872fac1d0f8edcae98a0e8504afc0ee302710/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json
func ExampleSoftwareUpdateConfigurationsClient_GetByName() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSoftwareUpdateConfigurationsClient().GetByName(ctx, "mygroup", "myaccount", "mypatch", &armautomation.SoftwareUpdateConfigurationsClientGetByNameOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SoftwareUpdateConfiguration = armautomation.SoftwareUpdateConfiguration{
	// 	Name: to.Ptr("testpatch"),
	// 	ID: to.Ptr("/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch"),
	// 	Properties: &armautomation.SoftwareUpdateConfigurationProperties{
	// 		CreatedBy: to.Ptr("eve@contoso.com"),
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.523Z"); return t}()),
	// 		Error: &armautomation.ErrorResponse{
	// 		},
	// 		LastModifiedBy: to.Ptr(""),
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.680Z"); return t}()),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ScheduleInfo: &armautomation.SUCScheduleProperties{
	// 			Description: to.Ptr(""),
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.523Z"); return t}()),
	// 			ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-09T19:22:00.000Z"); return t}()),
	// 			ExpiryTimeOffsetMinutes: to.Ptr[float64](-480),
	// 			Frequency: to.Ptr(armautomation.ScheduleFrequencyWeek),
	// 			Interval: to.Ptr[int64](1),
	// 			IsEnabled: to.Ptr(true),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.523Z"); return t}()),
	// 			NextRun: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T19:22:00.000Z"); return t}()),
	// 			NextRunOffsetMinutes: to.Ptr[float64](-420),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T19:22:00.000Z"); return t}()),
	// 			StartTimeOffsetMinutes: to.Ptr[float64](-420),
	// 			TimeZone: to.Ptr("America/Los_Angeles"),
	// 		},
	// 		Tasks: &armautomation.SoftwareUpdateConfigurationTasks{
	// 			PostTask: &armautomation.TaskProperties{
	// 				Source: to.Ptr("GetCache"),
	// 			},
	// 			PreTask: &armautomation.TaskProperties{
	// 				Parameters: map[string]*string{
	// 					"COMPUTERNAME": to.Ptr("Computer1"),
	// 				},
	// 				Source: to.Ptr("HelloWorld"),
	// 			},
	// 		},
	// 		UpdateConfiguration: &armautomation.UpdateConfiguration{
	// 			AzureVirtualMachines: []*string{
	// 				to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01"),
	// 				to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02"),
	// 				to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03")},
	// 				Duration: to.Ptr("PT2H"),
	// 				Linux: &armautomation.LinuxProperties{
	// 				},
	// 				NonAzureComputerNames: []*string{
	// 					to.Ptr("box1.contoso.com"),
	// 					to.Ptr("box2.contoso.com")},
	// 					OperatingSystem: to.Ptr(armautomation.OperatingSystemTypeWindows),
	// 					Targets: &armautomation.TargetProperties{
	// 						AzureQueries: []*armautomation.AzureQueryProperties{
	// 							{
	// 								Scope: []*string{
	// 									to.Ptr("/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0"),
	// 									to.Ptr("/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d")},
	// 									TagSettings: &armautomation.TagSettingsProperties{
	// 										FilterOperator: to.Ptr(armautomation.TagOperatorsAll),
	// 										Tags: map[string][]*string{
	// 											"tag1": []*string{
	// 												to.Ptr("tag1Value1"),
	// 												to.Ptr("tag1Value2")},
	// 												"tag2": []*string{
	// 													to.Ptr("tag2Value1"),
	// 													to.Ptr("tag2Value2")},
	// 												},
	// 											},
	// 									}},
	// 								},
	// 								Windows: &armautomation.WindowsProperties{
	// 									ExcludedKbNumbers: []*string{
	// 										to.Ptr("168934"),
	// 										to.Ptr("168973")},
	// 										IncludedUpdateClassifications: to.Ptr(armautomation.WindowsUpdateClassesCritical),
	// 									},
	// 								},
	// 							},
	// 						}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a single software update configuration by name.
 *
 * @summary Get a single software update configuration by name.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json
 */
async function getSoftwareUpdateConfigurationByName() {
  const subscriptionId =
    process.env["AUTOMATION_SUBSCRIPTION_ID"] || "51766542-3ed7-4a72-a187-0c8ab644ddab";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "mygroup";
  const automationAccountName = "myaccount";
  const softwareUpdateConfigurationName = "mypatch";
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.softwareUpdateConfigurations.getByName(
    resourceGroupName,
    automationAccountName,
    softwareUpdateConfigurationName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Automation;
using Azure.ResourceManager.Automation.Models;

// Generated from example definition: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json
// this example is just showing the usage of "SoftwareUpdateConfigurations_GetByName" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SoftwareUpdateConfigurationResource created on azure
// for more information of creating SoftwareUpdateConfigurationResource, please refer to the document of SoftwareUpdateConfigurationResource
string subscriptionId = "51766542-3ed7-4a72-a187-0c8ab644ddab";
string resourceGroupName = "mygroup";
string automationAccountName = "myaccount";
string softwareUpdateConfigurationName = "mypatch";
ResourceIdentifier softwareUpdateConfigurationResourceId = SoftwareUpdateConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName, softwareUpdateConfigurationName);
SoftwareUpdateConfigurationResource softwareUpdateConfiguration = client.GetSoftwareUpdateConfigurationResource(softwareUpdateConfigurationResourceId);

// invoke the operation
SoftwareUpdateConfigurationResource result = await softwareUpdateConfiguration.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SoftwareUpdateConfigurationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "testpatch",
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch",
  "properties": {
    "updateConfiguration": {
      "operatingSystem": "Windows",
      "windows": {
        "includedUpdateClassifications": "Critical",
        "excludedKbNumbers": [
          "168934",
          "168973"
        ]
      },
      "linux": {},
      "targets": {
        "azureQueries": [
          {
            "scope": [
              "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0",
              "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d"
            ],
            "tagSettings": {
              "tags": {
                "tag1": [
                  "tag1Value1",
                  "tag1Value2"
                ],
                "tag2": [
                  "tag2Value1",
                  "tag2Value2"
                ]
              },
              "filterOperator": "All"
            },
            "locations": null
          }
        ]
      },
      "duration": "PT2H",
      "azureVirtualMachines": [
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03"
      ],
      "nonAzureComputerNames": [
        "box1.contoso.com",
        "box2.contoso.com"
      ]
    },
    "scheduleInfo": {
      "description": "",
      "startTime": "2017-10-19T12:22:00-07:00",
      "startTimeOffsetMinutes": -420,
      "expiryTime": "2018-11-09T11:22:00-08:00",
      "expiryTimeOffsetMinutes": -480,
      "isEnabled": true,
      "nextRun": "2017-10-19T12:22:00-07:00",
      "nextRunOffsetMinutes": -420,
      "interval": 1,
      "frequency": "Week",
      "creationTime": "2017-10-19T18:54:50.5233333+00:00",
      "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00",
      "timeZone": "America/Los_Angeles"
    },
    "tasks": {
      "preTask": {
        "source": "HelloWorld",
        "parameters": {
          "COMPUTERNAME": "Computer1"
        }
      },
      "postTask": {
        "source": "GetCache",
        "parameters": null
      }
    },
    "provisioningState": "Provisioning",
    "createdBy": "eve@contoso.com",
    "error": {},
    "creationTime": "2017-10-19T18:54:50.5233333+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-10-19T18:54:50.68+00:00"
  }
}

Definitions

Name	Description
AdvancedSchedule	The properties of the create Advanced Schedule.
AdvancedScheduleMonthlyOccurrence	The properties of the create advanced schedule monthly occurrence.
AzureQueryProperties	Azure query for the update configuration.
ErrorResponse	Error response of an operation failure
LinuxProperties	Linux specific update configuration.
LinuxUpdateClasses	Update classifications included in the software update configuration.
NonAzureQueryProperties	Non Azure query for the update configuration.
OperatingSystemType	operating system of target machines
ScheduleDay	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
ScheduleFrequency	Gets or sets the frequency of the schedule.
softwareUpdateConfiguration	Software update configuration properties.
softwareUpdateConfigurationTasks	Task properties of the software update configuration.
SUCScheduleProperties	Definition of schedule parameters.
TagOperators	Filter VMs by Any or All specified tags.
TagSettingsProperties	Tag filter information for the VM.
TargetProperties	Group specific to the update configuration.
taskProperties	Task properties of the software update configuration.
updateConfiguration	Update specific properties of the software update configuration.
WindowsProperties	Windows specific update configuration.
WindowsUpdateClasses	Update classification included in the software update configuration. A comma separated string with required values

AdvancedSchedule

The properties of the create Advanced Schedule.

Name	Type	Description
monthDays	integer[]	Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences	AdvancedScheduleMonthlyOccurrence[]	Occurrences of days within a month.
weekDays	string[]	Days of the week that the job should execute on.

AdvancedScheduleMonthlyOccurrence

The properties of the create advanced schedule monthly occurrence.

Name	Type	Description
day	ScheduleDay	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
occurrence	integer	Occurrence of the week within the month. Must be between 1 and 5

AzureQueryProperties

Azure query for the update configuration.

Name	Type	Description
locations	string[]	List of locations to scope the query to.
scope	string[]	List of Subscription or Resource Group ARM Ids.
tagSettings	TagSettingsProperties	Tag settings for the VM.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

LinuxProperties

Linux specific update configuration.

Name	Type	Description
excludedPackageNameMasks	string[]	packages excluded from the software update configuration.
includedPackageClassifications	LinuxUpdateClasses	Update classifications included in the software update configuration.
includedPackageNameMasks	string[]	packages included from the software update configuration.
rebootSetting	string	Reboot setting for the software update configuration.

LinuxUpdateClasses

Update classifications included in the software update configuration.

Name	Type	Description
Critical	string
Other	string
Security	string
Unclassified	string

NonAzureQueryProperties

Non Azure query for the update configuration.

Name	Type	Description
functionAlias	string	Log Analytics Saved Search name.
workspaceId	string	Workspace Id for Log Analytics in which the saved Search is resided.

OperatingSystemType

operating system of target machines

Name	Type	Description
Linux	string
Windows	string

ScheduleDay

Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ScheduleFrequency

Gets or sets the frequency of the schedule.

Name	Type	Description
Day	string
Hour	string
Minute	string	The minimum allowed interval for Minute schedules is 15 minutes.
Month	string
OneTime	string
Week	string

softwareUpdateConfiguration

Software update configuration properties.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.createdBy	string	CreatedBy property, which only appears in the response.
properties.creationTime	string	Creation time of the resource, which only appears in the response.
properties.error	ErrorResponse	Details of provisioning error
properties.lastModifiedBy	string	LastModifiedBy property, which only appears in the response.
properties.lastModifiedTime	string	Last time resource was modified, which only appears in the response.
properties.provisioningState	string	Provisioning state for the software update configuration, which only appears in the response.
properties.scheduleInfo	SUCScheduleProperties	Schedule information for the Software update configuration
properties.tasks	softwareUpdateConfigurationTasks	Tasks information for the Software update configuration.
properties.updateConfiguration	updateConfiguration	update specific properties for the Software update configuration
type	string	Resource type

softwareUpdateConfigurationTasks

Task properties of the software update configuration.

Name	Type	Description
postTask	taskProperties	Post task properties.
preTask	taskProperties	Pre task properties.

SUCScheduleProperties

Definition of schedule parameters.

Name	Type	Default value	Description
advancedSchedule	AdvancedSchedule		Gets or sets the advanced schedule.
creationTime	string		Gets or sets the creation time.
description	string		Gets or sets the description.
expiryTime	string		Gets or sets the end time of the schedule.
expiryTimeOffsetMinutes	number		Gets or sets the expiry time's offset in minutes.
frequency	ScheduleFrequency		Gets or sets the frequency of the schedule.
interval	integer		Gets or sets the interval of the schedule.
isEnabled	boolean	False	Gets or sets a value indicating whether this schedule is enabled.
lastModifiedTime	string		Gets or sets the last modified time.
nextRun	string		Gets or sets the next run time of the schedule.
nextRunOffsetMinutes	number		Gets or sets the next run time's offset in minutes.
startTime	string		Gets or sets the start time of the schedule.
startTimeOffsetMinutes	number		Gets the start time's offset in minutes.
timeZone	string		Gets or sets the time zone of the schedule.

TagOperators

Filter VMs by Any or All specified tags.

Name	Type	Description
All	string
Any	string

TagSettingsProperties

Tag filter information for the VM.

Name	Type	Description
filterOperator	TagOperators	Filter VMs by Any or All specified tags.
tags	object	Dictionary of tags with its list of values.

TargetProperties

Group specific to the update configuration.

Name	Type	Description
azureQueries	AzureQueryProperties[]	List of Azure queries in the software update configuration.
nonAzureQueries	NonAzureQueryProperties[]	List of non Azure queries in the software update configuration.

taskProperties

Task properties of the software update configuration.

Name	Type	Description
parameters	object	Gets or sets the parameters of the task.
source	string	Gets or sets the name of the runbook.

updateConfiguration

Update specific properties of the software update configuration.

Name	Type	Description
azureVirtualMachines	string[]	List of azure resource Ids for azure virtual machines targeted by the software update configuration.
duration	string	Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601
linux	LinuxProperties	Linux specific update configuration.
nonAzureComputerNames	string[]	List of names of non-azure machines targeted by the software update configuration.
operatingSystem	OperatingSystemType	operating system of target machines
targets	TargetProperties	Group targets for the software update configuration.
windows	WindowsProperties	Windows specific update configuration.

WindowsProperties

Windows specific update configuration.

Name	Type	Description
excludedKbNumbers	string[]	KB numbers excluded from the software update configuration.
includedKbNumbers	string[]	KB numbers included from the software update configuration.
includedUpdateClassifications	WindowsUpdateClasses	Update classification included in the software update configuration. A comma separated string with required values
rebootSetting	string	Reboot setting for the software update configuration.

WindowsUpdateClasses

Update classification included in the software update configuration. A comma separated string with required values

Name	Type	Description
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
Unclassified	string
UpdateRollup	string
Updates	string