Servers - Get

Referência

Service:: SQL Database

API Version:: 2021-11-01

Obtém um servidor.

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

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$expand	query		string	Os recursos filho a serem incluídos na resposta.

Respostas

Nome	Tipo	Description
200 OK	Server	Recuperou com êxito o servidor especificado.
Other Status Codes		Respostas de erro: *** 404 SubscriptionNotFound - A assinatura solicitada não foi encontrada. 404 ResourceNotFound – O recurso solicitado não foi encontrado.

Nome

Tipo

Description

200 OK

Server

Recuperou com êxito o servidor especificado.

Other Status Codes

Respostas de erro: ***

404 SubscriptionNotFound - A assinatura solicitada não foi encontrada.
404 ResourceNotFound – O recurso solicitado não foi encontrado.

Exemplos

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


import com.azure.core.util.Context;

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

Sample Response

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

Sample Request

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


import com.azure.core.util.Context;

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

Sample Response

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

Definições

Nome	Description
AdministratorType	Tipo do administrador de sever.
IdentityType	O tipo de identidade. Defina isso como "SystemAssigned" para criar e atribuir automaticamente uma entidade de segurança do Azure Active Directory para o recurso.
PrincipalType	Tipo principal do administrador de sever.
PrivateEndpointConnectionProperties	Propriedades de uma conexão de ponto de extremidade privado.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Estado da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a conexão do serviço de link privado.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	A conexão do serviço de link privado status.
ResourceIdentity	Configuração de identidade do Azure Active Directory para um recurso.
Server	Um servidor de banco de dados SQL do Azure.
ServerExternalAdministrator	Propriedades de um administrador do Active Directory.
ServerNetworkAccessFlag	Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'
ServerPrivateEndpointConnection	Uma conexão de ponto de extremidade privado em um servidor
ServerWorkspaceFeature	Se o servidor existente tem ou não um workspace criado e se ele permite a conexão do workspace
UserIdentity	Configuração de identidade do Azure Active Directory para um recurso.

AdministratorType

Tipo do administrador de sever.

Nome	Tipo	Description
ActiveDirectory	string

IdentityType

O tipo de identidade. Defina isso como "SystemAssigned" para criar e atribuir automaticamente uma entidade de segurança do Azure Active Directory para o recurso.

Nome	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Tipo principal do administrador de sever.

Nome	Tipo	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Propriedades de uma conexão de ponto de extremidade privado.

Nome	Tipo	Description
groupIds	string[]	IDs de grupo.
privateEndpoint	PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado de conexão da conexão de ponto de extremidade privado.
provisioningState	PrivateEndpointProvisioningState	Estado da conexão de ponto de extremidade privado.

PrivateEndpointProperty

Nome	Tipo	Description
id	string	ID do recurso do ponto de extremidade privado.

PrivateEndpointProvisioningState

Estado da conexão de ponto de extremidade privado.

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

PrivateLinkServiceConnectionStateActionsRequire

As ações necessárias para a conexão do serviço de link privado.

Nome	Tipo	Description
None	string

PrivateLinkServiceConnectionStateProperty

Nome	Tipo	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	As ações necessárias para a conexão do serviço de link privado.
description	string	A descrição da conexão do serviço de link privado.
status	PrivateLinkServiceConnectionStateStatus	A conexão do serviço de link privado status.

PrivateLinkServiceConnectionStateStatus

A conexão do serviço de link privado status.

Nome	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Nome	Tipo	Description
principalId	string	A ID da entidade de segurança do Azure Active Directory.
tenantId	string	A ID do locatário do Azure Active Directory.
type	IdentityType	O tipo de identidade. Defina isso como "SystemAssigned" para criar e atribuir automaticamente uma entidade de segurança do Azure Active Directory para o recurso.
userAssignedIdentities	<string, UserIdentity>	As IDs de recurso das identidades atribuídas pelo usuário a serem usadas

Server

Um servidor de banco de dados SQL do Azure.

Nome	Tipo	Description
id	string	ID do recurso.
identity	ResourceIdentity	A identidade do Azure Active Directory do servidor.
kind	string	Tipo de sql server. Esses são metadados usados para a experiência de portal do Azure.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.administratorLogin	string	Nome de usuário do administrador para o servidor. Depois de criado, ele não pode ser alterado.
properties.administratorLoginPassword	string	A senha de logon do administrador (necessária para a criação do servidor).
properties.administrators	ServerExternalAdministrator	O administrador do Azure Active Directory do servidor.
properties.federatedClientId	string	A ID do cliente usada para o cenário de CMK entre locatários
properties.fullyQualifiedDomainName	string	O nome de domínio totalmente qualificado do servidor.
properties.keyId	string	Um URI cmk da chave a ser usada para criptografia.
properties.minimalTlsVersion	string	Versão mínima do TLS. Valores permitidos: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	A ID do recurso de uma identidade atribuída pelo usuário a ser usada por padrão.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privado em um servidor
properties.publicNetworkAccess	ServerNetworkAccessFlag	Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Se deseja ou não restringir o acesso à rede de saída para este servidor. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'
properties.state	string	O estado do servidor.
properties.version	string	A versão do servidor.
properties.workspaceFeature	ServerWorkspaceFeature	Se o servidor existente tem ou não um workspace criado e se ele permite a conexão do workspace
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

ServerExternalAdministrator

Propriedades de um administrador do Active Directory.

Nome	Tipo	Description
administratorType	AdministratorType	Tipo do administrador de sever.
azureADOnlyAuthentication	boolean	Somente autenticação do Azure Active Directory habilitada.
login	string	Nome de logon do administrador do servidor.
principalType	PrincipalType	Tipo principal do administrador de sever.
sid	string	SID (ID do objeto) do administrador do servidor.
tenantId	string	ID do locatário do administrador.

ServerNetworkAccessFlag

Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'

Nome	Tipo	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Uma conexão de ponto de extremidade privado em um servidor

Nome	Tipo	Description
id	string	ID do recurso.
properties	PrivateEndpointConnectionProperties	Propriedades de conexão de ponto de extremidade privado

ServerWorkspaceFeature

Se o servidor existente tem ou não um workspace criado e se ele permite a conexão do workspace

Nome	Tipo	Description
Connected	string
Disconnected	string

UserIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Nome	Tipo	Description
clientId	string	A ID do cliente do Azure Active Directory.
principalId	string	A ID da entidade de segurança do Azure Active Directory.

Servers - Get

Parâmetros de URI

Respostas

Exemplos

Get server

Sample Request

Sample Response

Get server with $expand=administrators/activedirectory

Sample Request

Sample Response

Definições

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Recursos adicionais