Get all software update configurations for the account.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations?api-version=2019-06-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations?api-version=2019-06-01&$filter={$filter}
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\._]+$
|
|
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.
|
|
$filter
|
query |
|
string
|
The filter to apply on the operation.
|
| Name |
Required |
Type |
Description |
|
clientRequestId
|
|
string
|
Identifies this specific client request.
|
Responses
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
List software update configurations
Sample Request
GET https://management.azure.com/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations?api-version=2019-06-01
import com.azure.core.util.Context;
/** Samples for SoftwareUpdateConfigurations List. */
public final class Main {
/*
* x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json
*/
/**
* Sample code: List software update configurations.
*
* @param manager Entry point to AutomationManager.
*/
public static void listSoftwareUpdateConfigurations(
com.azure.resourcemanager.automation.AutomationManager manager) {
manager.softwareUpdateConfigurations().listWithResponse("mygroup", "myaccount", null, null, 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.automation import AutomationClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-automation
# USAGE
python list_software_update_configurations.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="1a7d4044-286c-4acb-969a-96639265bf2e",
)
response = client.software_update_configurations.list(
resource_group_name="mygroup",
automation_account_name="myaccount",
)
print(response)
# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.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
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/listSoftwareUpdateConfigurations.json
func ExampleSoftwareUpdateConfigurationsClient_List_listSoftwareUpdateConfigurations() {
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().List(ctx, "mygroup", "myaccount", &armautomation.SoftwareUpdateConfigurationsClientListOptions{ClientRequestID: nil,
Filter: 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.SoftwareUpdateConfigurationListResult = armautomation.SoftwareUpdateConfigurationListResult{
// Value: []*armautomation.SoftwareUpdateConfigurationCollectionItem{
// {
// Name: to.Ptr("testpatch-01"),
// ID: to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01"),
// Properties: &armautomation.SoftwareUpdateConfigurationCollectionItemProperties{
// CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.523Z"); return t}()),
// Frequency: to.Ptr(armautomation.ScheduleFrequencyWeek),
// LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.680Z"); return t}()),
// NextRun: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-23T19:22:00.000Z"); return t}()),
// ProvisioningState: to.Ptr("Succeeded"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T19:22:00.000Z"); return t}()),
// 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/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03")},
// Duration: to.Ptr("PT2H"),
// 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{
// IncludedUpdateClassifications: to.Ptr(armautomation.WindowsUpdateClasses("Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates")),
// },
// },
// },
// },
// {
// Name: to.Ptr("testpatch-02"),
// ID: to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02"),
// Properties: &armautomation.SoftwareUpdateConfigurationCollectionItemProperties{
// CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-11T21:52:02.773Z"); return t}()),
// Frequency: to.Ptr(armautomation.ScheduleFrequencyHour),
// LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-11T21:52:22.880Z"); return t}()),
// NextRun: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-05T19:26:00.000Z"); return t}()),
// ProvisioningState: to.Ptr("Succeeded"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-05T19:26:00.000Z"); return t}()),
// 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/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-04"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06")},
// Duration: to.Ptr("PT2H30M"),
// OperatingSystem: to.Ptr(armautomation.OperatingSystemTypeWindows),
// Targets: &armautomation.TargetProperties{
// AzureQueries: []*armautomation.AzureQueryProperties{
// {
// Locations: []*string{
// to.Ptr("Japan East"),
// to.Ptr("UK South")},
// 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{
// IncludedUpdateClassifications: to.Ptr(armautomation.WindowsUpdateClasses("Critical, FeaturePack")),
// },
// },
// },
// }},
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Get all software update configurations for the account.
*
* @summary Get all software update configurations for the account.
* x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json
*/
async function listSoftwareUpdateConfigurations() {
const subscriptionId =
process.env["AUTOMATION_SUBSCRIPTION_ID"] || "1a7d4044-286c-4acb-969a-96639265bf2e";
const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "mygroup";
const automationAccountName = "myaccount";
const credential = new DefaultAzureCredential();
const client = new AutomationClient(credential, subscriptionId);
const result = await client.softwareUpdateConfigurations.list(
resourceGroupName,
automationAccountName
);
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
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/listSoftwareUpdateConfigurations.json
// this example is just showing the usage of "SoftwareUpdateConfigurations_List" 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 AutomationAccountResource created on azure
// for more information of creating AutomationAccountResource, please refer to the document of AutomationAccountResource
string subscriptionId = "1a7d4044-286c-4acb-969a-96639265bf2e";
string resourceGroupName = "mygroup";
string automationAccountName = "myaccount";
ResourceIdentifier automationAccountResourceId = AutomationAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName);
AutomationAccountResource automationAccount = client.GetAutomationAccountResource(automationAccountResourceId);
// get the collection of this SoftwareUpdateConfigurationResource
SoftwareUpdateConfigurationCollection collection = automationAccount.GetSoftwareUpdateConfigurations();
// invoke the operation and iterate over the result
await foreach (SoftwareUpdateConfigurationCollectionItem item in collection.GetAllAsync())
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"name": "testpatch-01",
"id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01",
"properties": {
"updateConfiguration": {
"operatingSystem": "Windows",
"windows": {
"includedUpdateClassifications": "Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates",
"excludedKbNumbers": null
},
"linux": null,
"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/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03"
],
"nonAzureComputerNames": null
},
"tasks": {
"preTask": {
"source": "HelloWorld",
"parameters": {
"COMPUTERNAME": "Computer1"
}
},
"postTask": {
"source": "GetCache",
"parameters": null
}
},
"frequency": "Week",
"startTime": "2017-10-19T12:22:00-07:00",
"creationTime": "2017-10-19T18:54:50.5233333+00:00",
"lastModifiedTime": "2017-10-19T18:54:50.68+00:00",
"provisioningState": "Succeeded",
"nextRun": "2017-10-23T12:22:00-07:00"
}
},
{
"name": "testpatch-02",
"id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02",
"properties": {
"updateConfiguration": {
"operatingSystem": "Windows",
"windows": {
"includedUpdateClassifications": "Critical, FeaturePack",
"excludedKbNumbers": null
},
"linux": null,
"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": [
"Japan East",
"UK South"
]
}
]
},
"duration": "PT2H30M",
"azureVirtualMachines": [
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-04",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06"
],
"nonAzureComputerNames": null
},
"tasks": {
"preTask": {
"source": "HelloWorld",
"parameters": {
"COMPUTERNAME": "Computer1"
}
},
"postTask": {
"source": "GetCache",
"parameters": null
}
},
"frequency": "Hour",
"startTime": "2018-05-05T12:26:00-07:00",
"creationTime": "2017-08-11T21:52:02.7733333+00:00",
"lastModifiedTime": "2017-08-11T21:52:22.88+00:00",
"provisioningState": "Succeeded",
"nextRun": "2018-05-05T12:26:00-07:00"
}
}
]
}
List software update configurations Targeting a specific azure virtual machine
Sample Request
GET https://management.azure.com/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations?api-version=2019-06-01&$filter=properties/updateConfiguration/azureVirtualMachines/any(m: m eq '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')
import com.azure.core.util.Context;
/** Samples for SoftwareUpdateConfigurations List. */
public final class Main {
/*
* x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json
*/
/**
* Sample code: List software update configurations Targeting a specific azure virtual machine.
*
* @param manager Entry point to AutomationManager.
*/
public static void listSoftwareUpdateConfigurationsTargetingASpecificAzureVirtualMachine(
com.azure.resourcemanager.automation.AutomationManager manager) {
manager
.softwareUpdateConfigurations()
.listWithResponse(
"mygroup",
"myaccount",
null,
"properties/updateConfiguration/azureVirtualMachines/any(m: m eq"
+ " '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')",
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.automation import AutomationClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-automation
# USAGE
python list_software_update_configurations_by_vm.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="1a7d4044-286c-4acb-969a-96639265bf2e",
)
response = client.software_update_configurations.list(
resource_group_name="mygroup",
automation_account_name="myaccount",
)
print(response)
# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.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
package armautomation_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"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/listSoftwareUpdateConfigurationsByVm.json
func ExampleSoftwareUpdateConfigurationsClient_List_listSoftwareUpdateConfigurationsTargetingASpecificAzureVirtualMachine() {
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().List(ctx, "mygroup", "myaccount", &armautomation.SoftwareUpdateConfigurationsClientListOptions{ClientRequestID: nil,
Filter: to.Ptr("properties/updateConfiguration/azureVirtualMachines/any(m: m eq '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')"),
})
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.SoftwareUpdateConfigurationListResult = armautomation.SoftwareUpdateConfigurationListResult{
// Value: []*armautomation.SoftwareUpdateConfigurationCollectionItem{
// {
// Name: to.Ptr("testpatch-01"),
// ID: to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01"),
// Properties: &armautomation.SoftwareUpdateConfigurationCollectionItemProperties{
// CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.523Z"); return t}()),
// Frequency: to.Ptr(armautomation.ScheduleFrequencyWeek),
// LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T18:54:50.680Z"); return t}()),
// NextRun: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-23T19:22:00.000Z"); return t}()),
// ProvisioningState: to.Ptr("Succeeded"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T19:22:00.000Z"); return t}()),
// 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/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03")},
// Duration: to.Ptr("PT2H"),
// OperatingSystem: to.Ptr(armautomation.OperatingSystemTypeWindows),
// Windows: &armautomation.WindowsProperties{
// IncludedUpdateClassifications: to.Ptr(armautomation.WindowsUpdateClasses("Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates")),
// },
// },
// },
// },
// {
// Name: to.Ptr("testpatch-02"),
// ID: to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02"),
// Properties: &armautomation.SoftwareUpdateConfigurationCollectionItemProperties{
// CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-11T21:52:02.773Z"); return t}()),
// Frequency: to.Ptr(armautomation.ScheduleFrequencyHour),
// LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-11T21:52:22.880Z"); return t}()),
// NextRun: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-05T19:26:00.000Z"); return t}()),
// ProvisioningState: to.Ptr("Succeeded"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-05T19:26:00.000Z"); return t}()),
// 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/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05"),
// to.Ptr("/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06")},
// Duration: to.Ptr("PT2H30M"),
// OperatingSystem: to.Ptr(armautomation.OperatingSystemTypeWindows),
// Windows: &armautomation.WindowsProperties{
// IncludedUpdateClassifications: to.Ptr(armautomation.WindowsUpdateClasses("Critical, FeaturePack")),
// },
// },
// },
// }},
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Get all software update configurations for the account.
*
* @summary Get all software update configurations for the account.
* x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json
*/
async function listSoftwareUpdateConfigurationsTargetingASpecificAzureVirtualMachine() {
const subscriptionId =
process.env["AUTOMATION_SUBSCRIPTION_ID"] || "1a7d4044-286c-4acb-969a-96639265bf2e";
const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "mygroup";
const automationAccountName = "myaccount";
const filter =
"properties/updateConfiguration/azureVirtualMachines/any(m: m eq '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')";
const options = { filter };
const credential = new DefaultAzureCredential();
const client = new AutomationClient(credential, subscriptionId);
const result = await client.softwareUpdateConfigurations.list(
resourceGroupName,
automationAccountName,
options
);
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
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/listSoftwareUpdateConfigurationsByVm.json
// this example is just showing the usage of "SoftwareUpdateConfigurations_List" 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 AutomationAccountResource created on azure
// for more information of creating AutomationAccountResource, please refer to the document of AutomationAccountResource
string subscriptionId = "1a7d4044-286c-4acb-969a-96639265bf2e";
string resourceGroupName = "mygroup";
string automationAccountName = "myaccount";
ResourceIdentifier automationAccountResourceId = AutomationAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName);
AutomationAccountResource automationAccount = client.GetAutomationAccountResource(automationAccountResourceId);
// get the collection of this SoftwareUpdateConfigurationResource
SoftwareUpdateConfigurationCollection collection = automationAccount.GetSoftwareUpdateConfigurations();
// invoke the operation and iterate over the result
string filter = "properties/updateConfiguration/azureVirtualMachines/any(m: m eq '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')";
await foreach (SoftwareUpdateConfigurationCollectionItem item in collection.GetAllAsync(filter: filter))
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"name": "testpatch-01",
"id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01",
"properties": {
"updateConfiguration": {
"operatingSystem": "Windows",
"windows": {
"includedUpdateClassifications": "Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates",
"excludedKbNumbers": null
},
"linux": null,
"duration": "PT2H",
"azureVirtualMachines": [
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03"
],
"nonAzureComputerNames": null
},
"tasks": {
"preTask": {
"source": "HelloWorld",
"parameters": {
"COMPUTERNAME": "Computer1"
}
},
"postTask": {
"source": "GetCache",
"parameters": null
}
},
"frequency": "Week",
"startTime": "2017-10-19T12:22:00-07:00",
"creationTime": "2017-10-19T18:54:50.5233333+00:00",
"lastModifiedTime": "2017-10-19T18:54:50.68+00:00",
"provisioningState": "Succeeded",
"nextRun": "2017-10-23T12:22:00-07:00"
}
},
{
"name": "testpatch-02",
"id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02",
"properties": {
"updateConfiguration": {
"operatingSystem": "Windows",
"windows": {
"includedUpdateClassifications": "Critical, FeaturePack",
"excludedKbNumbers": null
},
"linux": null,
"duration": "PT2H30M",
"azureVirtualMachines": [
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05",
"/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06"
],
"nonAzureComputerNames": null
},
"tasks": {
"preTask": {
"source": "HelloWorld",
"parameters": {
"COMPUTERNAME": "Computer1"
}
},
"postTask": {
"source": "GetCache",
"parameters": null
}
},
"frequency": "Hour",
"startTime": "2018-05-05T12:26:00-07:00",
"creationTime": "2017-08-11T21:52:02.7733333+00:00",
"lastModifiedTime": "2017-08-11T21:52:22.88+00:00",
"provisioningState": "Succeeded",
"nextRun": "2018-05-05T12:26:00-07:00"
}
}
]
}
Definitions
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
|
|
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
|
|
softwareUpdateConfigurationCollectionItem
Software update configuration collection item properties.
| Name |
Type |
Description |
|
id
|
string
|
Resource Id of the software update configuration
|
|
name
|
string
|
Name of the software update configuration.
|
|
properties.creationTime
|
string
|
Creation time of the software update configuration, which only appears in the response.
|
|
properties.frequency
|
ScheduleFrequency
|
execution frequency of the schedule associated with the software update configuration
|
|
properties.lastModifiedTime
|
string
|
Last time software update configuration was modified, which only appears in the response.
|
|
properties.nextRun
|
string
|
ext run time of the update.
|
|
properties.provisioningState
|
string
|
Provisioning state for the software update configuration, which only appears in the response.
|
|
properties.startTime
|
string
|
the start time of the update.
|
|
properties.tasks
|
softwareUpdateConfigurationTasks
|
Pre and Post Tasks defined
|
|
properties.updateConfiguration
|
updateConfiguration
|
Update specific properties of the software update configuration.
|
softwareUpdateConfigurationListResult
result of listing all software update configuration
softwareUpdateConfigurationTasks
Task properties of the software update configuration.
TagOperators
Filter VMs by Any or All specified tags.
| Name |
Type |
Description |
|
All
|
string
|
|
|
Any
|
string
|
|
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
|
|