Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Obtiene una lista de claves de instancia administrada.

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 identificador URI

Nombre	En	Requerido	Tipo	Description
managedInstanceName	path	True	string	El nombre de la instancia administrada.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.
$filter	query		string	Expresión de filtro de OData que filtra los elementos de la colección.

Respuestas

Nombre	Tipo	Description
200 OK	ManagedInstanceKeyListResult	Se recuperó correctamente la lista de claves de instancia administrada.
Other Status Codes		Respuestas de error: *** 400 InvalidKeyName: se ha proporcionado un valor no válido para el nombre de clave del servidor. 400 InvalidKeyType: no se admite el tipo de clave create server. 400 InvalidUpsertKeyType: el servicio administra las claves TDE administradas por el servicio. Las claves de TDE administradas por el servicio no admiten la creación o actualización por parte del usuario. 400 InvalidKeyUpsertRequest: la solicitud de creación de clave de servidor no existe o no tiene ningún objeto de propiedades. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Ejemplos

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

Definiciones

Nombre	Description
ManagedInstanceKey	Una clave de instancia administrada.
ManagedInstanceKeyListResult	Lista de claves de instancia administrada.
ServerKeyType	El tipo de clave, como "ServiceManaged", "AzureKeyVault".

ManagedInstanceKey

Una clave de instancia administrada.

Nombre	Tipo	Description
id	string	Identificador del recurso.
kind	string	Tipo de protector de cifrado. Estos son los metadatos que se usan para la experiencia de Azure Portal.
name	string	Nombre del recurso.
properties.autoRotationEnabled	boolean	Marca de participación de rotación automática de claves. Puede ser true o false.
properties.creationDate	string	Fecha de creación de la clave.
properties.serverKeyType	ServerKeyType	El tipo de clave, como "ServiceManaged", "AzureKeyVault".
properties.thumbprint	string	Huella digital de la clave.
properties.uri	string	URI de la clave. Si ServerKeyType es AzureKeyVault, se requiere el URI.
type	string	Tipo de recurso.

ManagedInstanceKeyListResult

Lista de claves de instancia administrada.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	ManagedInstanceKey[]	Matriz de resultados.

ServerKeyType

El tipo de clave, como "ServiceManaged", "AzureKeyVault".

Nombre	Tipo	Description
AzureKeyVault	string
ServiceManaged	string