Servers - Get

Serviço:: SQL Database

Versão da API:: 2023-08-01

Obtém um servidor.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$expand={$expand}&api-version=2023-08-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 na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID da 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	ErrorResponse	Respostas de erro: *** 404 SubscriptionNotFound – A assinatura solicitada não foi encontrada. 404 ResourceNotFound – O recurso solicitado não foi encontrado. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Nome

Tipo

Description

200 OK

Server

Recuperou com êxito o servidor especificado.

Other Status Codes

ErrorResponse

Respostas de erro: ***

404 SubscriptionNotFound – A assinatura solicitada não foi encontrada.
404 ResourceNotFound – O recurso solicitado não foi encontrado.
429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.
503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

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=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerGet.json
// this example is just showing the usage of "Servers_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
SqlServerResource result = await sqlServer.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerGetWithExpandEqualsAdministrators.json
// this example is just showing the usage of "Servers_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
SqlServerResource result = await sqlServer.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 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"
          }
        }
      }
    ]
  }
}

Definições

Nome	Description
AdministratorType	Tipo do administrador de sever.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExternalGovernanceStatus	Status da governança externa.
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.
MinimalTlsVersion	Versão mínima do TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType	Tipo de entidade de segurança 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	O status da conexão do serviço de link privado.
ResourceIdentity	Configuração de identidade do Azure Active Directory para um recurso.
Server	Um servidor do Banco de Dados SQL do Azure.
ServerExternalAdministrator	Propriedades de um administrador do active directory.
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'
ServerPrivateEndpointConnection	Uma conexão de ponto de extremidade privado em um servidor
ServerPublicNetworkAccessFlag	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" ou "SecuredByPerimeter"
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

Enumeração

Tipo do administrador de sever.

Valor	Description
ActiveDirectory

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExternalGovernanceStatus

Enumeração

Status da governança externa.

Valor	Description
Enabled
Disabled

IdentityType

Enumeração

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.

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MinimalTlsVersion

Enumeração

Versão mínima do TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'

Valor	Description
None
1.0
1.1
1.2
1.3

PrincipalType

Enumeração

Tipo de entidade de segurança do administrador de sever.

Valor	Description
User
Group
Application

PrivateEndpointConnectionProperties

Objeto

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

Objeto

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

PrivateEndpointProvisioningState

Enumeração

Estado da conexão de ponto de extremidade privado.

Valor	Description
Approving
Ready
Dropping
Failed
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeração

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

Valor	Description
None

PrivateLinkServiceConnectionStateProperty

Objeto

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	O status da conexão do serviço de link privado.

PrivateLinkServiceConnectionStateStatus

Enumeração

O status da conexão do serviço de link privado.

Valor	Description
Approved
Pending
Rejected
Disconnected

ResourceIdentity

Objeto

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

Nome	Tipo	Description
principalId	string (uuid)	A ID da entidade de segurança do Azure Active Directory.
tenantId	string (uuid)	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

Objeto

Um servidor do 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 do 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. Uma vez 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. Isso só pode ser usado no momento da criação do servidor. Se usado para atualização do servidor, ele será ignorado ou resultará em um erro. Para atualizações, as APIs individuais precisarão ser usadas.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status da governança externa.
properties.federatedClientId	string (uuid)	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.isIPv6Enabled	ServerNetworkAccessFlag	Se deseja ou não habilitar o suporte IPv6 para este servidor. O valor é opcional, mas se passado, deve ser 'Habilitado' ou 'Desabilitado'
properties.keyId	string	Um URI do CMK da chave a ser usada para criptografia.
properties.minimalTlsVersion	MinimalTlsVersion	Versão mínima do TLS. Valores permitidos: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId	string	A ID de 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	ServerPublicNetworkAccessFlag	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" ou "SecuredByPerimeter"
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

Objeto

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 de entidade de segurança do administrador de sever.
sid	string (uuid)	SID (ID do objeto) do administrador do servidor.
tenantId	string (uuid)	ID do locatário do administrador.

ServerNetworkAccessFlag

Enumeração

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'

Valor	Description
Enabled
Disabled

ServerPrivateEndpointConnection

Objeto

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

ServerPublicNetworkAccessFlag

Enumeração

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" ou "SecuredByPerimeter"

Valor	Description
Enabled
Disabled
SecuredByPerimeter

ServerWorkspaceFeature

Enumeração

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

Valor	Description
Connected
Disconnected

UserIdentity

Objeto

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

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

Compartilhar via

Servers - Get

Parâmetros de URI

Respostas

Exemplos

Get server

Solicitação de exemplo

Resposta de exemplo

Get server with $expand=administrators/activedirectory

Solicitação de exemplo

Resposta de exemplo

Definições

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity