Servers - Get

Szolgáltatás:

SQL Database

API-verzió:

2023-08-01

Lekéri a kiszolgálót.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.
$expand	query		string	A válaszba belefoglalandó gyermekerőforrások.

Válaszok

Name	Típus	Description
200 OK	Server	Sikeresen lekérte a megadott kiszolgálót.
Other Status Codes	ErrorResponse	Hibaválaszok: *** 404 SubscriptionNotFound – A kért előfizetés nem található. 404 ResourceNotFound – A kért erőforrás nem található. 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható kérelmek maximálisnál több kérése. 503 TooManyRequests – A rendelkezésre álló erőforrások által feldolgozható maximális kérelmeken túli kérések.

Példák

Get server

Get server with $expand=administrators/activedirectory

Get server

Mintakérelem

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

dotnet

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://learn.microsoft.com/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

Mintaválasz

Állapotkó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",
    "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

Mintakérelem

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

dotnet

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://learn.microsoft.com/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

Mintaválasz

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

Definíciók

Name	Description
AdministratorType	A rendszergazda típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ExternalGovernanceStatus	A külső irányítás állapota.
IdentityType	Az identitás típusa. Állítsa ezt a "SystemAssigned" értékre, hogy automatikusan létrehozhasson és hozzárendelhessen egy Azure Active Directory-tagot az erőforráshoz.
MinimalTlsVersion	Minimális TLS-verzió. Engedélyezett értékek: "Nincs", 1.0", "1.1", "1.2", "1.3"
PrincipalType	A rendszergazda egyszerű típusa.
PrivateEndpointConnectionProperties	Privát végpontkapcsolat tulajdonságai.
PrivateEndpointProperty
PrivateEndpointProvisioningState	A privát végpontkapcsolat állapota.
PrivateLinkServiceConnectionStateActionsRequire	A privát kapcsolat szolgáltatáskapcsolatához szükséges műveletek.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	A privát kapcsolat szolgáltatás kapcsolati állapota.
ResourceIdentity	Azure Active Directory-identitáskonfiguráció egy erőforráshoz.
Server	Egy Azure SQL Database-kiszolgáló.
ServerExternalAdministrator	Az Active Directory-rendszergazda tulajdonságai.
ServerNetworkAccessFlag	A kiszolgáló kimenő hálózati hozzáférésének korlátozása. Az érték megadása nem kötelező, de ha be van adva, "Engedélyezve" vagy "Letiltva" értéknek kell lennie
ServerPrivateEndpointConnection	Privát végpontkapcsolat egy kiszolgáló alatt
ServerPublicNetworkAccessFlag	Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez a kiszolgálóhoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" vagy "SecuredByPerimeter" értéknek kell lennie.
ServerWorkspaceFeature	Azt jelzi, hogy a meglévő kiszolgáló rendelkezik-e munkaterület létrehozásával, és engedélyezi-e a kapcsolatot a munkaterületről
UserIdentity	Azure Active Directory-identitáskonfiguráció egy erőforráshoz.

AdministratorType

Enumerálás

A rendszergazda típusa.

Érték	Description
ActiveDirectory

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ExternalGovernanceStatus

Enumerálás

A külső irányítás állapota.

Érték	Description
Enabled
Disabled

IdentityType

Enumerálás

Az identitás típusa. Állítsa ezt a "SystemAssigned" értékre, hogy automatikusan létrehozhasson és hozzárendelhessen egy Azure Active Directory-tagot az erőforráshoz.

Érték	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MinimalTlsVersion

Enumerálás

Minimális TLS-verzió. Engedélyezett értékek: "Nincs", 1.0", "1.1", "1.2", "1.3"

Érték	Description
None
1.0
1.1
1.2
1.3

PrincipalType

Enumerálás

A rendszergazda egyszerű típusa.

Érték	Description
User
Group
Application

PrivateEndpointConnectionProperties

Objektum

Privát végpontkapcsolat tulajdonságai.

Name	Típus	Description
groupIds	string[]	Csoportazonosítók.
privateEndpoint	PrivateEndpointProperty	Privát végpont, amelyhez a kapcsolat tartozik.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	A privát végpont kapcsolati állapota.
provisioningState	PrivateEndpointProvisioningState	A privát végpontkapcsolat állapota.

PrivateEndpointProperty

Objektum

Name	Típus	Description
id	string	A privát végpont erőforrás-azonosítója.

PrivateEndpointProvisioningState

Enumerálás

A privát végpontkapcsolat állapota.

Érték	Description
Approving
Ready
Dropping
Failed
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumerálás

A privát kapcsolat szolgáltatáskapcsolatához szükséges műveletek.

Érték	Description
None

PrivateLinkServiceConnectionStateProperty

Objektum

Name	Típus	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	A privát kapcsolat szolgáltatáskapcsolatához szükséges műveletek.
description	string	A privát kapcsolat szolgáltatás kapcsolatának leírása.
status	PrivateLinkServiceConnectionStateStatus	A privát kapcsolat szolgáltatás kapcsolati állapota.

PrivateLinkServiceConnectionStateStatus

Enumerálás

A privát kapcsolat szolgáltatás kapcsolati állapota.

Érték	Description
Approved
Pending
Rejected
Disconnected

ResourceIdentity

Objektum

