Servers - Get

Referencia

Servicio:: SQL Database

Versión de la API:: 2023-08-01

Obtiene un servidor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2023-08-01

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$expand={$expand}&api-version=2023-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.
$expand	query		string	Los recursos secundarios que se van a incluir en la respuesta.

Respuestas

Nombre	Tipo	Description
200 OK	Server	Recuperó correctamente el servidor especificado.
Other Status Codes	ErrorResponse	Respuestas de error: *** 404 SubscriptionNotFound: no se encontró la suscripción solicitada. 404 ResourceNotFound: no se encontró el recurso solicitado. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Nombre

Tipo

Description

200 OK

Server

Recuperó correctamente el servidor especificado.

Other Status Codes

ErrorResponse

Respuestas de error: ***

404 SubscriptionNotFound: no se encontró la suscripción solicitada.
404 ResourceNotFound: no se encontró el recurso solicitado.
429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

Get server

Get server with $expand=administrators/activedirectory

Get server

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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",
    "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"
          }
        }
      }
    ]
  }
}

Get server with $expand=administrators/activedirectory

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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",
    "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"
          }
        }
      }
    ]
  }
}

Definiciones

Nombre	Description
AdministratorType	Tipo del administrador del servidor.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ExternalGovernanceStatus	Estado de la gobernanza externa.
IdentityType	Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.
MinimalTlsVersion	Versión mínima de TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType	Tipo de entidad de seguridad del administrador del servidor.
PrivateEndpointConnectionProperties	Propiedades de una conexión de punto de conexión privado.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado de la conexión del punto de conexión privado.
PrivateLinkServiceConnectionStateActionsRequire	Las acciones necesarias para la conexión del servicio Private Link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Estado de conexión del servicio private link.
ResourceIdentity	Configuración de identidad de Azure Active Directory para un recurso.
Server	Un servidor de Azure SQL Database.
ServerExternalAdministrator	Propiedades de un administrador de Active Directory.
ServerNetworkAccessFlag	Si se va a restringir o no el acceso de red saliente para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".
ServerPrivateEndpointConnection	Una conexión de punto de conexión privado en un servidor
ServerPublicNetworkAccessFlag	Si se permite o no el acceso al punto de conexión público para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado" o "SecuredByPerimeter".
ServerWorkspaceFeature	Si el servidor existente tiene o no un área de trabajo creada y si permite la conexión desde el área de trabajo
UserIdentity	Configuración de identidad de Azure Active Directory para un recurso.

AdministratorType

Enumeración

Tipo del administrador del servidor.

Valor	Description
ActiveDirectory

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ExternalGovernanceStatus

Enumeración

Estado de la gobernanza externa.

Valor	Description
Disabled
Enabled

IdentityType

Enumeración

Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Enumeración

Versión mínima de TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'

Valor	Description
1.0
1.1
1.2
1.3
None

PrincipalType

Enumeración

Tipo de entidad de seguridad del administrador del servidor.

Valor	Description
Application
Group
User

PrivateEndpointConnectionProperties

Object

Propiedades de una conexión de punto de conexión privado.

Nombre	Tipo	Description
groupIds	string[]	Identificadores de grupo.
privateEndpoint	PrivateEndpointProperty	Punto de conexión privado al que pertenece la conexión.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado de conexión de la conexión del punto de conexión privado.
provisioningState	PrivateEndpointProvisioningState	Estado de la conexión del punto de conexión privado.

PrivateEndpointProperty

Object

Nombre	Tipo	Description
id	string	Identificador de recurso del punto de conexión privado.

PrivateEndpointProvisioningState

Enumeración

Estado de la conexión del punto de conexión privado.

Valor	Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeración

Las acciones necesarias para la conexión del servicio Private Link.

Valor	Description
None

PrivateLinkServiceConnectionStateProperty

Object

Nombre	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Las acciones necesarias para la conexión del servicio Private Link.
description	string	Descripción de la conexión del servicio private link.
status	PrivateLinkServiceConnectionStateStatus	Estado de conexión del servicio private link.

