Servers - Get

Serviço:: SQL Database

Versão da API:: 2025-01-01

Obtém um servidor.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2025-01-01&$expand={$expand}

Parâmetros do URI

Name	Em	Necessá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 (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$expand	query		string	Os recursos da criança para incluir na resposta.

Respostas

Name	Tipo	Description
200 OK	Server	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get server

Get server with $expand=administrators/activedirectory

Get server

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "kind": "v12.0",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "isIPv6Enabled": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "description": "Auto-approved",
            "actionsRequired": "None",
            "status": "Approved"
          },
          "provisioningState": "Ready"
        }
      }
    ],
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "retentionDays": 7,
    "state": "Ready",
    "version": "12.0",
    "workspaceFeature": "Connected"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Get server with $expand=administrators/activedirectory

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "kind": "v12.0",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "administrators": {
      "azureADOnlyAuthentication": true,
      "login": "bob@contoso.com",
      "principalType": "User",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "isIPv6Enabled": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "description": "Auto-approved",
            "actionsRequired": "None",
            "status": "Approved"
          },
          "provisioningState": "Ready"
        }
      }
    ],
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "retentionDays": 7,
    "state": "Ready",
    "version": "12.0",
    "workspaceFeature": "Connected"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Definições

Name	Description
AdministratorType	Tipo de administrador de corte.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExternalGovernanceStatus	Estatuto da governação externa.
IdentityType	O tipo de identidade. Defina isto como 'SystemAssigned' para criar e atribuir automaticamente um principal do Azure Active Directory ao recurso.
MinimalTlsVersion	Versão TLS mínima. Valores permitidos: 'Nenhum', 1.0', '1.1', '1.2', '1.3'
PrincipalType	Tipo principal do administrador de corte.
PrivateEndpointConnectionProperties	Propriedades de uma conexão de ponto de extremidade privada.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para conexão de serviço de link privado.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	O status da conexão do serviço de link privado.
ResourceIdentity	Configuração de identidade do Azure Active Directory para um recurso.
Server	Um servidor Base de Dados SQL do Azure.
ServerCreateMode	Modo de criação para o servidor, apenas os valores válidos para isso são Normal e Restauração.
ServerExternalAdministrator	Propriedades de um administrador do Ative Directory.
ServerNetworkAccessFlag	Restringir ou não o acesso à rede de saída para este servidor. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'
ServerPrivateEndpointConnection	Uma conexão de ponto de extremidade privada em um servidor
ServerPublicNetworkAccessFlag	Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. O valor é opcional, mas se passado, deve ser 'Enabled' ou 'Disabled' ou 'SecuredByPerimeter'
ServerWorkspaceFeature	Se o servidor existente tem ou não um espaço de trabalho criado e se ele permite a conexão do espaço de trabalho
systemData	Metadados referentes à criação e última modificação do recurso.
UserIdentity	Configuração de identidade do Azure Active Directory para um recurso.

AdministratorType

Enumeração

Tipo de administrador de corte.

Valor	Description
ActiveDirectory	ActiveDirectory

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

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 alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExternalGovernanceStatus

Enumeração

Estatuto da governação externa.

Valor	Description
Enabled	Ativado
Disabled	Disabled

IdentityType

Enumeração

O tipo de identidade. Defina isto como 'SystemAssigned' para criar e atribuir automaticamente um principal do Azure Active Directory ao recurso.

Valor	Description
None	Nenhum
SystemAssigned	Atribuído pelo Sistema
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemAssigned, UserAssigned

MinimalTlsVersion

Enumeração

Versão TLS mínima. Valores permitidos: 'Nenhum', 1.0', '1.1', '1.2', '1.3'

Valor	Description
None	Nenhum
1.0	1.0
1.1	1.1
1.2	1.2
1.3	1.3

PrincipalType

Enumeração

Tipo principal do administrador de corte.

Valor	Description
User	User
Group	Grupo
Application	Application

PrivateEndpointConnectionProperties

Object

Propriedades de uma conexão de ponto de extremidade privada.

Name	Tipo	Description
groupIds	string[]	IDs de grupo.
privateEndpoint	PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado da conexão da conexão de ponto de extremidade privado.
provisioningState	PrivateEndpointProvisioningState	Estado da conexão de ponto de extremidade privado.

PrivateEndpointProperty

Object

Name	Tipo	Description
id	string	ID do recurso do ponto de extremidade privado.

PrivateEndpointProvisioningState

Enumeração

Estado da conexão de ponto de extremidade privado.

Valor	Description
Approving	Aprovação
Ready	Pronto/a
Dropping	Queda
Failed	Falha
Rejecting	Rejeitando

PrivateLinkServiceConnectionStateActionsRequire

Enumeração

As ações necessárias para conexão de serviço de link privado.

Valor	Description
None	Nenhum

PrivateLinkServiceConnectionStateProperty

Object

