Servers - Get

Reference

Služba:: SQL Database

Verze rozhraní API:: 2021-11-01

Získá server.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.
$expand	query		string	Podřízené prostředky, které se mají zahrnout do odpovědi.

Odpovědi

Name	Typ	Description
200 OK	Server	Zadaný server se úspěšně načetl.
Other Status Codes		Chybové odpovědi: *** 404 SubscriptionNotFound –Požadované předplatné nebylo nalezeno. 404 ResourceNotFound – Požadovaný prostředek se nenašel.

Name

Typ

Description

200 OK

Server

Zadaný server se úspěšně načetl.

Other Status Codes

Chybové odpovědi: ***

404 SubscriptionNotFound –Požadované předplatné nebylo nalezeno.
404 ResourceNotFound – Požadovaný prostředek se nenašel.

Příklady

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
          }
        }
      }
    ]
  }
}

Definice

Name	Description
AdministratorType	Typ správce serveru.
IdentityType	Typ identity. Tuto možnost nastavte na SystemAssigned, aby se pro prostředek automaticky vytvořil a přiřadil objekt zabezpečení Služby Azure Active Directory.
PrincipalType	Typ objektu zabezpečení správce serveru.
PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStateActionsRequire	Akce vyžadované pro připojení služby Private Link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Stav připojení služby Private Link.
ResourceIdentity	Konfigurace identity Azure Active Directory pro prostředek
Server	Databázový server Azure SQL.
ServerExternalAdministrator	Vlastnosti správce služby Active Directory.
ServerNetworkAccessFlag	Určuje, jestli je pro tento server povolený přístup z veřejného koncového bodu. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.
ServerPrivateEndpointConnection	Připojení privátního koncového bodu pod serverem
ServerWorkspaceFeature	Určuje, jestli má existující server vytvořený pracovní prostor a jestli umožňuje připojení z pracovního prostoru.
UserIdentity	Konfigurace identity Azure Active Directory pro prostředek

AdministratorType

Typ správce serveru.

Name	Typ	Description
ActiveDirectory	string

IdentityType

Typ identity. Tuto možnost nastavte na SystemAssigned, aby se pro prostředek automaticky vytvořil a přiřadil objekt zabezpečení Služby Azure Active Directory.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Typ objektu zabezpečení správce serveru.

Name	Typ	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu.

Name	Typ	Description
groupIds	string[]	ID skupin.
privateEndpoint	PrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
provisioningState	PrivateEndpointProvisioningState	Stav připojení privátního koncového bodu

PrivateEndpointProperty

Name	Typ	Description
id	string	ID prostředku privátního koncového bodu

PrivateEndpointProvisioningState

Stav připojení privátního koncového bodu

Name	Typ	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Akce vyžadované pro připojení služby Private Link.

Name	Typ	Description
None	string

PrivateLinkServiceConnectionStateProperty

Name	Typ	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Akce vyžadované pro připojení služby Private Link.
description	string	Popis připojení služby Private Link.
status	PrivateLinkServiceConnectionStateStatus	Stav připojení služby Private Link.

PrivateLinkServiceConnectionStateStatus

Stav připojení služby Private Link.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
principalId	string	ID objektu zabezpečení Azure Active Directory.
tenantId	string	ID tenanta Azure Active Directory.
type	IdentityType	Typ identity. Tuto možnost nastavte na SystemAssigned, aby se pro prostředek automaticky vytvořil a přiřadil objekt zabezpečení Služby Azure Active Directory.
userAssignedIdentities	<string, UserIdentity>	ID prostředků identit přiřazených uživatelem, které se mají použít

Server

Databázový server Azure SQL.

Name	Typ	Description
id	string	ID prostředku.
identity	ResourceIdentity	Identita serveru v Azure Active Directory.
kind	string	Druh sql serveru. Jedná se o metadata používaná pro Azure Portal prostředí.
location	string	Umístění prostředku.
name	string	Název prostředku.
properties.administratorLogin	string	Uživatelské jméno správce pro server. Po vytvoření jej nelze změnit.
properties.administratorLoginPassword	string	Přihlašovací heslo správce (vyžadované pro vytvoření serveru)
properties.administrators	ServerExternalAdministrator	Správce Azure Active Directory serveru.
properties.federatedClientId	string	ID klienta použité pro scénář klíče CMK napříč tenanty
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény serveru.
properties.keyId	string	Identifikátor URI klíče cmk, který se má použít k šifrování.
properties.minimalTlsVersion	string	Minimální verze protokolu TLS. Povolené hodnoty: 1.0, 1.1, 1.2
properties.primaryUserAssignedIdentityId	string	ID prostředku identity přiřazené uživatelem, které se použije ve výchozím nastavení.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Seznam připojení privátních koncových bodů na serveru
properties.publicNetworkAccess	ServerNetworkAccessFlag	Určuje, jestli je pro tento server povolený přístup z veřejného koncového bodu. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Určuje, zda se má omezit odchozí síťový přístup pro tento server. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.
properties.state	string	Stav serveru.
properties.version	string	Verze serveru.
properties.workspaceFeature	ServerWorkspaceFeature	Určuje, jestli má existující server vytvořený pracovní prostor a jestli umožňuje připojení z pracovního prostoru.
tags	object	Značky prostředků.
type	string	Typ prostředku.

ServerExternalAdministrator

Vlastnosti správce služby Active Directory.

Name	Typ	Description
administratorType	AdministratorType	Typ správce serveru.
azureADOnlyAuthentication	boolean	Povolené ověřování pouze v Azure Active Directory.
login	string	Přihlašovací jméno správce serveru.
principalType	PrincipalType	Typ objektu zabezpečení správce serveru.
sid	string	IDENTIFIKÁTOR SID (ID objektu) správce serveru.
tenantId	string	ID tenanta správce.

ServerNetworkAccessFlag

Určuje, jestli je pro tento server povolený přístup z veřejného koncového bodu. Hodnota je nepovinná, ale pokud je předána, musí být Povolená nebo Zakázaná.

Name	Typ	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Připojení privátního koncového bodu pod serverem

Name	Typ	Description
id	string	ID prostředku.
properties	PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu

ServerWorkspaceFeature

Určuje, jestli má existující server vytvořený pracovní prostor a jestli umožňuje připojení z pracovního prostoru.

Name	Typ	Description
Connected	string
Disconnected	string

UserIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
clientId	string	ID klienta Azure Active Directory.
principalId	string	ID objektu zabezpečení Azure Active Directory.

Sdílet prostřednictvím

Servers - Get

Parametry identifikátoru URI

Odpovědi

Příklady

Get server

Ukázkový požadavek

Ukázková odpověď

Get server with $expand=administrators/activedirectory

Ukázkový požadavek

Ukázková odpověď

Definice

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Další materiály