Servers - List By Resource Group

Référence

Service:: SQL Database

API Version:: 2021-11-01

Obtient une liste de serveurs dans un groupe de ressources.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$expand	query		string	Ressources enfants à inclure dans la réponse.

Réponses

Nom	Type	Description
200 OK	ServerListResult	La liste des serveurs a été récupérée.
Other Status Codes		Réponses d’erreur : *** 404 SubscriptionNotFound : l’abonnement demandé est introuvable.

Nom

Type

Description

200 OK

ServerListResult

La liste des serveurs a été récupérée.

Other Status Codes

Réponses d’erreur : ***

404 SubscriptionNotFound : l’abonnement demandé est introuvable.

Exemples

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

Définitions

Nom	Description
AdministratorType	Type de l’administrateur de serveur.
IdentityType	Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.
PrincipalType	Type de principal de l’administrateur de serveur.
PrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé.
PrivateEndpointProperty
PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service private link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.
ResourceIdentity	Configuration d’identité Azure Active Directory pour une ressource.
Server	Serveur de base de données Azure SQL.
ServerExternalAdministrator	Propriétés d’un administrateur Active Directory.
ServerListResult	Liste des serveurs.
ServerNetworkAccessFlag	Indique si l’accès au point de terminaison public est autorisé pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
ServerPrivateEndpointConnection	Connexion de point de terminaison privé sous un serveur
ServerWorkspaceFeature	Indique si un serveur existant a un espace de travail créé et s’il autorise la connexion à partir de l’espace de travail
UserIdentity	Configuration d’identité Azure Active Directory pour une ressource.

AdministratorType

Type de l’administrateur de serveur.

Nom	Type	Description
ActiveDirectory	string

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Type de principal de l’administrateur de serveur.

Nom	Type	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé.

Nom	Type	Description
groupIds	string[]	ID de groupe.
privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel appartient la connexion.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de la connexion de la connexion de point de terminaison privé.
provisioningState	PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.

PrivateEndpointProperty

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateEndpointProvisioningState

État de la connexion de point de terminaison privé.

Nom	Type	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Actions requises pour la connexion au service private link.

Nom	Type	Description
None	string

PrivateLinkServiceConnectionStateProperty

Nom	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service private link.
description	string	Description de la connexion au service private link.
status	PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.

PrivateLinkServiceConnectionStateStatus

La connexion au service de liaison privée status.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Nom	Type	Description
principalId	string	ID du principal Azure Active Directory.
tenantId	string	ID de locataire Azure Active Directory.
type	IdentityType	Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.
userAssignedIdentities	<string, UserIdentity>	ID de ressource des identités affectées par l’utilisateur à utiliser

Server

Serveur de base de données Azure SQL.

Nom	Type	Description
id	string	ID de la ressource
identity	ResourceIdentity	Identité Azure Active Directory du serveur.
kind	string	Type de sql server. Il s’agit des métadonnées utilisées pour l’expérience Portail Azure.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.administratorLogin	string	Nom d’utilisateur administrateur du serveur. Une fois créé, il ne peut pas être modifié.
properties.administratorLoginPassword	string	Mot de passe de connexion administrateur (requis pour la création du serveur).
properties.administrators	ServerExternalAdministrator	Administrateur Azure Active Directory du serveur.
properties.federatedClientId	string	ID client utilisé pour le scénario de clé CMK interlocataire
properties.fullyQualifiedDomainName	string	Nom de domaine complet du serveur.
properties.keyId	string	URI CMK de la clé à utiliser pour le chiffrement.
properties.minimalTlsVersion	string	Version TLS minimale. Valeurs autorisées : « 1.0 », « 1.1 », « 1.2 »
properties.primaryUserAssignedIdentityId	string	ID de ressource d’une identité affectée par l’utilisateur à utiliser par défaut.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Liste des connexions de point de terminaison privé sur un serveur
properties.publicNetworkAccess	ServerNetworkAccessFlag	Indique si l’accès au point de terminaison public est autorisé pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Indique s’il faut ou non restreindre l’accès réseau sortant pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
properties.state	string	État du serveur.
properties.version	string	Version du serveur.
properties.workspaceFeature	ServerWorkspaceFeature	Indique si un serveur existant a un espace de travail créé et s’il autorise la connexion à partir de l’espace de travail
tags	object	Balises de ressource.
type	string	Type de ressource.

ServerExternalAdministrator

Propriétés d’un administrateur Active Directory.

Nom	Type	Description
administratorType	AdministratorType	Type de l’administrateur de serveur.
azureADOnlyAuthentication	boolean	Authentification Azure Active Directory uniquement activée.
login	string	Nom de connexion de l’administrateur du serveur.
principalType	PrincipalType	Type de principal de l’administrateur de serveur.
sid	string	SID (ID d’objet) de l’administrateur du serveur.
tenantId	string	ID de locataire de l’administrateur.

ServerListResult

Liste des serveurs.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	Server[]	Tableau de résultats.

ServerNetworkAccessFlag

Indique si l’accès au point de terminaison public est autorisé pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »

Nom	Type	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Connexion de point de terminaison privé sous un serveur

Nom	Type	Description
id	string	ID de la ressource
properties	PrivateEndpointConnectionProperties	Propriétés de connexion de point de terminaison privé

ServerWorkspaceFeature

Indique si un serveur existant a un espace de travail créé et s’il autorise la connexion à partir de l’espace de travail

Nom	Type	Description
Connected	string
Disconnected	string

UserIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Nom	Type	Description
clientId	string	ID client Azure Active Directory.
principalId	string	ID du principal Azure Active Directory.

Servers - List By Resource Group

Paramètres URI

Réponses

Exemples

List servers by resource group

Sample Request

Sample Response

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

Sample Request

Sample Response

Définitions

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Ressources supplémentaires