Azure Synapse Analytics での専用 SQL プール (旧称 SQL DW) 用の REST API

[アーティクル]
06/01/2023

Azure Synapse Analytics で専用 SQL プール (旧称 SQL DW) のコンピューティングを管理するための REST API。

Note

この記事で説明している REST API は、スタンドアロンの専用 SQL プール (旧称 SQL DW) 用であり、Azure Synapse Analytics ワークスペースの専用の SQL プールには適用されません。 Azure Synapse Analytics ワークスペース専用に使用する REST API の詳細については、「Azure Synapse Analytics ワークスペース REST API」を参照してください。

コンピューティングのスケーリング

Data Warehouse ユニットを変更するには、データベースの作成または更新 REST API を使います。次の例では、MyServer サーバーにホストされているデータベース MySQLDW のデータウェアハウスユニットを DW1000 に設定します。サーバーは "ResourceGroup1" という名前の Asure リソースグループ内にあります。

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Sql/servers/{server-name}/databases/{database-name}?api-version=2020-08-01-preview HTTP/1.1
Content-Type: application/json; charset=UTF-8

{
    "location": "West Central US",
    "sku": {
        "name": "DW200c"
    }
}

コンピューティングの一時停止

データベースを一時停止するには、データベースの一時停止 REST API を使います。次の例では、"Server01" という名前のサーバーにホストされている "Database02" という名前のデータベースが一時停止されます。サーバーは "ResourceGroup1" という名前の Asure リソースグループ内にあります。

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Sql/servers/{server-name}/databases/{database-name}/pause?api-version=2020-08-01-preview HTTP/1.1

コンピューティングの再開

データベースを開始するには、データベースの再開 REST API を使います。次の例では、"Server01" という名前のサーバーにホストされている "Database02" という名前のデータベースが開始されます。サーバーは "ResourceGroup1" という名前の Asure リソースグループ内にあります。

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Sql/servers/{server-name}/databases/{database-name}/resume?api-version=2020-08-01-preview HTTP/1.1

データベース状態の確認

Note

現在、"データベース状態の確認" では、データベースがオンラインワークフローを完了している間に "オンライン" が返され、その結果として接続エラーが発生する場合があります。この API 呼び出しを使用して接続試行をトリガーする場合は、アプリケーションコードに 2 分から 3 分の遅延を追加する必要がある可能性があります。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2020-08-01-preview

メンテナンススケジュールの取得

専用 SQL プール (旧称 SQL DW) に設定されているメンテナンススケジュールを確認します。

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Sql/servers/{server-name}/databases/{database-name}/maintenanceWindows/current?maintenanceWindowName=current&api-version=2017-10-01-preview HTTP/1.1

メンテナンススケジュールの設定

既存の専用 SQL プール (旧称 SQL DW) のメンテナンススケジュールを設定および更新します。

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Sql/servers/{server-name}/databases/{database-name}/maintenanceWindows/current?maintenanceWindowName=current&api-version=2017-10-01-preview HTTP/1.1

{
    "properties": {
        "timeRanges": [
                {
                                "dayOfWeek": "Saturday",
                                "startTime": "00:00",
                                "duration": "08:00",
                },
                {
                                "dayOfWeek": "Wednesday",
                                "startTime": "00:00",
                                "duration": "08:00",
                }
                ]
    }
}

次のステップ

詳細については、コンピューティングの管理に関するページを参照してください。