Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Mendapatkan daftar kunci instans terkelola.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
managedInstanceName	path	True	string	Nama instans terkelola.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.
$filter	query		string	Ekspresi filter OData yang memfilter elemen dalam koleksi.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagedInstanceKeyListResult	Berhasil mengambil daftar kunci instans terkelola.
Other Status Codes		Respons Kesalahan: *** 400 InvalidKeyName - Nilai yang tidak valid diberikan untuk nama kunci server. 400 InvalidKeyType - Jenis kunci buat server tidak didukung. 400 InvalidUpsertKeyType - Kunci TDE yang dikelola layanan dikelola oleh layanan. Kunci TDE yang dikelola layanan tidak mendukung Buat atau Perbarui oleh pengguna. 400 InvalidKeyUpsertRequest - Permintaan buat kunci server tidak ada atau tidak memiliki objek properti. 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan.

Contoh

List the keys for a managed instance.

Sample Request

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

import com.azure.core.util.Context;

/** 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, 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": [
    {
      "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": {}
    }
  ]
}

Definisi

Nama	Deskripsi
ManagedInstanceKey	Kunci instans terkelola.
ManagedInstanceKeyListResult	Daftar kunci instans terkelola.
ServerKeyType	Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.

ManagedInstanceKey

Kunci instans terkelola.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
kind	string	Jenis pelindung enkripsi. Ini adalah metadata yang digunakan untuk pengalaman portal Azure.
name	string	Nama sumber daya.
properties.autoRotationEnabled	boolean	Bendera keikutsertaan rotasi otomatis kunci. Baik true maupun false.
properties.creationDate	string	Tanggal pembuatan kunci.
properties.serverKeyType	ServerKeyType	Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.
properties.thumbprint	string	Thumbprint kunci.
properties.uri	string	URI kunci. Jika ServerKeyType adalah AzureKeyVault, maka URI diperlukan.
type	string	Jenis sumber daya

ManagedInstanceKeyListResult

Daftar kunci instans terkelola.

Nama	Jenis	Deskripsi
nextLink	string	Tautan untuk mengambil halaman hasil berikutnya.
value	ManagedInstanceKey[]	Array hasil.

ServerKeyType

Jenis kunci seperti 'ServiceManaged', 'AzureKeyVault'.

Nama	Jenis	Deskripsi
AzureKeyVault	string
ServiceManaged	string