Partager via

Servers - List By Resource Group

  • Référence
Service:
SQL Database
Version d'API:
2023-08-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=2023-08-01
Avec des paramètres facultatifs: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?$expand={$expand}&api-version=2023-08-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

ID d’abonnement qui identifie 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

Récupération réussie de la liste des serveurs.
Other Status Codes

ErrorResponse

Réponses d’erreur : ***

  • 404 SubscriptionNotFound : l’abonnement demandé est introuvable.

  • 429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

  • 503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

Exemples

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

List servers by resource group

Exemple de requête

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

Exemple de réponse

Code d’état:
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",
        "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"
              }
            }
          }
        ]
      }
    },
    {
      "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",
        "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"
              }
            }
          }
        ]
      }
    }
  ]
}

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

Exemple de requête

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

Exemple de réponse

Code d’état:
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",
        "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"
              }
            }
          }
        ]
      }
    },
    {
      "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",
        "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"
              }
            }
          }
        ]
      }
    }
  ]
}

Définitions

Nom Description
AdministratorType

Type de l’administrateur de serveur.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
ExternalGovernanceStatus

État de la gouvernance externe.
IdentityType

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

Version TLS minimale. Valeurs autorisées : « None », 1.0 », « 1.1 », « 1.2 », « 1.3 »
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 de service de liaison privée.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

État de connexion du service de liaison privée.
ResourceIdentity

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

Un serveur Azure SQL Database.
ServerExternalAdministrator

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

Liste des serveurs.
ServerNetworkAccessFlag

Indique s’il faut restreindre ou non l’accès réseau sortant pour ce serveur. La valeur est facultative, mais si elle est passée, doit être « Activé » ou « Désactivé »
ServerPrivateEndpointConnection

Connexion de point de terminaison privé sous un serveur
ServerPublicNetworkAccessFlag

Indique si l’accès au point de terminaison public est autorisé pour ce serveur. La valeur est facultative, mais si elle est passée, doit être « Enabled » ou « Disabled » ou « SecuredByPerimeter »
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

Énumération

Type de l’administrateur de serveur.

Valeur Description
ActiveDirectory

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

ExternalGovernanceStatus

Énumération

État de la gouvernance externe.

Valeur Description
Disabled
Enabled

IdentityType

Énumération

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

Valeur Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Énumération

Version TLS minimale. Valeurs autorisées : « None », 1.0 », « 1.1 », « 1.2 », « 1.3 »

Valeur Description
1.0
1.1
1.2
1.3
None

PrincipalType

Énumération

Type de principal de l’administrateur de serveur.

Valeur Description
Application
Group
User

PrivateEndpointConnectionProperties

Object

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 la connexion appartient.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

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

PrivateEndpointProvisioningState

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

PrivateEndpointProperty

Object
Nom Type Description
id

string

ID de ressource du point de terminaison privé.

PrivateEndpointProvisioningState

Énumération

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

Valeur Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Énumération

Actions requises pour la connexion de service de liaison privée.

Valeur Description
None

PrivateLinkServiceConnectionStateProperty

Object
Nom Type Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

Actions requises pour la connexion de service de liaison privée.
description

string

Description de la connexion du service private link.
status

PrivateLinkServiceConnectionStateStatus

État de connexion du service de liaison privée.

PrivateLinkServiceConnectionStateStatus

Énumération

État de connexion du service de liaison privée.

Valeur Description
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

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

Nom Type Description
principalId

string (uuid)

ID du principal Azure Active Directory.
tenantId

string (uuid)

ID de locataire Azure Active Directory.
type

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » pour créer et 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

Object

Un serveur Azure SQL Database.

Nom Type Description
id

string

ID de ressource.
identity

ResourceIdentity

Identité Azure Active Directory du serveur.
kind

string

Type de serveur sql. Il s’agit des métadonnées utilisées pour l’expérience du portail Azure.
location

string

Emplacement des ressources.
name

string

Nom de la ressource.
properties.administratorLogin

string

Nom d’utilisateur administrateur du serveur. Une fois créée, elle ne peut pas être modifiée.
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. Cela ne peut être utilisé qu’au moment de la création du serveur. Si elle est utilisée pour la mise à jour du serveur, elle est ignorée ou entraîne une erreur. Pour les mises à jour, les API individuelles doivent être utilisées.
properties.externalGovernanceStatus

ExternalGovernanceStatus

État de la gouvernance externe.
properties.federatedClientId

string (uuid)

ID client utilisé pour le scénario CMK interlocataire
properties.fullyQualifiedDomainName

string

Nom de domaine complet du serveur.
properties.isIPv6Enabled

ServerNetworkAccessFlag

Indique si la prise en charge IPv6 de ce serveur doit être activé ou non. La valeur est facultative, mais si elle est passée, doit être « Activé » ou « Désactivé »
properties.keyId

string

URI CMK de la clé à utiliser pour le chiffrement.
properties.minimalTlsVersion

MinimalTlsVersion

Version TLS minimale. Valeurs autorisées : « None », 1.0 », « 1.1 », « 1.2 », « 1.3 »
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

ServerPublicNetworkAccessFlag

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

ServerNetworkAccessFlag

Indique s’il faut restreindre ou non l’accès réseau sortant pour ce serveur. La valeur est facultative, mais si elle est passée, doit être « Activé » ou « Désactivé »
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

Object

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 (uuid)

SID (ID d’objet) de l’administrateur du serveur.
tenantId

string (uuid)

ID de locataire de l’administrateur.

ServerListResult

Object

Liste des serveurs.

Nom Type Description
nextLink

string

Lien pour récupérer la page suivante des résultats.
value

Server[]

Tableau de résultats.

ServerNetworkAccessFlag

Énumération

Indique s’il faut restreindre ou non l’accès réseau sortant pour ce serveur. La valeur est facultative, mais si elle est passée, doit être « Activé » ou « Désactivé »

Valeur Description
Disabled
Enabled

ServerPrivateEndpointConnection

Object

Connexion de point de terminaison privé sous un serveur

Nom Type Description
id

string

ID de ressource.
properties

PrivateEndpointConnectionProperties

Propriétés de connexion de point de terminaison privé

ServerPublicNetworkAccessFlag

Énumération

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

Valeur Description
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Énumération

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

Valeur Description
Connected
Disconnected

UserIdentity

Object

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

Nom Type Description
clientId

string (uuid)

ID client Azure Active Directory.
principalId

string (uuid)

ID du principal Azure Active Directory.