Virtual Clusters - List

Service:

SQL Database

API Version:

2021-11-01

サブスクリプション内のすべての virtualClusters の一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/virtualClusters?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

応答

名前	型	説明
200 OK	VirtualClusterListResult	仮想クラスターの一覧が正常に取得されました。
Other Status Codes		エラー応答: *** 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

例

List virtualClusters

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/providers/Microsoft.Sql/virtualClusters?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for VirtualClusters List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/VirtualClusterList.json
     */
    /**
     * Sample code: List virtualClusters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listVirtualClusters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getVirtualClusters().list(Context.NONE);
    }
}

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

{
  "value": [
    {
      "properties": {
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "family": "Gen4",
        "childResources": [
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance1",
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance2"
        ],
        "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/resourceGroups/Federation/providers/Microsoft.Maintenance/maintenanceConfigurations/MiPolicy1"
      },
      "location": "onebox",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
      "name": "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
      "type": "Microsoft.Sql/virtualClusters"
    },
    {
      "properties": {
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "family": "Gen5",
        "childResources": [
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance3",
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance4"
        ],
        "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/resourceGroups/Federation/providers/Microsoft.Maintenance/maintenanceConfigurations/MiPolicy1"
      },
      "location": "onebox",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet2-14b795bd-9c8f-46ec-adb8-2b8eff56ac16",
      "name": "vc-subnet1-14b795bd-9c8f-46ec-adb8-2b8eff56ac16",
      "type": "Microsoft.Sql/virtualClusters"
    }
  ]
}

定義

名前	説明
VirtualCluster	Azure SQL仮想クラスター。
VirtualClusterListResult	仮想クラスターの一覧。

VirtualCluster

Azure SQL仮想クラスター。

名前	型	説明
id	string	リソースの ID
location	string	リソースの場所。
name	string	リソース名。
properties.childResources	string[]	この仮想クラスター内のリソースの一覧。
properties.family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
properties.maintenanceConfigurationId	string	この仮想クラスターに適用するメンテナンス構成 ID を指定します。
properties.subnetId	string	仮想クラスターのサブネット リソース ID。
tags	object	リソース タグ。
type	string	リソースの種類。

VirtualClusterListResult

仮想クラスターの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	VirtualCluster[]	結果の配列。