Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Yönetilen örnek anahtarlarının listesini alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
managedInstanceName	path	True	string	Yönetilen örneğin adı.
resourceGroupName	path	True	string	Kaynağı içeren kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
subscriptionId	path	True	string	Azure aboneliğini tanımlayan abonelik kimliği.
api-version	query	True	string	İstek için kullanılacak API sürümü.
$filter	query		string	Koleksiyondaki öğeleri filtreleyen bir OData filtre ifadesi.

Yanıtlar

Name	Tür	Description
200 OK	ManagedInstanceKeyListResult	Yönetilen örnek anahtarlarının listesi başarıyla alındı.
Other Status Codes		Hata Yanıtları: ** 400 InvalidKeyName - Sunucu anahtarı adı için geçersiz bir değer verildi. 400 InvalidKeyType - Sunucu anahtarı oluşturma türü desteklenmiyor. 400 InvalidUpsertKeyType - Hizmet tarafından yönetilen TDE anahtarları hizmet tarafından yönetilir. Hizmet tarafından yönetilen TDE anahtarları kullanıcı tarafından Oluşturma veya Güncelleştirme'yi desteklemez. 400 InvalidKeyUpsertRequest - Sunucu anahtarı oluşturma isteği yok veya özellik nesnesi yok. 404 SubscriptionDoesNotHaveServer - İstenen sunucu bulunamadı 404 ServerNotInSubscriptionResourceGroup - Belirtilen sunucu belirtilen kaynak grubunda ve abonelikte yok.

Örnekler

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": {}
    }
  ]
}

Tanımlar

Name	Description
ManagedInstanceKey	Yönetilen örnek anahtarı.
ManagedInstanceKeyListResult	Yönetilen örnek anahtarlarının listesi.
ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi anahtar türü.

ManagedInstanceKey

Yönetilen örnek anahtarı.

Name	Tür	Description
id	string	Kaynak Kimliği.
kind	string	Şifreleme koruyucusu türü. Bu, Azure portal deneyimi için kullanılan meta verilerdir.
name	string	Kaynak adı.
properties.autoRotationEnabled	boolean	Anahtar otomatik döndürme kabul etme bayrağı. True veya false.
properties.creationDate	string	Anahtar oluşturma tarihi.
properties.serverKeyType	ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi anahtar türü.
properties.thumbprint	string	Anahtarın parmak izi.
properties.uri	string	Anahtarın URI'sini. ServerKeyType AzureKeyVault ise URI gereklidir.
type	string	Kaynak türü.

ManagedInstanceKeyListResult

Yönetilen örnek anahtarlarının listesi.

Name	Tür	Description
nextLink	string	Sonuçların sonraki sayfasını almak için bağlantı.
value	ManagedInstanceKey[]	Sonuç dizisi.

ServerKeyType

'ServiceManaged', 'AzureKeyVault' gibi anahtar türü.

Name	Tür	Description
AzureKeyVault	string
ServiceManaged	string