Server Keys - List By Server

Serviço:: SQL Database

Versão da API:: 2023-08-01

Obtém uma lista de chaves de servidor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys?api-version=2023-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
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.

Respostas

Name	Tipo	Description
200 OK	ServerKeyListResult	Recuperada com êxito a lista de chaves do servidor.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidKeyName - Um valor inválido foi fornecido 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 gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não suportam Criar ou Atualizar pelo usuário. 400 InvalidKeyUpsertRequest - A solicitação de chave de servidor de criação não existe ou não tem nenhum objeto de propriedades. 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

Name

Tipo

Description

200 OK

ServerKeyListResult

Recuperada com êxito a lista de chaves do servidor.

Other Status Codes

ErrorResponse

Respostas de erro: ***

400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada
400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial
400 InvalidKeyName - Um valor inválido foi fornecido 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 gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não suportam Criar ou Atualizar pelo usuário.
400 InvalidKeyUpsertRequest - A solicitação de chave de servidor de criação não existe ou não tem nenhum objeto de propriedades.
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.
404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

Exemplos

List the server keys by server

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerKeyList.json
// this example is just showing the usage of "ServerKeys_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerKeyResource
SqlServerKeyCollection collection = sqlServer.GetSqlServerKeys();

// invoke the operation and iterate over the result
await foreach (SqlServerKeyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerKeyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "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/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "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/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerKey	Uma chave de servidor.
ServerKeyListResult	Uma lista de chaves de servidor.
ServerKeyType	O tipo de chave do servidor como 'ServiceManaged', 'AzureKeyVault'.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ServerKey

Object

Uma chave de servidor.

Name	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de protetor de criptografia. Esses são metadados usados para a experiência do portal do Azure.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.autoRotationEnabled	boolean	Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.
properties.creationDate	string (date-time)	A data de criação da chave do servidor.
properties.serverKeyType	ServerKeyType	O tipo de chave do servidor como 'ServiceManaged', 'AzureKeyVault'.
properties.subregion	string	Sub-região da chave do servidor.
properties.thumbprint	string	Impressão digital da chave do servidor.
properties.uri	string	O URI da chave do servidor. Se ServerKeyType for AzureKeyVault, o URI será necessário. O URI AKV deve estar neste formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Tipo de recurso.

ServerKeyListResult

Object

Uma lista de chaves de servidor.

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

ServerKeyType

Enumeração

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

Valor	Description
ServiceManaged
AzureKeyVault

Partilhar via

Server Keys - List By Server

Parâmetros do URI

Respostas

Exemplos

List the server keys by server

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerKey

ServerKeyListResult

ServerKeyType