Servers - Get

Referência

Serviço:: SQL Database

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

Obtém um servidor.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$expand={$expand}&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.
$expand	query		string	Os recursos da criança para incluir na resposta.

Respostas

Name	Tipo	Description
200 OK	Server	Recuperado com êxito o servidor especificado.
Other Status Codes	ErrorResponse	Respostas de erro: *** 404 SubscriptionNotFound - A assinatura solicitada não foi encontrada. 404 ResourceNotFound - O recurso solicitado não foi encontrado. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

Name

Tipo

Description

200 OK

Server

Recuperado com êxito o servidor especificado.

Other Status Codes

ErrorResponse

Respostas de erro: ***

404 SubscriptionNotFound - A assinatura solicitada não foi encontrada.
404 ResourceNotFound - O recurso solicitado não foi encontrado.
429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.
503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

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=2023-08-01

Resposta da amostra

Código de estado:: 200

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

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=2023-08-01

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
AdministratorType	Tipo de administrador de corte.
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 isso como 'SystemAssigned' para criar e atribuir automaticamente uma entidade do Azure Ative Directory para o 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 Ative Directory para um recurso.
Server	Um servidor do Banco de Dados SQL do Azure.
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
UserIdentity	Configuração de identidade do Azure Ative Directory para um recurso.

AdministratorType

Enumeração

Tipo de administrador de corte.

Valor	Description
ActiveDirectory

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.

ExternalGovernanceStatus

Enumeração

Estatuto da governação externa.

Valor	Description
Disabled
Enabled

IdentityType

Enumeração

O tipo de identidade. Defina isso como 'SystemAssigned' para criar e atribuir automaticamente uma entidade do Azure Ative Directory para o recurso.

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Enumeração

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

Valor	Description
1.0
1.1
1.2
1.3
None

PrincipalType

Enumeração

Tipo principal do administrador de corte.

Valor	Description
Application
Group
User

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
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeração

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

Valor	Description
None

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
Disconnected
Pending
Rejected

ResourceIdentity

Object

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

Name	Tipo	Description
principalId	string (uuid)	A ID principal do Azure Ative Directory.
tenantId	string (uuid)	A ID de locatário do Azure Ative Directory.
type	IdentityType	O tipo de identidade. Defina isso como 'SystemAssigned' para criar e atribuir automaticamente uma entidade do Azure Ative Directory para o recurso.
userAssignedIdentities	<string, UserIdentity>	As ids de recurso das identidades atribuídas ao usuário a serem usadas

Server

Object

Um servidor do Banco de Dados SQL do Azure.

Name	Tipo	Description
id	string	ID do recurso.
identity	ResourceIdentity	A identidade do Azure Ative Directory do servidor.
kind	string	Tipo de servidor sql. 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.administratorLogin	string	Nome de usuário do administrador para o servidor. Uma vez criado, não pode ser alterado.
properties.administratorLoginPassword	string	A senha de login do administrador (necessária para a criação do servidor).
properties.administrators	ServerExternalAdministrator	O administrador do Azure Ative Directory do servidor. Isso só pode ser usado no momento da criação do servidor. Se usado para atualização do servidor, ele será ignorado ou resultará em um erro. Para atualizações, APIs individuais precisarão ser usadas.
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.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
tags	object	Tags de recursos.
type	string	Tipo de recurso.

ServerExternalAdministrator

Object

Propriedades de um administrador do Ative Directory.

Name	Tipo	Description
administratorType	AdministratorType	Tipo de administrador de corte.
azureADOnlyAuthentication	boolean	Somente Autenticação do Ative Directory do Azure habilitada.
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
Disabled
Enabled

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
Disabled
Enabled
SecuredByPerimeter

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
Disconnected

UserIdentity

Object

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

Name	Tipo	Description
clientId	string (uuid)	A ID do cliente do Azure Ative Directory.
principalId	string (uuid)	A ID principal do Azure Ative Directory.

Partilhar via

Servers - Get

Parâmetros do URI

Respostas

Exemplos

Get server

Pedido de amostra

Resposta da amostra

Get server with $expand=administrators/activedirectory

Pedido de amostra

Resposta da amostra

Definições

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity

Recursos adicionais