Public Maintenance Configurations - Get
パブリック メンテナンス構成レコードを取得する
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}?api-version=2023-09-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
メンテナンス構成名 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
api-version
|
query | True |
string |
クライアント要求で使用される API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
例
PublicMaintenanceConfigurations_GetForResource
Sample Request
Sample Response
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1",
"name": "configuration1",
"location": "westus2",
"properties": {
"namespace": "Microsoft.Maintenance",
"maintenanceScope": "SQLDB",
"visibility": "Public",
"maintenanceWindow": {
"startDateTime": "2020-04-30 08:00",
"expirationDateTime": "9999-12-31 00:00",
"duration": "05:00",
"timeZone": "Pacific Standard Time",
"recurEvery": "2Weeks"
}
}
}
定義
名前 | 説明 |
---|---|
created |
リソースを作成した ID の種類。 |
Error |
Azure メンテナンス サービスから受信したエラー応答の詳細。 |
Input |
Linux マシンにパッチを適用するための入力プロパティ。 |
Input |
パッチ実行の入力構成 |
Input |
Windows マシンにパッチを適用するための入力プロパティ。 |
Maintenance |
メンテナンス構成レコードの種類 |
Maintenance |
Azure メンテナンス サービスから受信したエラー応答。 |
Maintenance |
構成の maintenanceScope を取得または設定します |
Reboot |
パッチ操作が完了した後にマシンを再起動するかどうかに基づいて、ユーザーが定義した再起動設定の可能性があります。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Visibility |
構成の可視性を取得または設定します。 既定値は、「Custom」です |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
Azure メンテナンス サービスから受信したエラー応答の詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
message |
string |
人が判読できるエラーの表現。 |
InputLinuxParameters
Linux マシンにパッチを適用するための入力プロパティ。
名前 | 型 | 説明 |
---|---|---|
classificationsToInclude |
string[] |
パッチを適用するパッチの分類カテゴリ |
packageNameMasksToExclude |
string[] |
パッチ適用のために除外するパッケージ名。 |
packageNameMasksToInclude |
string[] |
修正プログラムを適用するために含めるパッケージ名。 |
InputPatchConfiguration
パッチ実行の入力構成
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
linuxParameters |
Linux マシンのパッチ適用に固有の入力パラメーター。 Windows マシンの場合は、このプロパティを渡さないでください。 |
||
rebootSetting | IfRequired |
パッチ操作が完了した後にマシンを再起動するかどうかに基づいて、ユーザーが定義した再起動設定の可能性があります。 |
|
windowsParameters |
Windows マシンの修正プログラムの適用に固有の入力パラメーター。 Linux マシンの場合は、このプロパティを渡さないでください。 |
InputWindowsParameters
Windows マシンにパッチを適用するための入力プロパティ。
名前 | 型 | 説明 |
---|---|---|
classificationsToInclude |
string[] |
パッチを適用するパッチの分類カテゴリ |
excludeKbsRequiringReboot |
boolean |
再起動が必要なパッチを除外する |
kbNumbersToExclude |
string[] |
修正プログラムを適用するために除外する Windows KBID。 |
kbNumbersToInclude |
string[] |
修正プログラムを適用するために含める Windows KBID。 |
MaintenanceConfiguration
メンテナンス構成レコードの種類
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾識別子 |
location |
string |
リソースの場所を取得または設定します |
name |
string |
リソースの名前 |
properties.extensionProperties |
object |
maintenanceConfiguration の extensionProperties を取得または設定します |
properties.installPatches |
パッチ実行操作に渡される入力パラメーター。 |
|
properties.maintenanceScope |
構成の maintenanceScope を取得または設定します |
|
properties.maintenanceWindow.duration |
string |
HH:mm 形式のメンテナンス期間。 指定しない場合は、指定されたメンテナンス範囲に基づいて既定値が使用されます。 例: 05:00。 |
properties.maintenanceWindow.expirationDateTime |
string |
メンテナンス期間の有効な有効期限 (YYYY-MM-DD hh:mm 形式)。 ウィンドウは、指定されたタイム ゾーンに作成され、そのタイム ゾーンに応じて夏時間に調整されます。 有効期限は、将来の日付に設定する必要があります。 指定しない場合は、最大日時 9999-12-31 23:59:59 に設定されます。 |
properties.maintenanceWindow.recurEvery |
string |
メンテナンス期間が繰り返されると予想されるレート。 レートは日、週、月のスケジュールで表すことができます。 毎日のスケジュールは recurEvery として書式設定されます: [頻度 (整数値)]['Day(s)']。 頻度が指定されていない場合、既定の頻度は 1 です。 日単位のスケジュールは、たとえば、recurEvery: Day, recurEvery:3Days になります。 週間スケジュールは recurEvery のフ書式設定されます: [頻度 (整数値)]['Week(s)'] [月曜日から日曜日までの平日をカンマで区切ったリスト(オプション)]。 週単位のスケジュールは、たとえば、recurEvery: 3Weeks, recurEvery:Week Saturday,Sunday になります。 月単位のスケジュールは、[Frequency as integer]['Month(s)'] [Comma separated list of month days] または [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)] で書式設定されます。 オフセット値は、-6 ~ 6 の範囲にする必要があります。 月次スケジュールの例は recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6. |
properties.maintenanceWindow.startDateTime |
string |
メンテナンス期間の有効な開始日 (YYYY-MM-DD hh:mm 形式)。 開始日は、現在の日付または将来の日付に設定できます。 ウィンドウは、指定されたタイム ゾーンに作成され、そのタイム ゾーンに応じて夏時間に調整されます。 |
properties.maintenanceWindow.timeZone |
string |
タイムゾーンの名前。 タイムゾーンの一覧は、PowerShell で [System.TimeZoneInfo]::GetSystemTimeZones() を実行することで取得できます。 例: 太平洋標準時、UTC、W. ヨーロッパ標準時、韓国標準時、Cen。 オーストラリア標準時。 |
properties.namespace |
string |
リソースの名前空間を取得または設定します |
properties.visibility |
構成の可視性を取得または設定します。 既定値は、「Custom」です |
|
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
tags |
object |
リソースのタグを取得または設定します |
type |
string |
リソースの種類 |
MaintenanceError
Azure メンテナンス サービスから受信したエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細 |
MaintenanceScope
構成の maintenanceScope を取得または設定します
名前 | 型 | 説明 |
---|---|---|
Extension |
string |
このメンテナンス スコープは、VM/VMSS への拡張機能のインストールを制御します |
Host |
string |
このメンテナンス スコープは、Azure プラットフォームの更新プログラム (つまり、顧客 VM をホストしている物理ノードへのサービス) のインストールを制御します。 |
InGuestPatch |
string |
このメンテナンス スコープは、VM/VMSS への Windows パッケージと Linux パッケージのインストールを制御します |
OSImage |
string |
このメンテナンス スコープは、VM/VMSS への os イメージのインストールを制御します |
Resource |
string |
このメンテナンス スコープは、Azure リソースの既定の更新プログラムのメンテナンスを制御します |
SQLDB |
string |
このメンテナンス スコープは、SQL Server プラットフォーム更新プログラムのインストールを制御します。 |
SQLManagedInstance |
string |
このメンテナンス スコープは、SQL マネージド インスタンス プラットフォームの更新プログラムのインストールを制御します。 |
RebootOptions
パッチ操作が完了した後にマシンを再起動するかどうかに基づいて、ユーザーが定義した再起動設定の可能性があります。
名前 | 型 | 説明 |
---|---|---|
Always |
string |
|
IfRequired |
string |
|
Never |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
Visibility
構成の可視性を取得または設定します。 既定値は、「Custom」です
名前 | 型 | 説明 |
---|---|---|
Custom |
string |
アクセス許可を持つユーザーにのみ表示されます。 |
Public |
string |
すべてのユーザーに表示されます。 |