Software Update Configurations - List

Referensi

Service:: Automation

API Version:: 2019-06-01

Dapatkan semua konfigurasi pembaruan perangkat lunak untuk akun tersebut.

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}

Parameter URI

Name	In	Required	Type	Description
automationAccountName	path	True	string	Nama akun automasi.
resourceGroupName	path	True	string	Nama grup Sumber Daya Azure. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Mendapatkan kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.
$filter	query		string	Filter yang akan diterapkan pada operasi.

Header Permintaan

Name	Required	Type	Description
clientRequestId		string	Mengidentifikasi permintaan klien khusus ini.

Respons

Name	Type	Description
200 OK	softwareUpdateConfigurationListResult	Mengembalikan daftar konfigurasi pembaruan perangkat lunak.
Other Status Codes	ErrorResponse	Respons kesalahan automasi yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

List software update configurations

List software update configurations Targeting a specific azure virtual machine

List software update configurations

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

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/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json
func ExampleSoftwareUpdateConfigurationsClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationsClient("1a7d4044-286c-4acb-969a-96639265bf2e", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"mygroup",
		"myaccount",
		&armautomation.SoftwareUpdateConfigurationsClientListOptions{ClientRequestID: nil,
			Filter: nil,
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

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

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

Definisi

AzureQueryProperties	Kueri Azure untuk konfigurasi pembaruan.
ErrorResponse	Respons kesalahan kegagalan operasi
LinuxProperties	Konfigurasi pembaruan khusus Linux.
LinuxUpdateClasses	Klasifikasi pembaruan yang disertakan dalam konfigurasi pembaruan perangkat lunak.
NonAzureQueryProperties	Kueri non Azure untuk konfigurasi pembaruan.
OperatingSystemType	sistem operasi mesin target
ScheduleFrequency	Mendapatkan atau mengatur frekuensi jadwal.
softwareUpdateConfigurationCollectionItem	Properti item pengumpulan konfigurasi pembaruan perangkat lunak.
softwareUpdateConfigurationListResult	hasil daftar semua konfigurasi pembaruan perangkat lunak
softwareUpdateConfigurationTasks	Properti tugas konfigurasi pembaruan perangkat lunak.
TagOperators	Filter VM menurut Setiap atau Semua tag yang ditentukan.
TagSettingsProperties	Tag memfilter informasi untuk VM.
TargetProperties	Grup khusus untuk konfigurasi pembaruan.
taskProperties	Properti tugas konfigurasi pembaruan perangkat lunak.
updateConfiguration	Perbarui properti tertentu dari konfigurasi pembaruan perangkat lunak.
WindowsProperties	Windows konfigurasi pembaruan tertentu.
WindowsUpdateClasses	Klasifikasi pembaruan yang disertakan dalam konfigurasi pembaruan perangkat lunak. String yang dipisahkan koma dengan nilai yang diperlukan

AzureQueryProperties

Kueri Azure untuk konfigurasi pembaruan.

Name	Type	Description
locations	string[]	Daftar lokasi untuk mencakup kueri.
scope	string[]	Daftar Id ARM Langganan atau Grup Sumber Daya.
tagSettings	TagSettingsProperties	Pengaturan tag untuk VM.

ErrorResponse

Respons kesalahan kegagalan operasi

Name	Type	Description
code	string	Kode kesalahan
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

LinuxProperties

Konfigurasi pembaruan khusus Linux.

Name	Type	Description
excludedPackageNameMasks	string[]	paket yang dikecualikan dari konfigurasi pembaruan perangkat lunak.
includedPackageClassifications	LinuxUpdateClasses	Klasifikasi pembaruan yang disertakan dalam konfigurasi pembaruan perangkat lunak.
includedPackageNameMasks	string[]	paket yang disertakan dari konfigurasi pembaruan perangkat lunak.
rebootSetting	string	Pengaturan boot ulang untuk konfigurasi pembaruan perangkat lunak.

LinuxUpdateClasses

Klasifikasi pembaruan yang disertakan dalam konfigurasi pembaruan perangkat lunak.

Name	Type	Description
Critical	string
Other	string
Security	string
Unclassified	string

NonAzureQueryProperties

Kueri non Azure untuk konfigurasi pembaruan.

Name	Type	Description
functionAlias	string	Nama Pencarian Tersimpan Analitik Log.
workspaceId	string	Id Ruang Kerja untuk Analitik Log tempat Pencarian tersimpan berada.

OperatingSystemType

sistem operasi mesin target

Name	Type	Description
Linux	string
Windows	string

ScheduleFrequency

Mendapatkan atau mengatur frekuensi jadwal.

Name	Type	Description
Day	string
Hour	string
Minute	string	Interval minimum yang diizinkan untuk jadwal Menit adalah 15 menit.
Month	string
OneTime	string
Week	string

softwareUpdateConfigurationCollectionItem

Properti item pengumpulan konfigurasi pembaruan perangkat lunak.

Name	Type	Description
id	string	Id Sumber Daya konfigurasi pembaruan perangkat lunak
name	string	Nama konfigurasi pembaruan perangkat lunak.
properties.creationTime	string	Waktu pembuatan konfigurasi pembaruan perangkat lunak, yang hanya muncul dalam respons.
properties.frequency	ScheduleFrequency	frekuensi eksekusi jadwal yang terkait dengan konfigurasi pembaruan perangkat lunak
properties.lastModifiedTime	string	Terakhir kali konfigurasi pembaruan perangkat lunak dimodifikasi, yang hanya muncul dalam respons.
properties.nextRun	string	ext run time pembaruan.
properties.provisioningState	string	Status penyediaan untuk konfigurasi pembaruan perangkat lunak, yang hanya muncul dalam respons.
properties.startTime	string	waktu mulai pembaruan.
properties.tasks	softwareUpdateConfigurationTasks	Tugas Pra dan Pasca ditentukan
properties.updateConfiguration	updateConfiguration	Perbarui properti tertentu dari konfigurasi pembaruan perangkat lunak.

softwareUpdateConfigurationListResult

hasil daftar semua konfigurasi pembaruan perangkat lunak

Name	Type	Description
value	softwareUpdateConfigurationCollectionItem[]	objek luar ditampilkan saat mencantumkan semua konfigurasi pembaruan perangkat lunak

softwareUpdateConfigurationTasks

Properti tugas konfigurasi pembaruan perangkat lunak.

Name	Type	Description
postTask	taskProperties	Memposting properti tugas.
preTask	taskProperties	Properti pra-tugas.

TagOperators

Filter VM menurut Setiap atau Semua tag yang ditentukan.

Name	Type	Description
All	string
Any	string

TagSettingsProperties

Tag memfilter informasi untuk VM.

Name	Type	Description
filterOperator	TagOperators	Filter VM menurut Setiap atau Semua tag yang ditentukan.
tags	object	Kamus tag dengan daftar nilainya.

TargetProperties

Grup khusus untuk konfigurasi pembaruan.

Name	Type	Description
azureQueries	AzureQueryProperties[]	Daftar kueri Azure dalam konfigurasi pembaruan perangkat lunak.
nonAzureQueries	NonAzureQueryProperties[]	Daftar kueri non Azure dalam konfigurasi pembaruan perangkat lunak.

taskProperties

Properti tugas konfigurasi pembaruan perangkat lunak.

Name	Type	Description
parameters	object	Mendapatkan atau mengatur parameter tugas.
source	string	Mendapatkan atau mengatur nama runbook.

updateConfiguration

Perbarui properti tertentu dari konfigurasi pembaruan perangkat lunak.

Name	Type	Description
azureVirtualMachines	string[]	Daftar Id sumber daya azure untuk komputer virtual azure yang ditargetkan oleh konfigurasi pembaruan perangkat lunak.
duration	string	Waktu maksimum yang diizinkan untuk konfigurasi pembaruan perangkat lunak berjalan. Durasi perlu ditentukan menggunakan format PT[n]H[n]M[n]S sesuai ISO8601
linux	LinuxProperties	Konfigurasi pembaruan khusus Linux.
nonAzureComputerNames	string[]	Daftar nama komputer non-azure yang ditargetkan oleh konfigurasi pembaruan perangkat lunak.
operatingSystem	OperatingSystemType	sistem operasi mesin target
targets	TargetProperties	Target grup untuk konfigurasi pembaruan perangkat lunak.
windows	WindowsProperties	Windows konfigurasi pembaruan tertentu.

WindowsProperties

Windows konfigurasi pembaruan tertentu.

Name	Type	Description
excludedKbNumbers	string[]	Nomor KB yang dikecualikan dari konfigurasi pembaruan perangkat lunak.
includedKbNumbers	string[]	Nomor KB yang disertakan dari konfigurasi pembaruan perangkat lunak.
includedUpdateClassifications	WindowsUpdateClasses	Klasifikasi pembaruan yang disertakan dalam konfigurasi pembaruan perangkat lunak. String yang dipisahkan koma dengan nilai yang diperlukan
rebootSetting	string	Pengaturan boot ulang untuk konfigurasi pembaruan perangkat lunak.

WindowsUpdateClasses

Klasifikasi pembaruan yang disertakan dalam konfigurasi pembaruan perangkat lunak. String yang dipisahkan koma dengan nilai yang diperlukan

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