Software Update Configurations - Get By Name

Referensi

Service:: Automation

API Version:: 2019-06-01

Dapatkan satu konfigurasi pembaruan perangkat lunak berdasarkan nama.

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

Parameter URI

Name	In	Required	Type	Description
automationAccountName	path	True	string	Nama akun otomatisasi.
resourceGroupName	path	True	string	Nama grup Sumber Daya Azure. Regex pattern: `^[-\w\._]+$`
softwareUpdateConfigurationName	path	True	string	Nama konfigurasi pembaruan perangkat lunak yang akan dibuat.
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.

Header Permintaan

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

Respons

Name	Type	Description
200 OK	softwareUpdateConfiguration	Satu 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

Get software update configuration by name

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

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/getSoftwareUpdateConfigurationByName.json
func ExampleSoftwareUpdateConfigurationsClient_GetByName() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetByName(ctx,
		"mygroup",
		"myaccount",
		"mypatch",
		&armautomation.SoftwareUpdateConfigurationsClientGetByNameOptions{ClientRequestID: 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

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

Definisi

AdvancedSchedule	Properti buat Jadwal Tingkat Lanjut.
AdvancedScheduleMonthlyOccurrence	Properti buat jadwal lanjutan kemunculan bulanan.
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
ScheduleDay	Hari kejadian. Harus salah satu dari Senin, Selasa, Rabu, Kamis, Jumat, Sabtu, Minggu.
ScheduleFrequency	Mendapatkan atau mengatur frekuensi jadwal.
softwareUpdateConfiguration	Properti konfigurasi pembaruan perangkat lunak.
softwareUpdateConfigurationTasks	Properti tugas konfigurasi pembaruan perangkat lunak.
SUCScheduleProperties	Definisi parameter jadwal.
TagOperators	Filter VM menurut Tag apa pun atau Semua yang ditentukan.
TagSettingsProperties	Informasi filter tag 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 disertakan dalam konfigurasi pembaruan perangkat lunak. String yang dipisahkan koma dengan nilai yang diperlukan

AdvancedSchedule

Properti buat Jadwal Tingkat Lanjut.

Name	Type	Description
monthDays	integer[]	Hari dalam sebulan pekerjaan harus dijalankan. Harus antara 1 dan 31.
monthlyOccurrences	AdvancedScheduleMonthlyOccurrence[]	Terjadinya hari dalam sebulan.
weekDays	string[]	Hari dalam seminggu tempat pekerjaan harus dijalankan.

AdvancedScheduleMonthlyOccurrence

Properti buat jadwal lanjutan kemunculan bulanan.

Name	Type	Description
day	ScheduleDay	Hari kejadian. Harus salah satu dari Senin, Selasa, Rabu, Kamis, Jumat, Sabtu, Minggu.
occurrence	integer	Terjadinya minggu dalam sebulan. Harus antara 1 dan 5

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

ScheduleDay

Hari kejadian. Harus salah satu dari Senin, Selasa, Rabu, Kamis, Jumat, Sabtu, Minggu.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	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

softwareUpdateConfiguration

Properti konfigurasi pembaruan perangkat lunak.

Name	Type	Description
id	string	Id Sumber Daya.
name	string	Nama sumber daya.
properties.createdBy	string	Properti CreatedBy, yang hanya muncul dalam respons.
properties.creationTime	string	Waktu pembuatan sumber daya, yang hanya muncul dalam respons.
properties.error	ErrorResponse	Detail kesalahan provisi
properties.lastModifiedBy	string	Properti LastModifiedBy, yang hanya muncul dalam respons.
properties.lastModifiedTime	string	Terakhir kali sumber daya dimodifikasi, yang hanya muncul dalam respons.
properties.provisioningState	string	Status provisi untuk konfigurasi pembaruan perangkat lunak, yang hanya muncul dalam respons.
properties.scheduleInfo	SUCScheduleProperties	Menjadwalkan informasi untuk konfigurasi pembaruan Perangkat Lunak
properties.tasks	softwareUpdateConfigurationTasks	Informasi tugas untuk konfigurasi pembaruan Perangkat Lunak.
properties.updateConfiguration	updateConfiguration	memperbarui properti tertentu untuk konfigurasi pembaruan Perangkat Lunak
type	string	Jenis Sumber Daya

softwareUpdateConfigurationTasks

Properti tugas konfigurasi pembaruan perangkat lunak.

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

SUCScheduleProperties

Definisi parameter jadwal.

Name	Type	Default Value	Description
advancedSchedule	AdvancedSchedule		Mendapatkan atau mengatur jadwal lanjutan.
creationTime	string		Mendapatkan atau mengatur waktu pembuatan.
description	string		Mendapatkan atau mengatur deskripsi.
expiryTime	string		Mendapatkan atau mengatur waktu akhir jadwal.
expiryTimeOffsetMinutes	number		Mendapatkan atau mengatur offset waktu kedaluwarsa dalam hitung menit.
frequency	ScheduleFrequency		Mendapatkan atau mengatur frekuensi jadwal.
interval	integer		Mendapatkan atau mengatur interval jadwal.
isEnabled	boolean	False	Mendapatkan atau menetapkan nilai yang menunjukkan apakah jadwal ini diaktifkan.
lastModifiedTime	string		Mendapatkan atau mengatur waktu terakhir yang dimodifikasi.
nextRun	string		Mendapatkan atau mengatur durasi jadwal berikutnya.
nextRunOffsetMinutes	number		Mendapatkan atau mengatur offset run time berikutnya dalam hitung menit.
startTime	string		Mendapatkan atau mengatur waktu mulai jadwal.
startTimeOffsetMinutes	number		Mendapatkan offset waktu mulai dalam hitung menit.
timeZone	string		Mendapatkan atau mengatur zona waktu jadwal.

TagOperators

Filter VM menurut Tag apa pun atau Semua yang ditentukan.

Name	Type	Description
All	string
Any	string

TagSettingsProperties

Informasi filter tag untuk VM.

Name	Type	Description
filterOperator	TagOperators	Filter VM menurut Tag apa pun atau Semua 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 eksekusi konfigurasi pembaruan perangkat lunak. 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 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 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