Microsoft.Sql servers/failoverGroups 2023-08-01-preview
- Latest
- 2024-05-01-preview
- 2023-08-01-preview
- 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
- 2015-05-01-preview
Bicep resource definition
The servers/failoverGroups 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/failoverGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/failoverGroups@2023-08-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
databases: [
'string'
]
partnerServers: [
{
id: 'string'
}
]
readOnlyEndpoint: {
failoverPolicy: 'string'
targetServer: 'string'
}
readWriteEndpoint: {
failoverPolicy: 'string'
failoverWithDataLossGracePeriodMinutes: int
}
secondaryType: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
FailoverGroupProperties
Name | Description | Value |
---|---|---|
databases | List of databases in the failover group. | string[] |
partnerServers | List of partner server information for the failover group. | PartnerInfo[] (required) |
readOnlyEndpoint | Read-only endpoint of the failover group instance. | FailoverGroupReadOnlyEndpoint |
readWriteEndpoint | Read-write endpoint of the failover group instance. | FailoverGroupReadWriteEndpoint (required) |
secondaryType | Databases secondary type on partner server. | 'Geo' 'Standby' |
FailoverGroupReadOnlyEndpoint
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-only endpoint for the failover group. | 'Disabled' 'Enabled' |
targetServer | The target partner server where the read-only endpoint points to. | string |
FailoverGroupReadWriteEndpoint
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | 'Automatic' 'Manual' (required) |
failoverWithDataLossGracePeriodMinutes | Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | int |
FailoverGroupTags
Name | Description | Value |
---|
Microsoft.Sql/servers/failoverGroups
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
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. | FailoverGroupProperties |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
PartnerInfo
Name | Description | Value |
---|---|---|
id | Resource identifier of the partner server. | string (required) |
ARM template resource definition
The servers/failoverGroups 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/failoverGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/failoverGroups",
"apiVersion": "2023-08-01-preview",
"name": "string",
"properties": {
"databases": [ "string" ],
"partnerServers": [
{
"id": "string"
}
],
"readOnlyEndpoint": {
"failoverPolicy": "string",
"targetServer": "string"
},
"readWriteEndpoint": {
"failoverPolicy": "string",
"failoverWithDataLossGracePeriodMinutes": "int"
},
"secondaryType": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
FailoverGroupProperties
Name | Description | Value |
---|---|---|
databases | List of databases in the failover group. | string[] |
partnerServers | List of partner server information for the failover group. | PartnerInfo[] (required) |
readOnlyEndpoint | Read-only endpoint of the failover group instance. | FailoverGroupReadOnlyEndpoint |
readWriteEndpoint | Read-write endpoint of the failover group instance. | FailoverGroupReadWriteEndpoint (required) |
secondaryType | Databases secondary type on partner server. | 'Geo' 'Standby' |
FailoverGroupReadOnlyEndpoint
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-only endpoint for the failover group. | 'Disabled' 'Enabled' |
targetServer | The target partner server where the read-only endpoint points to. | string |
FailoverGroupReadWriteEndpoint
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | 'Automatic' 'Manual' (required) |
failoverWithDataLossGracePeriodMinutes | Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | int |
FailoverGroupTags
Name | Description | Value |
---|
Microsoft.Sql/servers/failoverGroups
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2023-08-01-preview' |
name | The resource name | string (required) |
properties | Resource properties. | FailoverGroupProperties |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
type | The resource type | 'Microsoft.Sql/servers/failoverGroups' |
PartnerInfo
Name | Description | Value |
---|---|---|
id | Resource identifier of the partner server. | string (required) |
Terraform (AzAPI provider) resource definition
The servers/failoverGroups 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/failoverGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/failoverGroups@2023-08-01-preview"
name = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
databases = [
"string"
]
partnerServers = [
{
id = "string"
}
]
readOnlyEndpoint = {
failoverPolicy = "string"
targetServer = "string"
}
readWriteEndpoint = {
failoverPolicy = "string"
failoverWithDataLossGracePeriodMinutes = int
}
secondaryType = "string"
}
})
}
Property values
FailoverGroupProperties
Name | Description | Value |
---|---|---|
databases | List of databases in the failover group. | string[] |
partnerServers | List of partner server information for the failover group. | PartnerInfo[] (required) |
readOnlyEndpoint | Read-only endpoint of the failover group instance. | FailoverGroupReadOnlyEndpoint |
readWriteEndpoint | Read-write endpoint of the failover group instance. | FailoverGroupReadWriteEndpoint (required) |
secondaryType | Databases secondary type on partner server. | 'Geo' 'Standby' |
FailoverGroupReadOnlyEndpoint
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-only endpoint for the failover group. | 'Disabled' 'Enabled' |
targetServer | The target partner server where the read-only endpoint points to. | string |
FailoverGroupReadWriteEndpoint
Name | Description | Value |
---|---|---|
failoverPolicy | Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | 'Automatic' 'Manual' (required) |
failoverWithDataLossGracePeriodMinutes | Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. | int |
FailoverGroupTags
Name | Description | Value |
---|
Microsoft.Sql/servers/failoverGroups
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: servers |
properties | Resource properties. | FailoverGroupProperties |
tags | Resource tags | Dictionary of tag names and values. |
type | The resource type | "Microsoft.Sql/servers/failoverGroups@2023-08-01-preview" |
PartnerInfo
Name | Description | Value |
---|---|---|
id | Resource identifier of the partner server. | string (required) |