Software Update Configurations - List

Reference

Service:: Automation

API Version:: 2019-06-01

Získejte všechny konfigurace aktualizací softwaru pro účet.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
automationAccountName	path	True	string	Název účtu Automation.
resourceGroupName	path	True	string	Název skupiny prostředků Azure Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Filtr, který se má použít na operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
clientRequestId		string	Identifikuje tento konkrétní požadavek klienta.

Odpovědi

Name	Typ	Description
200 OK	softwareUpdateConfigurationListResult	Vrátit seznam konfigurací aktualizací softwaru.
Other Status Codes	ErrorResponse	Odpověď na chybu automatizace popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List software update configurations

List software update configurations Targeting a specific azure virtual machine

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

Status code:: 200

{
  "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

Status code:: 200

{
  "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"
      }
    }
  ]
}

Definice

Name	Description
AzureQueryProperties	Dotaz Azure na konfiguraci aktualizace
ErrorResponse	Chybová odpověď při selhání operace
LinuxProperties	Konfigurace aktualizací specifická pro Linux.
LinuxUpdateClasses	Klasifikace aktualizací zahrnuté v konfiguraci aktualizací softwaru.
NonAzureQueryProperties	Dotaz na konfiguraci aktualizace mimo Azure
OperatingSystemType	operační systém cílových počítačů
ScheduleFrequency	Získá nebo nastaví frekvenci plánu.
softwareUpdateConfigurationCollectionItem	Vlastnosti položky kolekce konfigurace aktualizace softwaru.
softwareUpdateConfigurationListResult	výsledek výpisu všech konfigurací aktualizací softwaru
softwareUpdateConfigurationTasks	Vlastnosti úlohy konfigurace aktualizace softwaru.
TagOperators	Filtrujte virtuální počítače podle zadaných značek Any nebo All.
TagSettingsProperties	Informace o filtru značek pro virtuální počítač
TargetProperties	Skupina specifická pro konfiguraci aktualizace.
taskProperties	Vlastnosti úlohy konfigurace aktualizace softwaru.
updateConfiguration	Aktualizujte specifické vlastnosti konfigurace aktualizace softwaru.
WindowsProperties	Konfigurace aktualizací specifická pro Windows.
WindowsUpdateClasses	Klasifikace aktualizací zahrnutá v konfiguraci aktualizace softwaru. Řetězec oddělený čárkami s požadovanými hodnotami

AzureQueryProperties

Dotaz Azure na konfiguraci aktualizace

Name	Typ	Description
locations	string[]	Seznam umístění, na která se má dotaz vymezit.
scope	string[]	Seznam ID ARM předplatného nebo skupiny prostředků
tagSettings	TagSettingsProperties	Nastavení značek pro virtuální počítač

ErrorResponse

Chybová odpověď při selhání operace

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

LinuxProperties

Konfigurace aktualizací specifická pro Linux.

Name	Typ	Description
excludedPackageNameMasks	string[]	balíčky vyloučené z konfigurace aktualizací softwaru.
includedPackageClassifications	LinuxUpdateClasses	Klasifikace aktualizací zahrnuté v konfiguraci aktualizací softwaru.
includedPackageNameMasks	string[]	balíčky zahrnuté z konfigurace aktualizace softwaru.
rebootSetting	string	Nastavení restartování pro konfiguraci aktualizace softwaru.

LinuxUpdateClasses

Klasifikace aktualizací zahrnuté v konfiguraci aktualizací softwaru.

Name	Typ	Description
Critical	string
Other	string
Security	string
Unclassified	string

NonAzureQueryProperties

Dotaz na konfiguraci aktualizace mimo Azure

Name	Typ	Description
functionAlias	string	Název uloženého hledání v Log Analytics.
workspaceId	string	ID pracovního prostoru pro Log Analytics, ve kterém se nachází uložené hledání.

OperatingSystemType

operační systém cílových počítačů

Name	Typ	Description
Linux	string
Windows	string

ScheduleFrequency

Získá nebo nastaví frekvenci plánu.

Name	Typ	Description
Day	string
Hour	string
Minute	string	Minimální povolený interval pro minutové plány je 15 minut.
Month	string
OneTime	string
Week	string

softwareUpdateConfigurationCollectionItem

Vlastnosti položky kolekce konfigurace aktualizace softwaru.

