Ssh Public Keys - Get

Referência

Service:: Compute

API Version:: 2024-03-01

Recupera informações sobre uma chave pública SSH.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}?api-version=2024-03-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
sshPublicKeyName	path	True	string	O nome da chave pública SSH.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	SshPublicKeyResource	OK
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get an ssh public key.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName?api-version=2024-03-01

Sample Response

Status code:: 200

{
  "name": "mySshPublicKeyName",
  "location": "westus",
  "tags": {
    "{tagName}": "{tagValue}"
  },
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName",
  "properties": {
    "publicKey": "{ssh-rsa public key}"
  }
}

Definições

Nome	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros de API.
CloudError	Uma resposta de erro do serviço de computação.
InnerError	Detalhes do erro interno.
SshPublicKeyResource	Especifica informações sobre a chave pública SSH.

ApiError

Erro de API.

Nome	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Nome	Tipo	Description
error	ApiError	Erro de API.

InnerError

Detalhes do erro interno.

Nome	Tipo	Description
errordetail	string	A mensagem de erro interna ou o despejo de exceção.
exceptiontype	string	O tipo de exceção.

SshPublicKeyResource

Especifica informações sobre a chave pública SSH.

Nome	Tipo	Description
id	string	ID do recurso
location	string	Localização do recurso
name	string	Nome do recurso
properties.publicKey	string	Chave pública SSH usada para autenticar em uma máquina virtual por meio de ssh. Se essa propriedade não for fornecida inicialmente quando o recurso for criado, a propriedade publicKey será preenchida quando generateKeyPair for chamado. Se a chave pública for fornecida após a criação do recurso, a chave pública fornecida precisará ter pelo menos 2048 bits e no formato ssh-rsa.
tags	object	Marcações de recursos
type	string	Tipo de recurso