Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Obtém uma lista de chaves de instância gerenciada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$filter	query		string	Uma expressão de filtro OData que filtra elementos na coleção.

Respostas

Nome	Tipo	Description
200 OK	ManagedInstanceKeyListResult	Recuperou com êxito a lista de chaves de instância gerenciada.
Other Status Codes		Respostas de erro: *** 400 InvalidKeyName - Um valor inválido foi fornecido para o nome da chave do servidor. 400 InvalidKeyType – Não há suporte para o tipo de chave criar servidor. 400 InvalidUpsertKeyType – As chaves TDE gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não dão suporte a Criar ou Atualizar pelo usuário. 400 InvalidKeyUpsertRequest - A solicitação criar chave de servidor não existe ou não tem nenhum objeto de propriedades. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.

Exemplos

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

Definições

Nome	Description
ManagedInstanceKey	Uma chave de instância gerenciada.
ManagedInstanceKeyListResult	Uma lista de chaves de instância gerenciada.
ServerKeyType	O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.

ManagedInstanceKey

Uma chave de instância gerenciada.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de protetor de criptografia. Esses são metadados usados para a experiência de portal do Azure.
name	string	Nome do recurso.
properties.autoRotationEnabled	boolean	Sinalizador de aceitação de rotação automática de chave. Verdadeiro ou falso.
properties.creationDate	string	A data de criação da chave.
properties.serverKeyType	ServerKeyType	O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.
properties.thumbprint	string	Impressão digital da chave.
properties.uri	string	O URI da chave. Se ServerKeyType for AzureKeyVault, o URI será necessário.
type	string	Tipo de recurso.

ManagedInstanceKeyListResult

Uma lista de chaves de instância gerenciada.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	ManagedInstanceKey[]	Matriz de resultados.

ServerKeyType

O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.

Nome	Tipo	Description
AzureKeyVault	string
ServiceManaged	string