Servers - List By Resource Group

Referência

Service:: SQL Database

API Version:: 2021-11-01

Obtém uma lista de servidores num grupo de recursos.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?$expand={$expand}&api-version=2021-11-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. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.
$expand	query		string	Os recursos subordinados a incluir na resposta.

Respostas

Name	Tipo	Description
200 OK	ServerListResult	A lista de servidores foi obtida com êxito.
Other Status Codes		Respostas de Erro: *** 404 SubscriptionNotFound – a subscrição pedida não foi encontrada.

Name

Tipo

Description

200 OK

ServerListResult

A lista de servidores foi obtida com êxito.

Other Status Codes

Respostas de Erro: ***

404 SubscriptionNotFound – a subscrição pedida não foi encontrada.

Exemplos

List servers by resource group

List servers by resource group with $expand=administrators/activedirectory

List servers by resource group

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


import com.azure.core.util.Context;

/** Samples for Servers ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerListByResourceGroup.json
     */
    /**
     * Sample code: List servers by resource group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServersByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().listByResourceGroup("sqlcrudtest-7398", null,
            Context.NONE);
    }
}

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

Sample Response

Status code:: 200

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

List servers by resource group with $expand=administrators/activedirectory

Sample Request

HTTP
Java

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


import com.azure.core.util.Context;

/** Samples for Servers ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerListByResourceGroupWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List servers by resource group with $expand=administrators/activedirectory.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServersByResourceGroupWithExpandAdministratorsActivedirectory(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().listByResourceGroup("sqlcrudtest-7398", null,
            Context.NONE);
    }
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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",
        "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"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "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 gravidade.
IdentityType	O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
PrincipalType	Tipo de Principal do administrador de gravidade.
PrivateEndpointConnectionProperties	Propriedades de uma ligação de ponto final privado.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado da ligação de ponto final privado.
PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a ligação do serviço de ligação privada.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	O estado da ligação do serviço de ligação privada.
ResourceIdentity	Configuração de identidade do Azure Active Directory para um recurso.
Server	Um servidor de Base de Dados SQL do Azure.
ServerExternalAdministrator	Propriedades de um administrador do Active Directory.
ServerListResult	Uma lista de servidores.
ServerNetworkAccessFlag	Se o acesso ao ponto final público é ou não permitido para este servidor. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado"
ServerPrivateEndpointConnection	Uma ligação de ponto final privado num servidor
ServerWorkspaceFeature	Se o servidor existente tem ou não uma área de trabalho criada e se permite a ligação a partir da área de trabalho
UserIdentity	Configuração de identidade do Azure Active Directory para um recurso.

AdministratorType

Tipo de administrador de gravidade.

Name	Tipo	Description
ActiveDirectory	string

IdentityType

O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Tipo de Principal do administrador de gravidade.

Name	Tipo	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Propriedades de uma ligação de ponto final privado.

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

PrivateEndpointProperty

Name	Tipo	Description
id	string	ID do recurso do ponto final privado.

PrivateEndpointProvisioningState

Estado da ligação de ponto final privado.

Name	Tipo	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

As ações necessárias para a ligação do serviço de ligação privada.

Name	Tipo	Description
None	string

PrivateLinkServiceConnectionStateProperty

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

PrivateLinkServiceConnectionStateStatus

O estado da ligação do serviço de ligação privada.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

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

Name	Tipo	Description
principalId	string	O ID principal do Azure Active Directory.
tenantId	string	O ID de inquilino do Azure Active Directory.
type	IdentityType	O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
userAssignedIdentities	<string, UserIdentity>	Os IDs de recursos das identidades atribuídas pelo utilizador a utilizar

Server

Um servidor de Base de Dados SQL do Azure.

Name	Tipo	Description
id	string	ID do Recurso.
identity	ResourceIdentity	A identidade do Azure Active Directory do servidor.
kind	string	Tipo de servidor sql. Estes são os metadados utilizados para a experiência de portal do Azure.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.administratorLogin	string	Nome de utilizador do administrador do servidor. Uma vez criada, não pode ser alterada.
properties.administratorLoginPassword	string	A palavra-passe de início de sessão do administrador (necessária para a criação do servidor).
properties.administrators	ServerExternalAdministrator	O administrador do Azure Active Directory do servidor.
properties.federatedClientId	string	O ID de Cliente utilizado para o cenário de CMK entre inquilinos
properties.fullyQualifiedDomainName	string	O nome de domínio completamente qualificado do servidor.
properties.keyId	string	Um URI CMK da chave a utilizar para encriptação.
properties.minimalTlsVersion	string	Versão mínima do TLS. Valores permitidos: "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	O ID de recurso de uma identidade atribuída pelo utilizador a utilizar por predefinição.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de ligações de ponto final privado num servidor
properties.publicNetworkAccess	ServerNetworkAccessFlag	Se o acesso ao ponto final público é ou não permitido para este servidor. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Se pretende ou não restringir o acesso de rede de saída para este servidor. O valor é opcional, mas, se for transmitido, tem de 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 uma área de trabalho criada e se permite a ligação a partir da área de trabalho
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ServerExternalAdministrator

Propriedades de um administrador do Active Directory.

Name	Tipo	Description
administratorType	AdministratorType	Tipo de administrador de gravidade.
azureADOnlyAuthentication	boolean	Apenas a Autenticação do Azure Active Directory está ativada.
login	string	Nome de início de sessão do administrador do servidor.
principalType	PrincipalType	Tipo de Principal do administrador de gravidade.
sid	string	SID (ID de objeto) do administrador do servidor.
tenantId	string	ID do inquilino do administrador.

ServerListResult

Uma lista de servidores.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	Server[]	Matriz de resultados.

ServerNetworkAccessFlag

Se o acesso ao ponto final público é ou não permitido para este servidor. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado"

Name	Tipo	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Uma ligação de ponto final privado num servidor

Name	Tipo	Description
id	string	ID do Recurso.
properties	PrivateEndpointConnectionProperties	Propriedades de ligação de ponto final privado

ServerWorkspaceFeature

Se o servidor existente tem ou não uma área de trabalho criada e se permite a ligação a partir da área de trabalho

Name	Tipo	Description
Connected	string
Disconnected	string

UserIdentity

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

Name	Tipo	Description
clientId	string	O ID de cliente do Azure Active Directory.
principalId	string	O ID principal do Azure Active Directory.

Servers - List By Resource Group

Parâmetros do URI

Respostas

Exemplos

List servers by resource group

Sample Request

Sample Response

List servers by resource group with $expand=administrators/activedirectory

Sample Request

Sample Response

Definições

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Recursos adicionais