Microsoft.Sql servers/administrators
- Latest
- 2023-05-01-preview
- 2023-02-01-preview
- 2022-11-01-preview
- 2022-08-01-preview
- 2022-05-01-preview
- 2022-02-01-preview
- 2021-11-01
- 2021-11-01-preview
- 2021-08-01-preview
- 2021-05-01-preview
- 2021-02-01-preview
- 2020-11-01-preview
- 2020-08-01-preview
- 2020-02-02-preview
- 2019-06-01-preview
- 2018-06-01-preview
- 2014-04-01
Bicep resource definition
The servers/administrators resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/administrators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/administrators@2023-05-01-preview' = {
name: 'ActiveDirectory'
parent: resourceSymbolicName
properties: {
administratorType: 'ActiveDirectory'
login: 'string'
sid: 'string'
tenantId: 'string'
}
}
Property values
servers/administrators
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
'ActiveDirectory' |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: servers |
| properties | Resource properties. | AdministratorProperties |
AdministratorProperties
| Name | Description | Value |
|---|---|---|
| administratorType | Type of the sever administrator. | 'ActiveDirectory' (required) |
| login | Login name of the server administrator. | string (required) |
| sid | SID (object ID) of the server administrator. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tenantId | Tenant ID of the administrator. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
App Service Environment with Azure SQL backend |
This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment. |
ARM template resource definition
The servers/administrators resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/administrators resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/administrators",
"apiVersion": "2023-05-01-preview",
"name": "ActiveDirectory",
"properties": {
"administratorType": "ActiveDirectory",
"login": "string",
"sid": "string",
"tenantId": "string"
}
}
Property values
servers/administrators
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/servers/administrators' |
| apiVersion | The resource api version | '2023-05-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'ActiveDirectory' |
| properties | Resource properties. | AdministratorProperties |
AdministratorProperties
| Name | Description | Value |
|---|---|---|
| administratorType | Type of the sever administrator. | 'ActiveDirectory' (required) |
| login | Login name of the server administrator. | string (required) |
| sid | SID (object ID) of the server administrator. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tenantId | Tenant ID of the administrator. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| App Service Environment with Azure SQL backend |
This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment. |
Terraform (AzAPI provider) resource definition
The servers/administrators resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/administrators resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/administrators@2023-05-01-preview"
name = "ActiveDirectory"
parent_id = "string"
body = jsonencode({
properties = {
administratorType = "ActiveDirectory"
login = "string"
sid = "string"
tenantId = "string"
}
})
}
Property values
servers/administrators
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/servers/administrators@2023-05-01-preview" |
| name | The resource name | "ActiveDirectory" |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: servers |
| properties | Resource properties. | AdministratorProperties |
AdministratorProperties
| Name | Description | Value |
|---|---|---|
| administratorType | Type of the sever administrator. | "ActiveDirectory" (required) |
| login | Login name of the server administrator. | string (required) |
| sid | SID (object ID) of the server administrator. | string (required) Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tenantId | Tenant ID of the administrator. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |