Servers - List By Resource Group
Gets a list of servers in a resource groups.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?api-version=2021-11-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?$expand={$expand}&api-version=2021-11-01
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
api-version
|
query | True |
string |
The API version to use for the request. |
$expand
|
query |
string |
The child resources to include in the response. |
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved the list of servers. |
|
Other Status Codes |
*** Error Responses: ***
|
List servers by resource group |
List servers by resource group with $expand=administrators/activedirectory |
Sample request
Sample response
{
"value": [
{
"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"
}
}
}
]
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
"name": "sqlcrudtest-6661",
"type": "Microsoft.Sql/servers",
"location": "japaneast",
"kind": "v12.0",
"properties": {
"fullyQualifiedDomainName": "sqlcrudtest-6661.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"
}
}
}
]
}
}
]
}
Sample request
Sample response
{
"value": [
{
"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"
}
}
}
]
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
"name": "sqlcrudtest-6661",
"type": "Microsoft.Sql/servers",
"location": "japaneast",
"kind": "v12.0",
"properties": {
"fullyQualifiedDomainName": "sqlcrudtest-6661.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"
}
}
}
]
}
}
]
}
Name | Description |
---|---|
Administrator |
Type of the sever administrator. |
Identity |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. |
Principal |
Principal Type of the sever administrator. |
Private |
Properties of a private endpoint connection. |
Private |
|
Private |
State of the private endpoint connection. |
Private |
The actions required for private link service connection. |
Private |
|
Private |
The private link service connection status. |
Resource |
Azure Active Directory identity configuration for a resource. |
Server |
An Azure SQL Database server. |
Server |
Properties of a active directory administrator. |
Server |
A list of servers. |
Server |
Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
Server |
A private endpoint connection under a server |
Server |
Whether or not existing server has a workspace created and if it allows connection from workspace |
User |
Azure Active Directory identity configuration for a resource. |
Type of the sever administrator.
Name | Type | Description |
---|---|---|
ActiveDirectory |
string |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
Principal Type of the sever administrator.
Name | Type | Description |
---|---|---|
Application |
string |
|
Group |
string |
|
User |
string |
Properties of a private endpoint connection.
Name | Type | Description |
---|---|---|
groupIds |
string[] |
Group IDs. |
privateEndpoint |
Private endpoint which the connection belongs to. |
|
privateLinkServiceConnectionState |
Connection state of the private endpoint connection. |
|
provisioningState |
State of the private endpoint connection. |
Name | Type | Description |
---|---|---|
id |
string |
Resource id of the private endpoint. |
State of the private endpoint connection.
Name | Type | Description |
---|---|---|
Approving |
string |
|
Dropping |
string |
|
Failed |
string |
|
Ready |
string |
|
Rejecting |
string |
The actions required for private link service connection.
Name | Type | Description |
---|---|---|
None |
string |
Name | Type | Description |
---|---|---|
actionsRequired |
The actions required for private link service connection. |
|
description |
string |
The private link service connection description. |
status |
The private link service connection status. |
The private link service connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
Azure Active Directory identity configuration for a resource.
Name | Type | Description |
---|---|---|
principalId |
string |
The Azure Active Directory principal id. |
tenantId |
string |
The Azure Active Directory tenant id. |
type |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. |
|
userAssignedIdentities |
<string,
User |
The resource ids of the user assigned identities to use |
An Azure SQL Database server.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
identity |
The Azure Active Directory identity of the server. |
|
kind |
string |
Kind of sql server. This is metadata used for the Azure portal experience. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.administratorLogin |
string |
Administrator username for the server. Once created it cannot be changed. |
properties.administratorLoginPassword |
string |
The administrator login password (required for server creation). |
properties.administrators |
The Azure Active Directory administrator of the server. |
|
properties.federatedClientId |
string |
The Client id used for cross tenant CMK scenario |
properties.fullyQualifiedDomainName |
string |
The fully qualified domain name of the server. |
properties.keyId |
string |
A CMK URI of the key to use for encryption. |
properties.minimalTlsVersion |
string |
Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' |
properties.primaryUserAssignedIdentityId |
string |
The resource id of a user assigned identity to be used by default. |
properties.privateEndpointConnections |
List of private endpoint connections on a server |
|
properties.publicNetworkAccess |
Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
|
properties.restrictOutboundNetworkAccess |
Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
|
properties.state |
string |
The state of the server. |
properties.version |
string |
The version of the server. |
properties.workspaceFeature |
Whether or not existing server has a workspace created and if it allows connection from workspace |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
Properties of a active directory administrator.
Name | Type | Description |
---|---|---|
administratorType |
Type of the sever administrator. |
|
azureADOnlyAuthentication |
boolean |
Azure Active Directory only Authentication enabled. |
login |
string |
Login name of the server administrator. |
principalType |
Principal Type of the sever administrator. |
|
sid |
string |
SID (object ID) of the server administrator. |
tenantId |
string |
Tenant ID of the administrator. |
A list of servers.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
Server[] |
Array of results. |
Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
A private endpoint connection under a server
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
properties |
Private endpoint connection properties |
Whether or not existing server has a workspace created and if it allows connection from workspace
Name | Type | Description |
---|---|---|
Connected |
string |
|
Disconnected |
string |
Azure Active Directory identity configuration for a resource.
Name | Type | Description |
---|---|---|
clientId |
string |
The Azure Active Directory client id. |
principalId |
string |
The Azure Active Directory principal id. |