次の方法で共有


Software Update Configurations - Get By Name

単一のソフトウェア更新プログラムの構成を名前で取得します。

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

URI パラメーター

名前 / 必須 説明
automationAccountName
path True

string

Automation アカウントの名前。

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Azure リソース グループの名前。

softwareUpdateConfigurationName
path True

string

作成するソフトウェア更新プログラムの構成の名前。

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

api-version
query True

string

クライアント API のバージョン。

要求ヘッダー

名前 必須 説明
clientRequestId

string

この特定のクライアント要求を識別します。

応答

名前 説明
200 OK

softwareUpdateConfiguration

単一のソフトウェア更新プログラムの構成。

Other Status Codes

ErrorResponse

操作が失敗した理由を説明するオートメーション エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

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

応答のサンプル

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

定義

名前 説明
AdvancedSchedule

高度なスケジュールの作成のプロパティ。

AdvancedScheduleMonthlyOccurrence

毎月の詳細スケジュールの作成のプロパティ。

AzureQueryProperties

更新構成の Azure クエリ。

ErrorResponse

操作エラーのエラー応答

LinuxProperties

Linux 固有の更新プログラムの構成。

LinuxUpdateClasses

ソフトウェア更新プログラムの構成に含まれる更新プログラムの分類。

NonAzureQueryProperties

更新構成に対する Azure 以外のクエリ。

OperatingSystemType

ターゲット マシンのオペレーティング システム

ScheduleDay

発生日。 月曜日、火曜日、水曜日、木曜日、金曜日、土曜日、日曜日のいずれかである必要があります。

ScheduleFrequency

スケジュールの頻度を取得または設定します。

softwareUpdateConfiguration

ソフトウェア更新プログラムの構成プロパティ。

softwareUpdateConfigurationTasks

ソフトウェア更新構成のタスク プロパティ。

SUCScheduleProperties

スケジュール パラメーターの定義。

TagOperators

指定した任意のタグまたはすべてのタグで VM をフィルター処理します。

TagSettingsProperties

VM のタグ フィルター情報。

TargetProperties

更新構成に固有のグループ。

taskProperties

ソフトウェア更新構成のタスク プロパティ。

updateConfiguration

ソフトウェア更新構成の特定のプロパティを更新します。

WindowsProperties

Windows 固有の更新プログラムの構成。

WindowsUpdateClasses

ソフトウェア更新プログラムの構成に含まれる更新プログラムの分類。 必要な値を含むコンマ区切り文字列

AdvancedSchedule

高度なスケジュールの作成のプロパティ。

名前 説明
monthDays

integer[] (int32)

ジョブを実行する月の日数。 1 ~ 31 の間である必要があります。

monthlyOccurrences

AdvancedScheduleMonthlyOccurrence[]

1 か月以内の日数。

weekDays

string[]

ジョブを実行する曜日。

AdvancedScheduleMonthlyOccurrence

毎月の詳細スケジュールの作成のプロパティ。

名前 説明
day

ScheduleDay

発生日。 月曜日、火曜日、水曜日、木曜日、金曜日、土曜日、日曜日のいずれかである必要があります。

occurrence

integer (int32)

月内の週の発生。 1 ~ 5 の間である必要があります

AzureQueryProperties

更新構成の Azure クエリ。

名前 説明
locations

string[]

クエリの範囲を指定する場所の一覧。

scope

string[]

サブスクリプションまたはリソース グループの ARM ID の一覧。

tagSettings

TagSettingsProperties

VM のタグ設定。

ErrorResponse

操作エラーのエラー応答

名前 説明
code

string

エラー コード

message

string

操作が失敗した理由を示すエラー メッセージ。

LinuxProperties

Linux 固有の更新プログラムの構成。

名前 説明
excludedPackageNameMasks

string[]

ソフトウェア更新プログラムの構成から除外されるパッケージ。

includedPackageClassifications

LinuxUpdateClasses

ソフトウェア更新プログラムの構成に含まれる更新プログラムの分類。

includedPackageNameMasks

string[]

ソフトウェア更新プログラムの構成から含まれるパッケージ。

rebootSetting

string

ソフトウェア更新構成の再起動設定。

LinuxUpdateClasses

ソフトウェア更新プログラムの構成に含まれる更新プログラムの分類。

説明
Critical
Other
Security
Unclassified

NonAzureQueryProperties

更新構成に対する Azure 以外のクエリ。

名前 説明
functionAlias

string

Log Analytics の保存された検索名。

workspaceId

string

保存された検索が存在する Log Analytics のワークスペース ID。

OperatingSystemType

ターゲット マシンのオペレーティング システム

説明
Linux
Windows

ScheduleDay

発生日。 月曜日、火曜日、水曜日、木曜日、金曜日、土曜日、日曜日のいずれかである必要があります。

説明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ScheduleFrequency

スケジュールの頻度を取得または設定します。

説明
Day
Hour
Minute

Minute スケジュールの最小許容間隔は 15 分です。

Month
OneTime
Week

softwareUpdateConfiguration