Name	Typ	Description
id	string	ID prostředku konfigurace aktualizace softwaru
name	string	Název konfigurace aktualizace softwaru.
properties.creationTime	string	Čas vytvoření konfigurace aktualizace softwaru, která se zobrazí pouze v odpovědi.
properties.frequency	ScheduleFrequency	Frekvence provádění plánu přidruženého ke konfiguraci aktualizace softwaru
properties.lastModifiedTime	string	Čas poslední změny konfigurace aktualizace softwaru, který se zobrazí pouze v odpovědi.
properties.nextRun	string	ext run time aktualizace.
properties.provisioningState	string	Stav zřizování pro konfiguraci aktualizace softwaru, který se zobrazí pouze v odpovědi.
properties.startTime	string	čas zahájení aktualizace.
properties.tasks	softwareUpdateConfigurationTasks	Definované úkoly před a po dokončení
properties.updateConfiguration	updateConfiguration	Aktualizujte specifické vlastnosti konfigurace aktualizace softwaru.

softwareUpdateConfigurationListResult

výsledek výpisu všech konfigurací aktualizací softwaru

Name	Typ	Description
value	softwareUpdateConfigurationCollectionItem[]	Vnější objekt vrácený při výpisu všech konfigurací aktualizací softwaru

softwareUpdateConfigurationTasks

Vlastnosti úlohy konfigurace aktualizace softwaru.

Name	Typ	Description
postTask	taskProperties	Pozálohovat vlastnosti úkolu.
preTask	taskProperties	Vlastnosti před úkolem.

TagOperators

Filtrujte virtuální počítače podle zadaných značek Any nebo All.

Name	Typ	Description
All	string
Any	string

TagSettingsProperties

Informace o filtru značek pro virtuální počítač

Name	Typ	Description
filterOperator	TagOperators	Filtrujte virtuální počítače podle zadaných značek Any nebo All.
tags	object	Slovník značek se seznamem hodnot.

TargetProperties

Skupina specifická pro konfiguraci aktualizace.

Name	Typ	Description
azureQueries	AzureQueryProperties[]	Seznam dotazů Azure v konfiguraci aktualizací softwaru
nonAzureQueries	NonAzureQueryProperties[]	Seznam dotazů mimo Azure v konfiguraci aktualizací softwaru

taskProperties

Vlastnosti úlohy konfigurace aktualizace softwaru.

Name	Typ	Description
parameters	object	Získá nebo nastaví parametry úlohy.
source	string	Získá nebo nastaví název runbooku.

updateConfiguration

Aktualizujte specifické vlastnosti konfigurace aktualizace softwaru.

Name	Typ	Description
azureVirtualMachines	string[]	Seznam ID prostředků Azure pro virtuální počítače Azure, na které cílí konfigurace aktualizací softwaru
duration	string	Maximální čas povolený pro spuštění konfigurace aktualizace softwaru. Dobu trvání je potřeba zadat ve formátu PT[n]H[n]M[n]S podle ISO8601
linux	LinuxProperties	Konfigurace aktualizací specifická pro Linux.
nonAzureComputerNames	string[]	Seznam názvů počítačů mimo Azure, na které cílí konfigurace aktualizací softwaru
operatingSystem	OperatingSystemType	operační systém cílových počítačů
targets	TargetProperties	Cíle skupiny pro konfiguraci aktualizací softwaru.
windows	WindowsProperties	Konfigurace aktualizací specifická pro Windows.

WindowsProperties

Konfigurace aktualizací specifická pro Windows.

Name	Typ	Description
excludedKbNumbers	string[]	Čísla KB vyloučená z konfigurace aktualizace softwaru.
includedKbNumbers	string[]	Čísla KB zahrnutá v konfiguraci aktualizace softwaru.
includedUpdateClassifications	WindowsUpdateClasses	Klasifikace aktualizací zahrnutá v konfiguraci aktualizace softwaru. Řetězec oddělený čárkami s požadovanými hodnotami
rebootSetting	string	Nastavení restartování pro konfiguraci aktualizace softwaru.

WindowsUpdateClasses

Klasifikace aktualizací zahrnutá v konfiguraci aktualizace softwaru. Řetězec oddělený čárkami s požadovanými hodnotami

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

Share via

Software Update Configurations - List

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

List software update configurations

Sample Request

Sample Response

List software update configurations Targeting a specific azure virtual machine

Sample Request

Sample Response

Definice

AzureQueryProperties

ErrorResponse

LinuxProperties

LinuxUpdateClasses

NonAzureQueryProperties

OperatingSystemType

ScheduleFrequency

softwareUpdateConfigurationCollectionItem

softwareUpdateConfigurationListResult

softwareUpdateConfigurationTasks

TagOperators

TagSettingsProperties

TargetProperties

taskProperties

updateConfiguration

WindowsProperties

WindowsUpdateClasses

Další materiály