Servers - Get

Referentie

Service:: SQL Database

API-versie:: 2021-11-01

Hiermee haalt u een server op.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.
$expand	query		string	De onderliggende resources die in het antwoord moeten worden opgenomen.

Antwoorden

Name	Type	Description
200 OK	Server	De opgegeven server is opgehaald.
Other Status Codes		Foutreacties: *** 404 SubscriptionNotFound - Het aangevraagde abonnement is niet gevonden. 404 ResourceNotFound - De aangevraagde resource is niet gevonden.

Name

Type

Description

200 OK

Server

De opgegeven server is opgehaald.

Other Status Codes

Foutreacties: ***

404 SubscriptionNotFound - Het aangevraagde abonnement is niet gevonden.
404 ResourceNotFound - De aangevraagde resource is niet gevonden.

Voorbeelden

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AdministratorType	Type van de serverbeheerder.
IdentityType	Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.
PrincipalType	Principal Type van de serverbeheerder.
PrivateEndpointConnectionProperties	Eigenschappen van een privé-eindpuntverbinding.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Status van de privé-eindpuntverbinding.
PrivateLinkServiceConnectionStateActionsRequire	De acties die zijn vereist voor een private link-serviceverbinding.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	De verbindingsstatus van de Private Link-service.
ResourceIdentity	Azure Active Directory-identiteitsconfiguratie voor een resource.
Server	Een Azure SQL databaseserver.
ServerExternalAdministrator	Eigenschappen van een Active Directory-beheerder.
ServerNetworkAccessFlag	Of openbare eindpunttoegang is toegestaan voor deze server. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn
ServerPrivateEndpointConnection	Een privé-eindpuntverbinding onder een server
ServerWorkspaceFeature	Of er al dan niet een werkruimte is gemaakt op een bestaande server en of verbinding vanuit de werkruimte is toegestaan
UserIdentity	Azure Active Directory-identiteitsconfiguratie voor een resource.

AdministratorType

Type van de serverbeheerder.

Name	Type	Description
ActiveDirectory	string

IdentityType

Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Principal Type van de serverbeheerder.

Name	Type	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Eigenschappen van een privé-eindpuntverbinding.

Name	Type	Description
groupIds	string[]	Groeps-id's.
privateEndpoint	PrivateEndpointProperty	Privé-eindpunt waartoe de verbinding behoort.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindingsstatus van de privé-eindpuntverbinding.
provisioningState	PrivateEndpointProvisioningState	Status van de privé-eindpuntverbinding.

PrivateEndpointProperty

Name	Type	Description
id	string	Resource-id van het privé-eindpunt.

PrivateEndpointProvisioningState

Status van de privé-eindpuntverbinding.

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

PrivateLinkServiceConnectionStateActionsRequire

De acties die zijn vereist voor een private link-serviceverbinding.

Name	Type	Description
None	string

PrivateLinkServiceConnectionStateProperty

Name	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	De acties die zijn vereist voor een private link-serviceverbinding.
description	string	De beschrijving van de private link-serviceverbinding.
status	PrivateLinkServiceConnectionStateStatus	De verbindingsstatus van de Private Link-service.

PrivateLinkServiceConnectionStateStatus

De verbindingsstatus van de Private Link-service.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
principalId	string	De principal-id van Azure Active Directory.
tenantId	string	De tenant-id van Azure Active Directory.
type	IdentityType	Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.
userAssignedIdentities	<string, UserIdentity>	De resource-id's van de door de gebruiker toegewezen identiteiten die moeten worden gebruikt

Server

Een Azure SQL databaseserver.

Name	Type	Description
id	string	Resource-id.
identity	ResourceIdentity	De Azure Active Directory-identiteit van de server.
kind	string	Soort SQL-server. Dit zijn metagegevens die worden gebruikt voor de Azure Portal ervaring.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.administratorLogin	string	Gebruikersnaam van beheerder voor de server. Zodra het is gemaakt, kan deze niet meer worden gewijzigd.
properties.administratorLoginPassword	string	Het aanmeldingswachtwoord van de beheerder (vereist voor het maken van de server).
properties.administrators	ServerExternalAdministrator	De Azure Active Directory-beheerder van de server.
properties.federatedClientId	string	De client-id die wordt gebruikt voor CMK-scenario tussen tenants
properties.fullyQualifiedDomainName	string	De volledig gekwalificeerde domeinnaam van de server.
properties.keyId	string	Een CMK-URI van de sleutel die moet worden gebruikt voor versleuteling.
properties.minimalTlsVersion	string	Minimale TLS-versie. Toegestane waarden: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	De resource-id van een door de gebruiker toegewezen identiteit die standaard moet worden gebruikt.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lijst met privé-eindpuntverbindingen op een server
properties.publicNetworkAccess	ServerNetworkAccessFlag	Of openbare eindpunttoegang is toegestaan voor deze server. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Hiermee wordt aangegeven of de uitgaande netwerktoegang voor deze server wordt beperkt. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn
properties.state	string	De status van de server.
properties.version	string	De versie van de server.
properties.workspaceFeature	ServerWorkspaceFeature	Of er al dan niet een werkruimte is gemaakt op een bestaande server en of verbinding vanuit de werkruimte is toegestaan
tags	object	Resourcetags.
type	string	Resourcetype.

ServerExternalAdministrator

Eigenschappen van een Active Directory-beheerder.

Name	Type	Description
administratorType	AdministratorType	Type van de serverbeheerder.
azureADOnlyAuthentication	boolean	Alleen Azure Active Directory-verificatie ingeschakeld.
login	string	Aanmeldingsnaam van de serverbeheerder.
principalType	PrincipalType	Principal Type van de serverbeheerder.
sid	string	SID (object-id) van de serverbeheerder.
tenantId	string	Tenant-id van de beheerder.

ServerNetworkAccessFlag

Of openbare eindpunttoegang is toegestaan voor deze server. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn

Name	Type	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Een privé-eindpuntverbinding onder een server

Name	Type	Description
id	string	Resource-id.
properties	PrivateEndpointConnectionProperties	Eigenschappen van privé-eindpuntverbinding

ServerWorkspaceFeature

Of er al dan niet een werkruimte is gemaakt op een bestaande server en of verbinding vanuit de werkruimte is toegestaan

Name	Type	Description
Connected	string
Disconnected	string

UserIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
clientId	string	De Azure Active Directory-client-id.
principalId	string	De principal-id van Azure Active Directory.

Delen via

Servers - Get

URI-parameters

Antwoorden

Voorbeelden

Get server

Voorbeeldaanvraag

Voorbeeldrespons

Get server with $expand=administrators/activedirectory

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Aanvullende resources