ソフトウェア更新プログラムの構成プロパティ。

名前 説明
id

string

リソース ID。

name

string

リソース名。

properties.createdBy

string

CreatedBy プロパティ。応答にのみ表示されます。

properties.creationTime

string (date-time)

応答にのみ表示されるリソースの作成時間。

properties.error

ErrorResponse

プロビジョニング エラーの詳細

properties.lastModifiedBy

string

LastModifiedBy プロパティ。応答にのみ表示されます。

properties.lastModifiedTime

string (date-time)

前回リソースが変更されました。これは応答にのみ表示されます。

properties.provisioningState

string

応答にのみ表示されるソフトウェア更新プログラム構成のプロビジョニング状態。

properties.scheduleInfo

SUCScheduleProperties

ソフトウェア更新プログラムの構成のスケジュール情報

properties.tasks

softwareUpdateConfigurationTasks

ソフトウェア更新構成のタスク情報。

properties.updateConfiguration

updateConfiguration

ソフトウェア更新構成の特定のプロパティを更新する

type

string

リソースの種類

softwareUpdateConfigurationTasks

ソフトウェア更新構成のタスク プロパティ。

名前 説明
postTask

taskProperties

タスクのプロパティを投稿します。

preTask

taskProperties

タスクの前のプロパティ。

SUCScheduleProperties

スケジュール パラメーターの定義。

名前 規定値 説明
advancedSchedule

AdvancedSchedule

高度なスケジュールを取得または設定します。

creationTime

string (date-time)

作成時刻を取得または設定します。

description

string

説明を取得または設定します。

expiryTime

string (date-time)

スケジュールの終了時刻を取得または設定します。

expiryTimeOffsetMinutes

number (double)

有効期限のオフセットを分単位で取得または設定します。

frequency

ScheduleFrequency

スケジュールの頻度を取得または設定します。

interval

integer (int64)

スケジュールの間隔を取得または設定します。

isEnabled

boolean

False

このスケジュールが有効かどうかを示す値を取得または設定します。

lastModifiedTime

string (date-time)

最終変更時刻を取得または設定します。

nextRun

string (date-time)

スケジュールの次の実行時を取得または設定します。

nextRunOffsetMinutes

number (double)

次の実行時のオフセットを分単位で取得または設定します。

startTime

string (date-time)

スケジュールの開始時刻を取得または設定します。

startTimeOffsetMinutes

number (double)

開始時刻のオフセットを分単位で取得します。

timeZone

string

スケジュールのタイム ゾーンを取得または設定します。

TagOperators

指定した任意のタグまたはすべてのタグで VM をフィルター処理します。

説明
All
Any

TagSettingsProperties

VM のタグ フィルター情報。

名前 説明
filterOperator

TagOperators

指定した任意のタグまたはすべてのタグで VM をフィルター処理します。

tags

object

値のリストを含むタグのディクショナリ。

TargetProperties

更新構成に固有のグループ。

名前 説明
azureQueries

AzureQueryProperties[]

ソフトウェア更新プログラムの構成での Azure クエリの一覧。

nonAzureQueries

NonAzureQueryProperties[]

ソフトウェア更新プログラムの構成における Azure 以外のクエリの一覧。

taskProperties

ソフトウェア更新構成のタスク プロパティ。

名前 説明
parameters

object

タスクのパラメーターを取得または設定します。

source

string

Runbook の名前を取得または設定します。

updateConfiguration

ソフトウェア更新構成の特定のプロパティを更新します。

名前 説明
azureVirtualMachines

string[]

ソフトウェア更新構成の対象となる Azure 仮想マシンの Azure リソース ID の一覧。

duration

string (duration)

ソフトウェア更新構成の実行に許可される最大時間。 期間は、ISO8601に従って PT[n]H[n]M[n]S の形式を使用して指定する必要があります

linux

LinuxProperties

Linux 固有の更新プログラムの構成。

nonAzureComputerNames

string[]

ソフトウェア更新プログラムの構成の対象となる Azure 以外のマシンの名前の一覧。

operatingSystem

OperatingSystemType

ターゲット マシンのオペレーティング システム

targets

TargetProperties

ソフトウェア更新構成のターゲットをグループ化します。

windows

WindowsProperties

Windows 固有の更新プログラムの構成。

WindowsProperties

Windows 固有の更新プログラムの構成。

名前 説明
excludedKbNumbers

string[]

ソフトウェア更新プログラムの構成から除外される KB 番号。

includedKbNumbers

string[]

ソフトウェア更新プログラムの構成に含まれる KB 番号。

includedUpdateClassifications

WindowsUpdateClasses

ソフトウェア更新プログラムの構成に含まれる更新プログラムの分類。 必要な値を含むコンマ区切り文字列

rebootSetting

string

ソフトウェア更新構成の再起動設定。

WindowsUpdateClasses

ソフトウェア更新プログラムの構成に含まれる更新プログラムの分類。 必要な値を含むコンマ区切り文字列

説明
Critical
Definition
FeaturePack
Security
ServicePack
Tools
Unclassified
UpdateRollup
Updates