Managed Instance Keys - Get

Service:

SQL Database

API Version:

2021-11-01

Obtém uma chave de instância gerida.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
keyName	path	True	string	O nome da chave de instância gerida a obter.
managedInstanceName	path	True	string	O nome da instância gerida.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	ManagedInstanceKey	Obteve com êxito a chave de instância gerida especificada.
Other Status Codes		Respostas de Erro: *** 400 InvalidKeyName – foi atribuído um valor inválido para o nome da chave do servidor. 400 InvalidKeyType - O tipo de chave de servidor de criação não é suportado. 400 InvalidUpsertKeyType – as chaves TDE geridas pelo serviço são geridas pelo serviço. As chaves TDE geridas pelo serviço não suportam Criar ou Atualizar pelo utilizador. 400 InvalidKeyUpsertRequest - O pedido de chave de servidor de criação não existe ou não tem nenhum objeto de propriedades. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e subscrição especificados. 404 ResourceNotFound – o recurso pedido não foi encontrado.

Exemplos

Get the managed instance key

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

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

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

Definições

Name	Description
ManagedInstanceKey	Uma chave de instância gerida.
ServerKeyType	O tipo de chave como "ServiceManaged", "AzureKeyVault".

ManagedInstanceKey

Uma chave de instância gerida.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de protetor de encriptação. Estes são os metadados utilizados para a experiência de portal do Azure.
name	string	Nome do recurso.
properties.autoRotationEnabled	boolean	Sinalizador de opt-in de rotação automática de teclas. 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	Thumbprint da chave.
properties.uri	string	O URI da chave. Se ServerKeyType for AzureKeyVault, é necessário o URI.
type	string	Tipo de recurso.

ServerKeyType

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

Name	Tipo	Description
AzureKeyVault	string
ServiceManaged	string