Start Stop Managed Instance Schedules - Get

サービス:: SQL Database

API バージョン:: 2023-08-01

マネージドインスタンスの開始/停止スケジュールを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/startStopSchedules/default?api-version=2023-08-01

URI パラメーター

名前	/	必須	型	説明
managedInstanceName	path	True	string	マネージドインスタンスの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
startStopScheduleName	path	True	StartStopScheduleName	マネージドインスタンスの開始/停止スケジュールの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	StartStopManagedInstanceSchedule	開始/停止スケジュールが正常に取得されました。
Other Status Codes	ErrorResponse	エラー応答: *** 204 ManagementServiceStartStopManagedInstanceScheduleNameInvalid - ユーザーが 'default' とは異なるスケジュール名で開始/停止スケジュールの CRUD 操作を実行しようとしました 400 ManagementServiceStartStopManagedInstanceScheduleSmallTimespan - 2 つの連続するアクション間の時間が 1 時間未満です。 400 ManagementServiceStartStopManagedInstanceScheduleSubscriptionNotEnabledForFeature - ユーザーは、適切なサブスクリプション機能のサブスクリプション許可リストを持たずに、Start/Stop 機能を使用しようとしました。 400 ManagementServiceStartStopManagedInstanceScheduleNotSupportedOnSKU - 指定された SKU でスケジュールされた開始/停止操作はサポートされていません。 400 ManagementServiceStopManagedInstanceHostedOnRdfePlatform - Feature Wave 2022 年 11 月で実行されていないインスタンスで実行を停止する 400 StartStopOfManagedInstanceIsDisabled - マネージドインスタンスでの開始操作と停止操作が有効になっていません。 400 ManagementServiceStartStopManagedInstanceScheduleFeatureDisabled - ユーザーがスケジュールされた Start/Stop Azure SQL Managed Instance 機能を使用しようとしましたが、これは無効になっています。 400 ManagementServiceStartStopManagedInstanceScheduleOverlap - スケジュールペアで重複します。 400 ManagementServiceStartStopManagedInstanceScheduleCreateOrUpdateRequestParametersInvalid - 要求の本文で指定されたパラメーターのセットが空または無効です。 400 ManagementServiceStartStopManagedInstanceScheduleCreateOrUpdateRequestTimeZoneInvalid - 指定されたタイムゾーンパラメーターが無効です。 400 ManagementServiceStartStopManagedInstanceScheduleCreateOrUpdateRequestScheduleInvalid - 指定された開始/停止スケジュールが無効です。スケジュールリストにアイテムが含まれているか、リスト内の一部のアイテムに無効な値が含まれています。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 ManagementServiceStartStopManagedInstanceScheduleNotFound - 指定されたマネージドインスタンスのスケジュールが存在しません。 404 ManagementServiceStartStopManagedInstanceScheduleNameInvalid - ユーザーが 'default' とは異なるスケジュール名で開始/停止スケジュールの CRUD 操作を実行しようとしました 409 ManagementServiceStartStopManagedInstanceScheduleConflictingOperation - Azure SQL Managed Instance の開始/停止スケジュールの作成/更新/削除操作が失敗しました。スケジュールは作成されなかったか、進行中のスケジュールされた操作でビジー状態であったため、更新または削除できませんでした。後で要求を再試行してください。

名前

型

説明

200 OK

StartStopManagedInstanceSchedule

開始/停止スケジュールが正常に取得されました。

Other Status Codes

ErrorResponse

エラー応答: ***

204 ManagementServiceStartStopManagedInstanceScheduleNameInvalid - ユーザーが 'default' とは異なるスケジュール名で開始/停止スケジュールの CRUD 操作を実行しようとしました
400 ManagementServiceStartStopManagedInstanceScheduleSmallTimespan - 2 つの連続するアクション間の時間が 1 時間未満です。
400 ManagementServiceStartStopManagedInstanceScheduleSubscriptionNotEnabledForFeature - ユーザーは、適切なサブスクリプション機能のサブスクリプション許可リストを持たずに、Start/Stop 機能を使用しようとしました。
400 ManagementServiceStartStopManagedInstanceScheduleNotSupportedOnSKU - 指定された SKU でスケジュールされた開始/停止操作はサポートされていません。
400 ManagementServiceStopManagedInstanceHostedOnRdfePlatform - Feature Wave 2022 年 11 月で実行されていないインスタンスで実行を停止する
400 StartStopOfManagedInstanceIsDisabled - マネージドインスタンスでの開始操作と停止操作が有効になっていません。
400 ManagementServiceStartStopManagedInstanceScheduleFeatureDisabled - ユーザーがスケジュールされた Start/Stop Azure SQL Managed Instance 機能を使用しようとしましたが、これは無効になっています。
400 ManagementServiceStartStopManagedInstanceScheduleOverlap - スケジュールペアで重複します。
400 ManagementServiceStartStopManagedInstanceScheduleCreateOrUpdateRequestParametersInvalid - 要求の本文で指定されたパラメーターのセットが空または無効です。
400 ManagementServiceStartStopManagedInstanceScheduleCreateOrUpdateRequestTimeZoneInvalid - 指定されたタイムゾーンパラメーターが無効です。
400 ManagementServiceStartStopManagedInstanceScheduleCreateOrUpdateRequestScheduleInvalid - 指定された開始/停止スケジュールが無効です。スケジュールリストにアイテムが含まれているか、リスト内の一部のアイテムに無効な値が含まれています。
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。
404 ManagementServiceStartStopManagedInstanceScheduleNotFound - 指定されたマネージドインスタンスのスケジュールが存在しません。
404 ManagementServiceStartStopManagedInstanceScheduleNameInvalid - ユーザーが 'default' とは異なるスケジュール名で開始/停止スケジュールの CRUD 操作を実行しようとしました
409 ManagementServiceStartStopManagedInstanceScheduleConflictingOperation - Azure SQL Managed Instance の開始/停止スケジュールの作成/更新/削除操作が失敗しました。スケジュールは作成されなかったか、進行中のスケジュールされた操作でビジー状態であったため、更新または削除できませんでした。後で要求を再試行してください。

例

Gets the managed instance's Start/Stop schedule.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/schedulerg/providers/Microsoft.Sql/managedInstances/schedulemi/startStopSchedules/default?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/StartStopManagedInstanceScheduleGet.json
// this example is just showing the usage of "StartStopManagedInstanceSchedules_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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "schedulerg";
string managedInstanceName = "schedulemi";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this ManagedInstanceStartStopScheduleResource
ManagedInstanceStartStopScheduleCollection collection = managedInstance.GetManagedInstanceStartStopSchedules();

// invoke the operation
ManagedInstanceStartStopScheduleName startStopScheduleName = ManagedInstanceStartStopScheduleName.Default;
NullableResponse<ManagedInstanceStartStopScheduleResource> response = await collection.GetIfExistsAsync(startStopScheduleName);
ManagedInstanceStartStopScheduleResource 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
    ManagedInstanceStartStopScheduleData 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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/schedulerg/providers/Microsoft.Sql/managedInstances/schedulemi/startStopSchedules/default",
  "name": "default",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2021-08-26T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-27T04:41:33.937Z"
  },
  "properties": {
    "description": "This is a schedule for our Dev/Test environment.",
    "nextExecutionTime": "2021-08-26T14:00:00",
    "nextRunAction": "Stop",
    "scheduleList": [
      {
        "startDay": "Thursday",
        "startTime": "06:00 PM",
        "stopDay": "Thursday",
        "stopTime": "05:00 PM"
      },
      {
        "startDay": "Thursday",
        "startTime": "03:00 PM",
        "stopDay": "Thursday",
        "stopTime": "02:00 PM"
      }
    ],
    "timeZoneId": "Central European Standard Time"
  },
  "type": "Microsoft.Sql/managedInstances/startStopSchedules"
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
DayOfWeek	開始日。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ScheduleItem	サーバーを開始または停止するタイミングを説明するスケジュール情報。
StartStopManagedInstanceSchedule	マネージドインスタンスの開始/停止スケジュール。
StartStopScheduleName	マネージドインスタンスの開始/停止スケジュールの名前。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DayOfWeek

列挙

開始日。

値	説明
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ScheduleItem

Object

サーバーを開始または停止するタイミングを説明するスケジュール情報。

名前	型	説明
startDay	DayOfWeek	開始日。
startTime	string	開始時刻。
stopDay	DayOfWeek	停止日。
stopTime	string	停止時刻。

StartStopManagedInstanceSchedule

Object

マネージドインスタンスの開始/停止スケジュール。

名前	型	規定値	説明
id	string		リソース ID。
name	string		リソース名。
properties.description	string		スケジュールの説明。
properties.nextExecutionTime	string		対応するスケジュールタイムゾーンで次のアクションが実行されるタイムスタンプ。
properties.nextRunAction	string		実行する次のアクション (開始または停止)
properties.scheduleList	ScheduleItem[]		スケジュールの一覧。
properties.timeZoneId	string	UTC	スケジュールのタイムゾーン。
systemData	systemData		スケジュールされたリソースのシステムデータ。
type	string		リソースの種類。

StartStopScheduleName

列挙

マネージドインスタンスの開始/停止スケジュールの名前。

値	説明
default

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Start Stop Managed Instance Schedules - Get

URI パラメーター

応答

例

Gets the managed instance's Start/Stop schedule.

要求のサンプル

応答のサンプル

定義

createdByType

DayOfWeek

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ScheduleItem

StartStopManagedInstanceSchedule

StartStopScheduleName

systemData