Servers - List

Serviço:: SQL Database

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

Obtém uma lista de todos os servidores na assinatura.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		string	Os recursos filho a serem incluídos na resposta.

Respostas

Nome	Tipo	Description
200 OK	ServerListResult	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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List servers

List servers with $expand=administrators/activedirectory

List servers

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "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",
        "state": "Ready",
        "version": "12.0",
        "workspaceFeature": "Connected"
      }
    },
    {
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "kind": "v12.0",
      "location": "japaneast",
      "properties": {
        "administratorLogin": "dummylogin",
        "externalGovernanceStatus": "Enabled",
        "fullyQualifiedDomainName": "sqlcrudtest-6661.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",
        "state": "Ready",
        "version": "12.0",
        "workspaceFeature": "Connected"
      }
    }
  ]
}

List servers with $expand=administrators/activedirectory

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "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"
      }
    },
    {
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "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-6661.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"
      }
    }
  ]
}

Definições

Nome	Description
AdministratorType	Tipo do administrador de sever.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExternalGovernanceStatus	Status da governança externa.
IdentityType	O tipo de identidade. Defina isso como 'SystemAssigned' para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
MinimalTlsVersion	Versão mínima do TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType	Tipo de entidade de segurança do administrador de sever.
PrivateEndpointConnectionProperties	Propriedades de uma conexão de ponto de extremidade privado.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a conexão do 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 Banco de Dados SQL do Azure.
ServerCreateMode	Modo de criação para o servidor, apenas os valores válidos para isso são Normal e Restaurar.
ServerExternalAdministrator	Propriedades de um administrador do active directory.
ServerListResult	A resposta de uma operação de lista de servidores.
ServerNetworkAccessFlag	Se deseja ou não restringir o acesso à rede de saída para este servidor. O valor é opcional, mas se passado, deve ser 'Habilitado' ou 'Desabilitado'
ServerPrivateEndpointConnection	Uma conexão de ponto de extremidade privado 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 "Habilitado" ou "Desabilitado" ou "SecuredByPerimeter"
ServerWorkspaceFeature	Se o servidor existente tem ou não um workspace criado e se ele permite a conexão do workspace
systemData	Metadados relativos à criação e última modificação do recurso.
UserIdentity	Configuração de identidade do Azure Active Directory para um recurso.

AdministratorType

Enumeração

Tipo do administrador de sever.

Valor	Description
ActiveDirectory	Active Directory

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

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.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExternalGovernanceStatus

Enumeração

Status da governança externa.

Valor	Description
Enabled	Habilitado
Disabled	Desactivado

IdentityType

Enumeração

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

Valor	Description
None	Nenhum
SystemAssigned	AtribuídoPeloSistema
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemAssignado, UsuárioAtribuído

MinimalTlsVersion

Enumeração

Versão mínima do TLS. Valores permitidos: 'None', 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 de entidade de segurança do administrador de sever.

Valor	Description
User	Usuário
Group	Grupo
Application	Aplicativo

PrivateEndpointConnectionProperties

Objeto

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

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

PrivateEndpointProperty

Objeto

Nome	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	Aprovando
Ready	Pronto
Dropping	Deixar cair
Failed	Falha
Rejecting	Rejeitando

PrivateLinkServiceConnectionStateActionsRequire

Enumeração

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

Valor	Description
None	Nenhum

PrivateLinkServiceConnectionStateProperty

Objeto

Nome	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a conexão do 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

Objeto

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

Nome	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 isso como 'SystemAssigned' para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
userAssignedIdentities	<string, UserIdentity>	As IDs de recurso das identidades atribuídas pelo usuário a serem usadas

Server

Objeto

Um servidor Banco de Dados SQL do Azure.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada 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 sql server. Esses são metadados usados para a experiência do portal Azure.
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.administratorLogin	string	Nome de usuário do administrador para o servidor. Uma vez criado, ele não pode ser alterado.
properties.administratorLoginPassword	string (password)	A senha de logon 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 servidores, 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 Restaurar.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status da governança externa.
properties.federatedClientId	string (uuid)	A ID do cliente usada para o cenário de CMK entre locatários
properties.fullyQualifiedDomainName	string	O nome de domínio totalmente qualificado do servidor.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Se deseja ou não habilitar o suporte IPv6 para este servidor. O valor é opcional, mas se passado, deve ser 'Habilitado' ou 'Desabilitado'
properties.keyId	string	Um URI do CMK da chave a ser usada para criptografia.
properties.minimalTlsVersion	MinimalTlsVersion	Versão mínima do TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId	string	A ID de recurso de uma identidade atribuída pelo 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 "Habilitado" ou "Desabilitado" ou "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Se deseja ou não restringir o acesso à rede de saída para este servidor. O valor é opcional, mas se passado, deve ser 'Habilitado' ou 'Desabilitado'
properties.retentionDays	integer (int32)	Número de dias em que este servidor permanecerá excluído de forma reversível.
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 workspace criado e se ele permite a conexão do workspace
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. Compute/virtualMachines" 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 Restaurar.

Valor	Description
Normal	Normal
Restore	Restaurar

ServerExternalAdministrator

Objeto

Propriedades de um administrador do active directory.

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

ServerListResult

Objeto

A resposta de uma operação de lista de servidores.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Server[]	Os itens do servidor nesta página

ServerNetworkAccessFlag

Enumeração

Se deseja ou não restringir o acesso à rede de saída para este servidor. O valor é opcional, mas se passado, deve ser 'Habilitado' ou 'Desabilitado'

Valor	Description
Enabled	Habilitado
Disabled	Desactivado

ServerPrivateEndpointConnection

Objeto

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

Nome	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 "Habilitado" ou "Desabilitado" ou "SecuredByPerimeter"

Valor	Description
Enabled	Habilitado
Disabled	Desactivado
SecuredByPerimeter	SecuredByPerimeter

ServerWorkspaceFeature

Enumeração

Se o servidor existente tem ou não um workspace criado e se ele permite a conexão do workspace

Valor	Description
Connected	Conectado
Disconnected	Desconectado

systemData

Objeto

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

Nome	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

Objeto

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

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

Compartilhar via

Servers - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

List servers

Solicitação de exemplo

Resposta de exemplo

List servers with $expand=administrators/activedirectory

Solicitação de exemplo

Resposta de exemplo

Definições

AdministratorType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerCreateMode

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

systemData

UserIdentity