Server Keys - List

Serviço:

MySQL

Versão da API:

2020-01-01

Obtém uma lista de chaves do servidor.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ServerKeyListResult	Recuperou com êxito a lista de chaves do MySQL Server.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Exemplos

List the keys for a MySQL Server.

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys?api-version=2020-01-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python server_key_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.server_keys.list(
        resource_group_name="testrg",
        server_name="testserver",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2020-01-01/examples/ServerKeyList.json
if __name__ == "__main__":
    main()

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

dotnet

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

// Generated from example definition: specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2020-01-01/examples/ServerKeyList.json
// this example is just showing the usage of "ServerKeys_List" 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://learn.microsoft.com/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 MySqlServerResource created on azure
// for more information of creating MySqlServerResource, please refer to the document of MySqlServerResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
string serverName = "testserver";
ResourceIdentifier mySqlServerResourceId = MySqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
MySqlServerResource mySqlServer = client.GetMySqlServerResource(mySqlServerResourceId);

// get the collection of this MySqlServerKeyResource
MySqlServerKeyCollection collection = mySqlServer.GetMySqlServerKeys();

// invoke the operation and iterate over the result
await foreach (MySqlServerKeyResource 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
    MySqlServerKeyData 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 de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.DBforMySQL/servers/keys",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
        "creationDate": "2019-12-01T00:00:00.0Z"
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço do Lote.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	Resposta de erro
ServerKey	Uma chave do MySQL Server.
ServerKeyListResult	Uma lista de chaves do Servidor MySQL.
ServerKeyType	O tipo de chave como 'AzureKeyVault'.

CloudError

Objeto

Uma resposta de erro do serviço do Lote.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorResponse

Objeto

Resposta de erro

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

ServerKey

Objeto

Uma chave do MySQL Server.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Tipo de protetor de criptografia usado para proteger a chave.
name	string	O nome do recurso
properties.creationDate	string (date-time)	A data de criação da chave.
properties.serverKeyType	ServerKeyType	O tipo de chave como 'AzureKeyVault'.
properties.uri	string	O URI da chave.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ServerKeyListResult

Objeto

Uma lista de chaves do Servidor MySQL.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	ServerKey[]	Uma lista de chaves do Servidor MySQL.

ServerKeyType

Enumeração

O tipo de chave como 'AzureKeyVault'.

Valor	Description
AzureKeyVault