Servers - List By Resource Group

Riferimento

Service:: SQL Database

API Version:: 2021-11-01

Ottiene un elenco di server in gruppi di risorse.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.
$expand	query		string	Le risorse figlio da includere nella risposta.

Risposte

Nome	Tipo	Descrizione
200 OK	ServerListResult	Recuperato correttamente l'elenco dei server.
Other Status Codes		Risposte agli errori: ** 404 SubscriptionNotFound : la sottoscrizione richiesta non è stata trovata.

Nome

Tipo

Descrizione

200 OK

ServerListResult

Recuperato correttamente l'elenco dei server.

Other Status Codes

Risposte agli errori: **

404 SubscriptionNotFound : la sottoscrizione richiesta non è stata trovata.

Esempio

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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
AdministratorType	Tipo dell'amministratore di sever.
IdentityType	Tipo di identità. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di Azure Active Directory per la risorsa.
PrincipalType	Tipo di entità dell'amministratore di sever.
PrivateEndpointConnectionProperties	Proprietà di una connessione endpoint privato.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionStateActionsRequire	Azioni necessarie per la connessione al servizio di collegamento privato.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Stato di connessione del servizio di collegamento privato.
ResourceIdentity	Configurazione delle identità di Azure Active Directory per una risorsa.
Server	Server di database Azure SQL.
ServerExternalAdministrator	Proprietà di un amministratore di Active Directory.
ServerListResult	Elenco dei server.
ServerNetworkAccessFlag	Se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato"
ServerPrivateEndpointConnection	Connessione endpoint privato in un server
ServerWorkspaceFeature	Se il server esistente ha un'area di lavoro creata e se consente la connessione dall'area di lavoro
UserIdentity	Configurazione delle identità di Azure Active Directory per una risorsa.

AdministratorType

Tipo dell'amministratore di sever.

Nome	Tipo	Descrizione
ActiveDirectory	string

IdentityType

Tipo di identità. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di Azure Active Directory per la risorsa.

Nome	Tipo	Descrizione
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Tipo di entità dell'amministratore di sever.

Nome	Tipo	Descrizione
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Proprietà di una connessione endpoint privato.

Nome	Tipo	Descrizione
groupIds	string[]	ID gruppo.
privateEndpoint	PrivateEndpointProperty	Endpoint privato a cui appartiene la connessione.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stato della connessione dell'endpoint privato.
provisioningState	PrivateEndpointProvisioningState	Stato della connessione dell'endpoint privato.

PrivateEndpointProperty

Nome	Tipo	Descrizione
id	string	ID risorsa dell'endpoint privato.

PrivateEndpointProvisioningState

Stato della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Azioni necessarie per la connessione al servizio di collegamento privato.

Nome	Tipo	Descrizione
None	string

PrivateLinkServiceConnectionStateProperty

Nome	Tipo	Descrizione
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Azioni necessarie per la connessione al servizio di collegamento privato.
description	string	Descrizione della connessione al servizio collegamento privato.
status	PrivateLinkServiceConnectionStateStatus	Stato di connessione del servizio di collegamento privato.

PrivateLinkServiceConnectionStateStatus

Stato di connessione del servizio di collegamento privato.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Configurazione delle identità di Azure Active Directory per una risorsa.

Nome	Tipo	Descrizione
principalId	string	ID entità di Azure Active Directory.
tenantId	string	ID tenant di Azure Active Directory.
type	IdentityType	Tipo di identità. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di Azure Active Directory per la risorsa.
userAssignedIdentities	<string, UserIdentity>	ID risorsa delle identità assegnate dall'utente da usare

Server

Server di database Azure SQL.

Nome	Tipo	Descrizione
id	string	ID risorsa.
identity	ResourceIdentity	Identità di Azure Active Directory del server.
kind	string	Tipo di sql server. Si tratta di metadati usati per l'esperienza di portale di Azure.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.administratorLogin	string	Nome utente amministratore per il server. Dopo aver creato non è possibile modificarlo.
properties.administratorLoginPassword	string	Password di accesso amministratore (richiesta per la creazione del server).
properties.administrators	ServerExternalAdministrator	Amministratore di Azure Active Directory del server.
properties.federatedClientId	string	ID client usato per lo scenario CMK multi-tenant
properties.fullyQualifiedDomainName	string	Nome di dominio completo del server.
properties.keyId	string	URI CMK della chiave da usare per la crittografia.
properties.minimalTlsVersion	string	Versione TLS minima. Valori consentiti: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	ID risorsa di un'identità assegnata dall'utente da usare per impostazione predefinita.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Elenco delle connessioni endpoint private in un server
properties.publicNetworkAccess	ServerNetworkAccessFlag	Se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Indica se limitare o meno l'accesso alla rete in uscita per questo server. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato"
properties.state	string	Stato del server.
properties.version	string	Versione del server.
properties.workspaceFeature	ServerWorkspaceFeature	Se il server esistente ha un'area di lavoro creata e se consente la connessione dall'area di lavoro
tags	object	Tag di risorse.
type	string	Tipo di risorsa.

ServerExternalAdministrator

Proprietà di un amministratore di Active Directory.

Nome	Tipo	Descrizione
administratorType	AdministratorType	Tipo dell'amministratore di sever.
azureADOnlyAuthentication	boolean	Solo autenticazione di Azure Active Directory abilitata.
login	string	Nome di accesso dell'amministratore del server.
principalType	PrincipalType	Tipo di entità dell'amministratore di sever.
sid	string	SID (ID oggetto) dell'amministratore del server.
tenantId	string	ID tenant dell'amministratore.

ServerListResult

Elenco dei server.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per recuperare la pagina successiva dei risultati.
value	Server[]	Matrice di risultati.

ServerNetworkAccessFlag

Se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato"

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Connessione endpoint privato in un server

Nome	Tipo	Descrizione
id	string	ID risorsa.
properties	PrivateEndpointConnectionProperties	Proprietà di connessione dell'endpoint privato

ServerWorkspaceFeature

Se il server esistente ha un'area di lavoro creata e se consente la connessione dall'area di lavoro

Nome	Tipo	Descrizione
Connected	string
Disconnected	string

UserIdentity

Configurazione delle identità di Azure Active Directory per una risorsa.

Nome	Tipo	Descrizione
clientId	string	ID client di Azure Active Directory.
principalId	string	ID entità di Azure Active Directory.

Servers - List By Resource Group

Parametri dell'URI

Risposte

Esempio

List servers by resource group

Sample Request

Sample Response

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

Sample Request

Sample Response

Definizioni

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Risorse aggiuntive