Share via


Software Update Configurations - List

アカウントのすべてのソフトウェア更新プログラムの構成を取得します。

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

Automation アカウントの名前。

resourceGroupName
path True

string

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

Regex pattern: ^[-\w\._]+$

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True

string

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

$filter
query

string

操作に適用するフィルター。

要求ヘッダー

名前 必須 説明
clientRequestId

string

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

応答

名前 説明
200 OK

softwareUpdateConfigurationListResult

ソフトウェア更新プログラムの構成の一覧を返します。

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

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

Sample Response

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

Sample Response

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

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

TagSettingsProperties

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

TargetProperties

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

taskProperties

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

updateConfiguration

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

WindowsProperties

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

WindowsUpdateClasses

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

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

string

Other

string

Security

string

Unclassified

string

NonAzureQueryProperties

更新プログラムの構成に対する Azure 以外のクエリ。

名前 説明
functionAlias

string

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

workspaceId

string

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

OperatingSystemType

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

名前 説明
Linux

string

Windows

string

ScheduleFrequency

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

名前 説明
Day

string

Hour

string

Minute

string

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

Month

string

OneTime

string

Week

string

softwareUpdateConfigurationCollectionItem

ソフトウェア更新プログラムの構成コレクション項目のプロパティ。

名前 説明
id

string

ソフトウェア更新プログラムの構成のリソース ID

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

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

preTask

taskProperties

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

TagOperators

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

名前 説明
All

string

Any

string

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

ソフトウェア更新プログラム構成の実行に許可される最大時間。 期間は、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

string

Definition

string

FeaturePack

string

Security

string

ServicePack

string

Tools

string

Unclassified

string

UpdateRollup

string

Updates

string