Name	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para conexão de serviço de link privado.
description	string	A descrição da conexão do serviço de link privado.
status	PrivateLinkServiceConnectionStateStatus	O status da conexão do serviço de link privado.

PrivateLinkServiceConnectionStateStatus

Enumeração

O status da conexão do serviço de link privado.

Valor	Description
Approved	Aprovada
Pending	Pendente
Rejected	Rejeitado
Disconnected	Desconectado

ResourceIdentity

Object

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
principalId	string (uuid)	O principal id do Azure Active Directory.
tenantId	string (uuid)	O id do tenant do Azure Active Directory.
type	IdentityType	O tipo de identidade. Defina isto como 'SystemAssigned' para criar e atribuir automaticamente um principal do Azure Active Directory ao recurso.
userAssignedIdentities	<string, UserIdentity>	As ids de recurso das identidades atribuídas ao usuário a serem usadas

Server

Object

Um servidor Base de Dados SQL do Azure.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ResourceIdentity	A identidade do Azure Active Directory do servidor.
kind	string	Tipo de servidor sql. Estes são metadados usados para a experiência do portal Azure.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.administratorLogin	string	Nome de usuário do administrador para o servidor. Uma vez criado, não pode ser alterado.
properties.administratorLoginPassword	string (password)	A senha de login do administrador (necessária para a criação do servidor).
properties.administrators	ServerExternalAdministrator	O administrador do Azure Active Directory pode ser utilizado durante a criação de servidores e para atualizações de servidor, exceto pela propriedade azureADOnlyAuthentication. Para atualizar a propriedade azureADOnlyAuthentication, a API individual deve ser usada.
properties.createMode	ServerCreateMode	Modo de criação para o servidor, apenas os valores válidos para isso são Normal e Restauração.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Estatuto da governação externa.
properties.federatedClientId	string (uuid)	A ID do cliente usada para o cenário CMK entre locatários
properties.fullyQualifiedDomainName	string	O nome de domínio totalmente qualificado do servidor.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Ativar ou não o suporte IPv6 para este servidor. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'
properties.keyId	string	Um URI CMK da chave a ser usada para criptografia.
properties.minimalTlsVersion	MinimalTlsVersion	Versão TLS mínima. Valores permitidos: 'Nenhum', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId	string	A id de recurso de uma identidade atribuída ao usuário a ser usada por padrão.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privado em um servidor
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. O valor é opcional, mas se passado, deve ser 'Enabled' ou 'Disabled' ou 'SecuredByPerimeter'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Restringir ou não o acesso à rede de saída para este servidor. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'
properties.retentionDays	integer (int32)	Número de dias que este servidor permanecerá soft-delete.
properties.state	string	O estado do servidor.
properties.version	string	A versão do servidor.
properties.workspaceFeature	ServerWorkspaceFeature	Se o servidor existente tem ou não um espaço de trabalho criado e se ele permite a conexão do espaço de trabalho
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

ServerCreateMode

Enumeração

Modo de criação para o servidor, apenas os valores válidos para isso são Normal e Restauração.

Valor	Description
Normal	Normal
Restore	Restore

ServerExternalAdministrator

Object

Propriedades de um administrador do Ative Directory.

Name	Tipo	Description
administratorType	AdministratorType	Tipo de administrador de corte.
azureADOnlyAuthentication	boolean	Apenas Azure Active Directory Autenticação ativada.
login	string	Nome de login do administrador do servidor.
principalType	PrincipalType	Tipo principal do administrador de corte.
sid	string (uuid)	SID (ID do objeto) do administrador do servidor.
tenantId	string (uuid)	ID do locatário do administrador.

ServerNetworkAccessFlag

Enumeração

Restringir ou não o acesso à rede de saída para este servidor. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'

Valor	Description
Enabled	Ativado
Disabled	Disabled

ServerPrivateEndpointConnection

Object

Uma conexão de ponto de extremidade privada em um servidor

Name	Tipo	Description
id	string	ID do recurso.
properties	PrivateEndpointConnectionProperties	Propriedades de conexão de ponto de extremidade privado

ServerPublicNetworkAccessFlag

Enumeração

Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. O valor é opcional, mas se passado, deve ser 'Enabled' ou 'Disabled' ou 'SecuredByPerimeter'

Valor	Description
Enabled	Ativado
Disabled	Disabled
SecuredByPerimeter	AsseguradoPorPerimeter

ServerWorkspaceFeature

Enumeração

Se o servidor existente tem ou não um espaço de trabalho criado e se ele permite a conexão do espaço de trabalho

Valor	Description
Connected	Connected
Disconnected	Desconectado

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserIdentity

Object

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
clientId	string (uuid)	O ID do cliente do Azure Active Directory.
principalId	string (uuid)	O principal id do Azure Active Directory.

Partilhar via

Servers - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get server

Pedido de amostra

Resposta da amostra

Get server with $expand=administrators/activedirectory

Pedido de amostra

Resposta da amostra

Definições

AdministratorType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerCreateMode

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

systemData

UserIdentity