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	Le nom du serveur
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	Server	Récupération réussie du 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.

Nom

Type

Description

200 OK

Server

Récupération réussie du 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

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


/**
 * Samples for Servers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerGet.json
     */
    /**
     * Sample code: Get server.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().getByResourceGroupWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, com.azure.core.util.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

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

HTTP
Java

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


/**
 * Samples for Servers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerGetWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: Get server with $expand=administrators/activedirectory.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getServerWithExpandAdministratorsActivedirectory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().getByResourceGroupWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, com.azure.core.util.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

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 ce paramètre sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.
PrincipalType	Type 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 de liaison privée.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.
ResourceIdentity	Configuration de l’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.
ServerNetworkAccessFlag	Indique si l’accès au point de terminaison public est autorisé ou non 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	Si un serveur existant a ou non un espace de travail créé et s’il autorise la connexion à partir de l’espace de travail
UserIdentity	Configuration de l’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 ce paramètre 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 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 la connexion appartient.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de la connexion du 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 de liaison privée.

Nom	Type	Description
None	string

PrivateLinkServiceConnectionStateProperty

Nom	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service de liaison privée.
description	string	Description de la connexion au service de liaison privée.
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 de l’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 ce paramètre 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 serveur sql. 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 pour le 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 CMK entre locataires
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é ou non 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	Si un serveur existant a ou non 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	Azure Active Directory uniquement Authentification activée.
login	string	Nom de connexion de l’administrateur du serveur.
principalType	PrincipalType	Type 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.

ServerNetworkAccessFlag

Indique si l’accès au point de terminaison public est autorisé ou non 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

Si un serveur existant a ou non 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 de l’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.

Partager via

Servers - Get

Paramètres URI

Réponses

Exemples

Get server

Exemple de requête

Exemple de réponse

Get server with $expand=administrators/activedirectory

Exemple de requête

Exemple de réponse

Définitions

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Ressources supplémentaires