Managed Instance Keys - List By Instance

サービス:

SQL Database

API バージョン:

2021-11-01

マネージド インスタンス キーの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys?api-version=2021-11-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys?$filter={$filter}&api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
managedInstanceName	path	True	string	マネージド インスタンスの名前。
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。
$filter	query		string	コレクション内の要素をフィルター処理する OData フィルター式。

応答

名前	型	説明
200 OK	ManagedInstanceKeyListResult	マネージド インスタンス キーの一覧が正常に取得されました。
Other Status Codes		エラー応答: *** 400 InvalidKeyName - サーバー キー名に無効な値が指定されました。 400 InvalidKeyType - サーバー キーの作成の種類はサポートされていません。 400 InvalidUpsertKeyType - サービスで管理される TDE キーは、サービスによって管理されます。 サービスマネージド TDE キーは、ユーザーによる作成または更新をサポートしていません。 400 InvalidKeyUpsertRequest - サーバー キーの作成要求が存在しないか、プロパティ オブジェクトがありません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。

例

List the keys for a managed instance.

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys?api-version=2021-11-01

Java

/**
 * Samples for ManagedInstanceKeys ListByInstance.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceKeyList.json
     */
    /**
     * Sample code: List the keys for a managed instance.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheKeysForAManagedInstance(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceKeys().listByInstance("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, com.azure.core.util.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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/managedInstances/keys",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/managedInstances/keys",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/managedInstances/keys",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

定義

名前	説明
ManagedInstanceKey	マネージド インスタンス キー。
ManagedInstanceKeyListResult	マネージド インスタンス キーの一覧。
ServerKeyType	'ServiceManaged'、'AzureKeyVault' などのキーの種類。

ManagedInstanceKey

マネージド インスタンス キー。

名前	型	説明
id	string	リソースの ID
kind	string	暗号化保護機能の種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。
name	string	リソース名。
properties.autoRotationEnabled	boolean	キー自動ローテーションオプトイン フラグ。 true または false。
properties.creationDate	string	キーの作成日。
properties.serverKeyType	ServerKeyType	'ServiceManaged'、'AzureKeyVault' などのキーの種類。
properties.thumbprint	string	キーの拇印。
properties.uri	string	キーの URI。 ServerKeyType が AzureKeyVault の場合は、URI が必要です。
type	string	リソースの種類。

ManagedInstanceKeyListResult

マネージド インスタンス キーの一覧。

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

ServerKeyType

'ServiceManaged'、'AzureKeyVault' などのキーの種類。

名前	型	説明
AzureKeyVault	string
ServiceManaged	string