Partager via

Servers - Get

  • Référence
Service:
SQL Database
Version d'API:
2021-11-01

Obtient un serveur.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2021-11-01
Avec des paramètres facultatifs: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$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.
serverName
 path True

string

Nom du serveur.
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

Server

Récupérez correctement le serveur spécifié.
Other Status Codes

Réponses d’erreur : ***

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

  • 404 ResourceNotFound : la ressource demandée est introuvable.

Exemples

Get server
Get server with $expand=administrators/activedirectory

Get server

Exemple de requête

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

Exemple de réponse

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

Get server 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/sqlcrudtest-4645?api-version=2021-11-01

Exemple de réponse

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

Définitions

Nom Description
AdministratorType

Type de l’administrateur de serveur.
IdentityType

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

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 « Activé » ou « Désactivé »
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

Énumération

Type de l’administrateur de serveur.

Valeur Description
ActiveDirectory

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

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.
properties.federatedClientId

string (uuid)

ID client utilisé pour le scénario 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 (arm-id)

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 passée, doit être « Activé » ou « Désactivé »
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.

ServerNetworkAccessFlag

É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 « 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é

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.