Public Maintenance Configurations - Get

リファレンス

Service:: Maintenance

API Version:: 2023-09-01-preview

パブリックメンテナンス構成レコードを取得する

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}?api-version=2023-09-01-preview

URI パラメーター

名前	/	必須	型	説明
resourceName	path	True	string	メンテナンス構成名
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

応答

名前	型	説明
200 OK	MaintenanceConfiguration	OK
Other Status Codes	MaintenanceError	BadRequest

例

PublicMaintenanceConfigurations_GetForResource

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1?api-version=2023-09-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.maintenance import MaintenanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-maintenance
# USAGE
    python public_maintenance_configurations_get_for_resource.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MaintenanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.public_maintenance_configurations.get(
        resource_name="configuration1",
    )
    print(response)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Maintenance;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json
// this example is just showing the usage of "PublicMaintenanceConfigurations_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this MaintenancePublicConfigurationResource
MaintenancePublicConfigurationCollection collection = subscriptionResource.GetMaintenancePublicConfigurations();

// invoke the operation
string resourceName = "configuration1";
NullableResponse<MaintenancePublicConfigurationResource> response = await collection.GetIfExistsAsync(resourceName);
MaintenancePublicConfigurationResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    MaintenanceConfigurationData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorDetails	Azure メンテナンスサービスから受信したエラー応答の詳細。
InputLinuxParameters	Linux マシンにパッチを適用するための入力プロパティ。
InputPatchConfiguration	パッチ実行の入力構成
InputWindowsParameters	Windows マシンにパッチを適用するための入力プロパティ。
MaintenanceConfiguration	メンテナンス構成レコードの種類
MaintenanceError	Azure メンテナンスサービスから受信したエラー応答。
MaintenanceScope	構成の maintenanceScope を取得または設定します
RebootOptions	パッチ操作が完了した後にマシンを再起動するかどうかに基づいて、ユーザーが定義した再起動設定の可能性があります。
systemData	リソースの作成と最後の変更に関連するメタデータ。
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	InputLinuxParameters		Linux マシンのパッチ適用に固有の入力パラメーター。 Windows マシンの場合は、このプロパティを渡さないでください。
rebootSetting	RebootOptions	IfRequired	パッチ操作が完了した後にマシンを再起動するかどうかに基づいて、ユーザーが定義した再起動設定の可能性があります。
windowsParameters	InputWindowsParameters		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	InputPatchConfiguration	パッチ実行操作に渡される入力パラメーター。
properties.maintenanceScope	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	Visibility	構成の可視性を取得または設定します。既定値は、「Custom」です
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースのタグを取得または設定します
type	string	リソースの種類

MaintenanceError

Azure メンテナンスサービスから受信したエラー応答。

名前	型	説明
error	ErrorDetails	エラーの詳細

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	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Visibility

構成の可視性を取得または設定します。既定値は、「Custom」です

名前	型	説明
Custom	string	アクセス許可を持つユーザーにのみ表示されます。
Public	string	すべてのユーザーに表示されます。