PrivateLinkServiceConnectionStateStatus

Enumeración

Estado de conexión del servicio private link.

Valor	Description
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de seguridad de Azure Active Directory.
tenantId	string (uuid)	Identificador de inquilino de Azure Active Directory.
type	IdentityType	Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.
userAssignedIdentities	<string, UserIdentity>	Identificadores de recursos de las identidades asignadas por el usuario que se van a usar

Server

Object

Un servidor de Azure SQL Database.

Nombre	Tipo	Description
id	string	Identificador de recurso.
identity	ResourceIdentity	Identidad de Azure Active Directory del servidor.
kind	string	Tipo de sql Server. Estos son los metadatos que se usan para la experiencia de Azure Portal.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.administratorLogin	string	Nombre de usuario del administrador para el servidor. Una vez creado, no se puede cambiar.
properties.administratorLoginPassword	string	La contraseña de inicio de sesión del administrador (necesaria para la creación del servidor).
properties.administrators	ServerExternalAdministrator	Administrador de Azure Active Directory del servidor. Esto solo se puede usar en tiempo de creación del servidor. Si se usa para la actualización del servidor, se omitirá o se producirá un error. Para las actualizaciones, es necesario usar las API individuales.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Estado de la gobernanza externa.
properties.federatedClientId	string (uuid)	Identificador de cliente usado para el escenario de CMK entre inquilinos
properties.fullyQualifiedDomainName	string	Nombre de dominio completo del servidor.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Si se va a habilitar o no la compatibilidad con IPv6 para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".
properties.keyId	string	URI de CMK de la clave que se va a usar para el cifrado.
properties.minimalTlsVersion	MinimalTlsVersion	Versión mínima de TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId	string	Identificador de recurso de una identidad asignada por el usuario que se va a usar de forma predeterminada.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado en un servidor
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Si se permite o no el acceso al punto de conexión público para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado" o "SecuredByPerimeter".
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Si se va a restringir o no el acceso de red saliente para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".
properties.state	string	Estado del servidor.
properties.version	string	Versión del servidor.
properties.workspaceFeature	ServerWorkspaceFeature	Si el servidor existente tiene o no un área de trabajo creada y si permite la conexión desde el área de trabajo
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ServerExternalAdministrator

Object

Propiedades de un administrador de Active Directory.

Nombre	Tipo	Description
administratorType	AdministratorType	Tipo del administrador del servidor.
azureADOnlyAuthentication	boolean	Autenticación solo de Azure Active Directory habilitada.
login	string	Nombre de inicio de sesión del administrador del servidor.
principalType	PrincipalType	Tipo de entidad de seguridad del administrador del servidor.
sid	string (uuid)	SID (id. de objeto) del administrador del servidor.
tenantId	string (uuid)	Identificador de inquilino del administrador.

ServerNetworkAccessFlag

Enumeración

Si se va a restringir o no el acceso de red saliente para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado".

Valor	Description
Disabled
Enabled

ServerPrivateEndpointConnection

Object

Una conexión de punto de conexión privado en un servidor

Nombre	Tipo	Description
id	string	Identificador de recurso.
properties	PrivateEndpointConnectionProperties	Propiedades de conexión de punto de conexión privado

ServerPublicNetworkAccessFlag

Enumeración

Si se permite o no el acceso al punto de conexión público para este servidor. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado" o "SecuredByPerimeter".

Valor	Description
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Enumeración

Si el servidor existente tiene o no un área de trabajo creada y si permite la conexión desde el área de trabajo

Valor	Description
Connected
Disconnected

UserIdentity

Object

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de Azure Active Directory.
principalId	string (uuid)	Identificador de entidad de seguridad de Azure Active Directory.

Compartir a través de

Servers - Get

Parámetros de identificador URI

Respuestas

Ejemplos

Get server

Solicitud de ejemplo

Respuesta de muestra

Get server with $expand=administrators/activedirectory

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity

Recursos adicionales