Servers - List By Resource Group

Referencia

Servicio:: SQL Database

Versión de la API:: 2021-11-01

Obtiene una lista de servidores de un grupo de recursos.

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

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?$expand={$expand}&api-version=2021-11-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 en la API del Administrador de recursos o el portal de Azure.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.
$expand	query		string	Los recursos secundarios que se van a incluir en la respuesta.

Respuestas

Nombre	Tipo	Description
200 OK	ServerListResult	Recuperó correctamente la lista de servidores.
Other Status Codes		Respuestas de error: *** 404 SubscriptionNotFound: no se encontró la suscripción solicitada.

Nombre

Tipo

Description

200 OK

ServerListResult

Recuperó correctamente la lista de servidores.

Other Status Codes

Respuestas de error: ***

404 SubscriptionNotFound: no se encontró la suscripción solicitada.

Ejemplos

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


/**
 * 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,
            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

Respuesta de muestra

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

Solicitud de ejemplo

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


/**
 * 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,
            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

Respuesta de muestra

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

Definiciones

Nombre	Description
AdministratorType	Tipo del administrador del servidor.
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.
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 base de datos Azure SQL.
ServerExternalAdministrator	Propiedades de un administrador de Active Directory.
ServerListResult	Una lista de servidores.
ServerNetworkAccessFlag	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".
ServerPrivateEndpointConnection	Una conexión de punto de conexión privado en un servidor
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

Tipo del administrador del servidor.

Nombre	Tipo	Description
ActiveDirectory	string

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.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Tipo de entidad de seguridad del administrador del servidor.

Nombre	Tipo	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

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

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

PrivateEndpointProvisioningState

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

Nombre	Tipo	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

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

Nombre	Tipo	Description
None	string

PrivateLinkServiceConnectionStateProperty

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

Estado de conexión del servicio Private Link.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

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

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de Azure Active Directory.
tenantId	string	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 recurso de las identidades asignadas por el usuario que se van a usar

Server

Un servidor de base de datos Azure SQL.

Nombre	Tipo	Description
id	string	Identificador del 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.
properties.federatedClientId	string	Identificador de cliente usado para el escenario de CMK entre inquilinos
properties.fullyQualifiedDomainName	string	Nombre de dominio completo del servidor.
properties.keyId	string	URI de CMK de la clave que se va a usar para el cifrado.
properties.minimalTlsVersion	string	Versión mínima de TLS. Valores permitidos: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	Identificador de recurso de una identidad asignada por el usuario que se usará de forma predeterminada.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado en un servidor
properties.publicNetworkAccess	ServerNetworkAccessFlag	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".
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Si se va a restringir o no el acceso de red saliente a 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 del recurso.
type	string	Tipo de recurso.

ServerExternalAdministrator

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	SID (id. de objeto) del administrador del servidor.
tenantId	string	Id. de inquilino del administrador.

ServerListResult

Una lista de servidores.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	Server[]	Matriz de resultados.

ServerNetworkAccessFlag

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".

Nombre	Tipo	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

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

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

ServerWorkspaceFeature

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

Nombre	Tipo	Description
Connected	string
Disconnected	string

UserIdentity

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

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

Compartir a través de

Servers - List By Resource Group

Parámetros de identificador URI

Respuestas

Ejemplos

List servers by resource group

Solicitud de ejemplo

Respuesta de muestra

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

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Recursos adicionales