Server Keys - List By Server

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=2021-11-01-preview

Parâmetros de URI

Name In Required Type Description
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.

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 Type Description
200 OK

Recuperou com êxito a lista de chaves do servidor.

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 server keys by server

Sample Request

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

Sample Response

{
  "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

ServerKey

Uma chave de servidor.

ServerKeyListResult

Uma lista de chaves de servidor.

ServerKeyType

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

ServerKey

Uma chave de servidor.

Name Type Description
id
  • string

ID do recurso.

kind
  • string

Tipo de protetor de criptografia. Esses são metadados usados para a experiência portal do Azure.

location
  • string

Local do recurso.

name
  • string

Nome do recurso.

properties.autoRotationEnabled
  • boolean

Sinalizador de aceitação de rotação automática de teclas. Verdadeiro ou falso.

properties.creationDate
  • string

A data de criação da chave do servidor.

properties.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 o ServerKeyType for AzureKeyVault, o URI será necessário. O URI do AKV é necessário para estar nesse formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

type
  • string

Tipo de recurso.

ServerKeyListResult

Uma lista de chaves de servidor.

Name Type Description
nextLink
  • string

Link para recuperar a próxima página de resultados.

value

Matriz de resultados.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string