Azure Active Directory-identitáskonfiguráció egy erőforráshoz.

Name	Típus	Description
principalId	string (uuid)	Az Azure Active Directory egyszerű azonosítója.
tenantId	string (uuid)	Az Azure Active Directory bérlőazonosítója.
type	IdentityType	Az identitás típusa. Állítsa ezt a "SystemAssigned" értékre, hogy automatikusan létrehozhasson és hozzárendelhessen egy Azure Active Directory-tagot az erőforráshoz.
userAssignedIdentities	<string,  UserIdentity>	A felhasználó által hozzárendelt használt identitások erőforrás-azonosítói

Server

Objektum

Egy Azure SQL Database-kiszolgáló.

Name	Típus	Description
id	string	Erőforrás-azonosító.
identity	ResourceIdentity	A kiszolgáló Azure Active Directory-identitása.
kind	string	Az SQL Server típusa. Ez az Azure Portal felhasználói élményéhez használt metaadatok.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.administratorLogin	string	A kiszolgáló rendszergazdai felhasználóneve. A létrehozás után nem módosítható.
properties.administratorLoginPassword	string	A rendszergazda bejelentkezési jelszava (a kiszolgáló létrehozásához szükséges).
properties.administrators	ServerExternalAdministrator	A kiszolgáló Azure Active Directory-rendszergazdája. Ez csak a kiszolgáló létrehozásakor használható. Ha kiszolgálófrissítéshez használják, a rendszer figyelmen kívül hagyja, vagy hibát eredményez. A frissítésekhez egyéni API-kat kell használni.
properties.externalGovernanceStatus	ExternalGovernanceStatus	A külső irányítás állapota.
properties.federatedClientId	string (uuid)	A bérlők közötti CMK-forgatókönyvhöz használt ügyfélazonosító
properties.fullyQualifiedDomainName	string	A kiszolgáló teljes tartományneve.
properties.isIPv6Enabled	ServerNetworkAccessFlag	A kiszolgáló IPv6-támogatásának engedélyezése. Az érték megadása nem kötelező, de ha be van adva, "Engedélyezve" vagy "Letiltva" értéknek kell lennie
properties.keyId	string	A titkosításhoz használandó kulcs CMK URI-ja.
properties.minimalTlsVersion	MinimalTlsVersion	Minimális TLS-verzió. Engedélyezett értékek: "Nincs", 1.0", "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId	string	A felhasználó által hozzárendelt identitás erőforrás-azonosítója, amelyet alapértelmezés szerint használni szeretne.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	A kiszolgáló magánvégpont-kapcsolatainak listája
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez a kiszolgálóhoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" vagy "SecuredByPerimeter" értéknek kell lennie.
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	A kiszolgáló kimenő hálózati hozzáférésének korlátozása. Az érték megadása nem kötelező, de ha be van adva, "Engedélyezve" vagy "Letiltva" értéknek kell lennie
properties.state	string	A kiszolgáló állapota.
properties.version	string	A kiszolgáló verziója.
properties.workspaceFeature	ServerWorkspaceFeature	Azt jelzi, hogy a meglévő kiszolgáló rendelkezik-e munkaterület létrehozásával, és engedélyezi-e a kapcsolatot a munkaterületről
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

ServerExternalAdministrator

Objektum

Az Active Directory-rendszergazda tulajdonságai.

Name	Típus	Description
administratorType	AdministratorType	A rendszergazda típusa.
azureADOnlyAuthentication	boolean	Csak az Azure Active Directory hitelesítése engedélyezett.
login	string	A kiszolgáló rendszergazdájának bejelentkezési neve.
principalType	PrincipalType	A rendszergazda egyszerű típusa.
sid	string (uuid)	A kiszolgáló rendszergazdájának SID-azonosítója (objektumazonosítója).
tenantId	string (uuid)	A rendszergazda bérlőazonosítója.

ServerNetworkAccessFlag

Enumerálás

A kiszolgáló kimenő hálózati hozzáférésének korlátozása. Az érték megadása nem kötelező, de ha be van adva, "Engedélyezve" vagy "Letiltva" értéknek kell lennie

Érték	Description
Enabled
Disabled

ServerPrivateEndpointConnection

Objektum

Privát végpontkapcsolat egy kiszolgáló alatt

Name	Típus	Description
id	string	Erőforrás-azonosító.
properties	PrivateEndpointConnectionProperties	Privát végpont kapcsolati tulajdonságai

ServerPublicNetworkAccessFlag

Enumerálás

Azt jelzi, hogy engedélyezett-e nyilvános végpont-hozzáférés ehhez a kiszolgálóhoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" vagy "SecuredByPerimeter" értéknek kell lennie.

Érték	Description
Enabled
Disabled
SecuredByPerimeter

ServerWorkspaceFeature

Enumerálás

Azt jelzi, hogy a meglévő kiszolgáló rendelkezik-e munkaterület létrehozásával, és engedélyezi-e a kapcsolatot a munkaterületről

Érték	Description
Connected
Disconnected

UserIdentity

Objektum

Azure Active Directory-identitáskonfiguráció egy erőforráshoz.

Name	Típus	Description
clientId	string (uuid)	Az Azure Active Directory-ügyfél azonosítója.
principalId	string (uuid)	Az Azure Active Directory egyszerű azonosítója.