Software Update Configurations - List

Служба:

Automation

Версия API:

2019-06-01

Получение всех конфигураций обновлений программного обеспечения для учетной записи.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
resourceGroupName	path	True	string	Имя группы ресурсов Azure. Шаблон регулярного выражения: ^[-\w\._]+$
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.
$filter	query		string	Фильтр, применяемый к операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
clientRequestId		string	Определяет этот конкретный клиентский запрос.

Ответы

Имя	Тип	Описание
200 OK	softwareUpdateConfigurationListResult	Возвращает список конфигураций обновлений программного обеспечения.
Other Status Codes	ErrorResponse	Ответ об ошибке автоматизации, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List software update configurations

List software update configurations Targeting a specific azure virtual machine

List software update configurations

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations?api-version=2019-06-01

Java

/**
 * 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,
            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 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

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/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

JavaScript

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

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/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

Пример ответа

Код состояния:

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

Образец запроса

HTTP

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')

Java

/**
 * 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')",
            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 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

Go

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

JavaScript

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

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/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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AzureQueryProperties	Запрос Azure для конфигурации обновления.
ErrorResponse	Ответ на ошибку при сбое операции
LinuxProperties	Конфигурация обновления для Linux.
LinuxUpdateClasses	Классификации обновлений, включенные в конфигурацию обновления программного обеспечения.
NonAzureQueryProperties	Запрос не Azure для конфигурации обновления.
OperatingSystemType	операционная система целевых компьютеров
ScheduleFrequency	Возвращает или задает частоту расписания.
softwareUpdateConfigurationCollectionItem	Свойства элементов коллекции конфигурации обновления программного обеспечения.
softwareUpdateConfigurationListResult	результат перечисления всех конфигураций обновлений программного обеспечения
softwareUpdateConfigurationTasks	Свойства задачи конфигурации обновления программного обеспечения.
TagOperators	Фильтрация виртуальных машин по любым или всем указанным тегам.
TagSettingsProperties	Сведения о фильтре тегов для виртуальной машины.
TargetProperties	Группа, относясь к конфигурации обновления.
taskProperties	Свойства задачи конфигурации обновления программного обеспечения.
updateConfiguration	Обновление определенных свойств конфигурации обновления программного обеспечения.
WindowsProperties	Конфигурация обновления для Windows.
WindowsUpdateClasses	Классификация обновлений, включенная в конфигурацию обновления программного обеспечения. Строка, разделенная запятыми, с обязательными значениями

AzureQueryProperties

Запрос Azure для конфигурации обновления.

Имя	Тип	Описание
locations	string[]	Список расположений, в которые область запрос.
scope	string[]	Список идентификаторов ARM подписки или группы ресурсов.
tagSettings	TagSettingsProperties	Теги параметров для виртуальной машины.

ErrorResponse

Ответ на ошибку при сбое операции

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

LinuxProperties

Конфигурация обновления для Linux.

Имя	Тип	Описание
excludedPackageNameMasks	string[]	пакеты, исключенные из конфигурации обновления программного обеспечения.
includedPackageClassifications	LinuxUpdateClasses	Классификации обновлений, включенные в конфигурацию обновления программного обеспечения.
includedPackageNameMasks	string[]	пакеты, включенные в конфигурацию обновления программного обеспечения.
rebootSetting	string	Параметр перезагрузки для конфигурации обновления программного обеспечения.

LinuxUpdateClasses

Классификации обновлений, включенные в конфигурацию обновления программного обеспечения.

Имя	Тип	Описание
Critical	string
Other	string
Security	string
Unclassified	string

NonAzureQueryProperties

Запрос не Azure для конфигурации обновления.

Имя	Тип	Описание
functionAlias	string	Имя сохраненного поиска Log Analytics.
workspaceId	string	Идентификатор рабочей области для Log Analytics, в которой находится сохраненный поиск.

OperatingSystemType

операционная система целевых компьютеров

Имя	Тип	Описание
Linux	string
Windows	string

ScheduleFrequency

Возвращает или задает частоту расписания.

Имя	Тип	Описание
Day	string
Hour	string
Minute	string	Минимальный допустимый интервал для минутных расписаний составляет 15 минут.
Month	string
OneTime	string
Week	string

softwareUpdateConfigurationCollectionItem

Свойства элементов коллекции конфигурации обновления программного обеспечения.

Имя	Тип	Описание
id	string	Идентификатор ресурса конфигурации обновления программного обеспечения
name	string	Имя конфигурации обновления программного обеспечения.
properties.creationTime	string	Время создания конфигурации обновления программного обеспечения, которое отображается только в ответе.
properties.frequency	ScheduleFrequency	частота выполнения расписания, связанного с конфигурацией обновления программного обеспечения
properties.lastModifiedTime	string	При последнем изменении конфигурации обновления программного обеспечения, которая отображается только в ответе.
properties.nextRun	string	ext время выполнения обновления.
properties.provisioningState	string	Состояние подготовки для конфигурации обновления программного обеспечения, которое отображается только в ответе.
properties.startTime	string	время начала обновления.
properties.tasks	softwareUpdateConfigurationTasks	Определены задачи до и после
properties.updateConfiguration	updateConfiguration	Обновление определенных свойств конфигурации обновления программного обеспечения.

softwareUpdateConfigurationListResult

результат перечисления всех конфигураций обновлений программного обеспечения

Имя	Тип	Описание
value	softwareUpdateConfigurationCollectionItem[]	внешний объект возвращается при перечислении всех конфигураций обновлений программного обеспечения

softwareUpdateConfigurationTasks

Свойства задачи конфигурации обновления программного обеспечения.

Имя	Тип	Описание
postTask	taskProperties	Свойства задачи post.
preTask	taskProperties	Свойства предварительной задачи.

TagOperators

Фильтрация виртуальных машин по любым или всем указанным тегам.

Имя	Тип	Описание
All	string
Any	string

TagSettingsProperties

Сведения о фильтре тегов для виртуальной машины.

Имя	Тип	Описание
filterOperator	TagOperators	Фильтрация виртуальных машин по любым или всем указанным тегам.
tags	object	Словарь тегов со списком значений.

TargetProperties

Группа, относясь к конфигурации обновления.

Имя	Тип	Описание
azureQueries	AzureQueryProperties[]	Список запросов Azure в конфигурации обновления программного обеспечения.
nonAzureQueries	NonAzureQueryProperties[]	Список запросов, отличных от Azure, в конфигурации обновления программного обеспечения.

taskProperties

Свойства задачи конфигурации обновления программного обеспечения.

Имя	Тип	Описание
parameters	object	Возвращает или задает параметры задачи.
source	string	Возвращает или задает имя модуля Runbook.

updateConfiguration

Обновление определенных свойств конфигурации обновления программного обеспечения.

Имя	Тип	Описание
azureVirtualMachines	string[]	Список идентификаторов ресурсов Azure для виртуальных машин Azure, предназначенных для конфигурации обновления программного обеспечения.
duration	string	Максимальное время выполнения конфигурации обновления программного обеспечения. Длительность должна быть указана в формате PT[n]H[n]M[n]S в соответствии с ISO8601
linux	LinuxProperties	Конфигурация обновления для Linux.
nonAzureComputerNames	string[]	Список имен компьютеров, не относящихся к Azure, предназначенных для конфигурации обновления программного обеспечения.
operatingSystem	OperatingSystemType	операционная система целевых компьютеров
targets	TargetProperties	Целевые объекты группы для конфигурации обновления программного обеспечения.
windows	WindowsProperties	Конфигурация обновления для Windows.

WindowsProperties

Конфигурация обновления для Windows.

Имя	Тип	Описание
excludedKbNumbers	string[]	Номера кб, исключенные из конфигурации обновления программного обеспечения.
includedKbNumbers	string[]	Номера кб, включенные в конфигурацию обновления программного обеспечения.
includedUpdateClassifications	WindowsUpdateClasses	Классификация обновлений, включенная в конфигурацию обновления программного обеспечения. Строка, разделенная запятыми, с обязательными значениями
rebootSetting	string	Параметр перезагрузки для конфигурации обновления программного обеспечения.

WindowsUpdateClasses

Классификация обновлений, включенная в конфигурацию обновления программного обеспечения. Строка, разделенная запятыми, с обязательными значениями

Имя	Тип	Описание
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
Unclassified	string
UpdateRollup	string
Updates	string