你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.AzureArcData sqlServerInstances/sqlAvailabilityGroups

Bicep 资源定义

sqlServerInstances/sqlAvailabilityGroups 资源类型可以使用面向的操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups@2023-03-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    availabilityGroupId: 'string'
    availabilityGroupName: 'string'
    configure: {
      availabilityModeDesc: 'string'
      backupPriority: int
      createDate: 'string'
      endpointUrl: 'string'
      failoverModeDesc: 'string'
      modifyDate: 'string'
      primaryRoleAllowConnectionsDesc: 'string'
      readOnlyRoutingUrl: 'string'
      readWriteRoutingUrl: 'string'
      secondaryRoleAllowConnectionsDesc: 'string'
      seedingModeDesc: 'string'
      sessionTimeout: int
    }
    state: {
      availabilityGroupReplicaRole: 'string'
      connectedStateDesc: 'string'
      lastConnectErrorDescription: 'string'
      lastConnectErrorTimestamp: 'string'
      operationalStateDesc: 'string'
      recoveryHealthDesc: 'string'
      synchronizationHealthDesc: 'string'
    }
  }
}

属性值

sqlServerInstances/sqlAvailabilityGroups

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型的资源的符号名称: sqlServerInstances
properties Arc Sql Server 可用性组的属性 SqlServerAvailabilityGroupResourceProperties (必需的)

SqlServerAvailabilityGroupResourceProperties

名称 说明
availabilityGroupId 可用性组的 ID GUID。 字符串 (必需)
availabilityGroupName 可用性组名称。 字符串
配置 Null AvailabilityGroupConfigure
state Null AvailabilityGroupState

AvailabilityGroupConfigure

名称 说明
availabilityModeDesc 可用性组副本 (replica) 的可用性同步模式说明。 字符串
backupPriority 表示相对于同一可用性组中的其他副本,在此副本上执行备份的用户指定的优先级。 int
createDate 副本的创建日期。 string
endpointUrl 可用性组副本 (replica) 的镜像终结点 URL 字符串
failoverModeDesc 可用性组副本 (replica) 的故障转移模式说明。 字符串
modifyDate 修改副本 (replica) 的日期。 字符串
primaryRoleAllowConnectionsDesc 允许可用性组的主角色副本 (replica) 连接。 字符串
readOnlyRoutingUrl 只读可用性副本的连接端点 (URL)。 字符串
readWriteRoutingUrl 连接终结点 (读写可用性副本 (replica) 的 URL) 。 字符串
secondaryRoleAllowConnectionsDesc 允许可用性组的辅助角色副本 (replica) 连接。 字符串
seedingModeDesc 描述种子设定模式。 字符串
sessionTimeout 可用性组会话的超时期限副本 (replica) (以秒为单位)。 int

AvailabilityGroupState

名称 说明
availabilityGroupReplicaRole 可用性组副本 (replica) 的角色说明。 字符串
connectedStateDesc 可用性组副本 (replica) 的连接状态说明。 字符串
lastConnectErrorDescription 可用性组副本 (replica) 的上次连接错误说明。 string
lastConnectErrorTimestamp 可用性组副本 (replica) 的上次连接错误时间戳。 字符串
operationalStateDesc 可用性组副本 (replica) 的操作状态说明 字符串
recoveryHealthDesc 可用性组副本 (replica) 的恢复运行状况说明。 字符串
synchronizationHealthDesc 可用性组副本 (replica) 的同步运行状况说明。 string

ARM 模板资源定义

sqlServerInstances/sqlAvailabilityGroups 资源类型可以使用以下目标操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "availabilityGroupId": "string",
    "availabilityGroupName": "string",
    "configure": {
      "availabilityModeDesc": "string",
      "backupPriority": "int",
      "createDate": "string",
      "endpointUrl": "string",
      "failoverModeDesc": "string",
      "modifyDate": "string",
      "primaryRoleAllowConnectionsDesc": "string",
      "readOnlyRoutingUrl": "string",
      "readWriteRoutingUrl": "string",
      "secondaryRoleAllowConnectionsDesc": "string",
      "seedingModeDesc": "string",
      "sessionTimeout": "int"
    },
    "state": {
      "availabilityGroupReplicaRole": "string",
      "connectedStateDesc": "string",
      "lastConnectErrorDescription": "string",
      "lastConnectErrorTimestamp": "string",
      "operationalStateDesc": "string",
      "recoveryHealthDesc": "string",
      "synchronizationHealthDesc": "string"
    }
  }
}

属性值

sqlServerInstances/sqlAvailabilityGroups

名称 说明 Value
type 资源类型 “Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups”
apiVersion 资源 API 版本 “2023-03-15-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties Arc Sql Server 可用性组的属性 SqlServerAvailabilityGroupResourceProperties (必需的)

SqlServerAvailabilityGroupResourceProperties

名称 说明
availabilityGroupId 可用性组的 ID GUID。 字符串 (必需)
availabilityGroupName 可用性组名称。 字符串
配置 Null AvailabilityGroupConfigure
state Null AvailabilityGroupState

AvailabilityGroupConfigure

名称 说明
availabilityModeDesc 可用性组副本 (replica) 的可用性同步模式说明。 字符串
backupPriority 表示相对于同一可用性组中的其他副本,在此副本上执行备份的用户指定的优先级。 int
createDate 副本的创建日期。 string
endpointUrl 可用性组副本 (replica) 的镜像终结点 URL 字符串
failoverModeDesc 可用性组副本 (replica) 的故障转移模式说明。 字符串
modifyDate 修改副本 (replica) 的日期。 字符串
primaryRoleAllowConnectionsDesc 允许可用性组的主角色连接副本 (replica) 。 字符串
readOnlyRoutingUrl 只读可用性副本的连接端点 (URL)。 字符串
readWriteRoutingUrl 连接终结点 (读取写入可用性副本 (replica) 的 URL) 。 字符串
secondaryRoleAllowConnectionsDesc 允许可用性组副本 (replica) 辅助角色的连接。 字符串
seedingModeDesc 描述种子设定模式。 字符串
sessionTimeout 可用性组会话的超时期限副本 (replica) ,以秒为单位。 int

AvailabilityGroupState

名称 说明
availabilityGroupReplicaRole 可用性组副本 (replica) 的角色说明。 字符串
connectedStateDesc 可用性组副本 (replica) 的连接状态说明。 字符串
lastConnectErrorDescription 可用性组副本 (replica) 的上次连接错误说明。 字符串
lastConnectErrorTimestamp 可用性组副本 (replica) 的上次连接错误时间戳。 字符串
operationalStateDesc 可用性组副本 (replica) 的操作状态说明 字符串
recoveryHealthDesc 可用性组副本 (replica) 的恢复运行状况说明。 字符串
synchronizationHealthDesc 可用性组副本 (replica) 的同步运行状况说明。 string

Terraform (AzAPI 提供程序) 资源定义

sqlServerInstances/sqlAvailabilityGroups 资源类型可以使用以下目标操作进行部署:

  • 资源组

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      availabilityGroupId = "string"
      availabilityGroupName = "string"
      configure = {
        availabilityModeDesc = "string"
        backupPriority = int
        createDate = "string"
        endpointUrl = "string"
        failoverModeDesc = "string"
        modifyDate = "string"
        primaryRoleAllowConnectionsDesc = "string"
        readOnlyRoutingUrl = "string"
        readWriteRoutingUrl = "string"
        secondaryRoleAllowConnectionsDesc = "string"
        seedingModeDesc = "string"
        sessionTimeout = int
      }
      state = {
        availabilityGroupReplicaRole = "string"
        connectedStateDesc = "string"
        lastConnectErrorDescription = "string"
        lastConnectErrorTimestamp = "string"
        operationalStateDesc = "string"
        recoveryHealthDesc = "string"
        synchronizationHealthDesc = "string"
      }
    }
  })
}

属性值

sqlServerInstances/sqlAvailabilityGroups

名称 说明 Value
type 资源类型 “Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups@2023-03-15-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为的资源的 ID: sqlServerInstances
标记 资源标记。 标记名称和值的字典。
properties Arc Sql Server 可用性组的属性 SqlServerAvailabilityGroupResourceProperties (必需的)

SqlServerAvailabilityGroupResourceProperties

名称 说明
availabilityGroupId 可用性组的 ID GUID。 字符串 (必需)
availabilityGroupName 可用性组名称。 string
配置 Null AvailabilityGroupConfigure
state Null AvailabilityGroupState

AvailabilityGroupConfigure

名称 说明
availabilityModeDesc 可用性组副本 (replica) 的可用性同步模式说明。 字符串
backupPriority 表示相对于同一可用性组中的其他副本,在此副本上执行备份的用户指定的优先级。 int
createDate 副本的创建日期。 string
endpointUrl 可用性组副本 (replica) 的镜像终结点 URL 字符串
failoverModeDesc 可用性组副本 (replica) 的故障转移模式说明。 字符串
modifyDate 修改副本 (replica) 的日期。 字符串
primaryRoleAllowConnectionsDesc 允许可用性组的主角色连接副本 (replica) 。 字符串
readOnlyRoutingUrl 只读可用性副本的连接端点 (URL)。 string
readWriteRoutingUrl 连接终结点 (读写可用性副本 (replica) 的 URL) 。 string
secondaryRoleAllowConnectionsDesc 允许可用性组的辅助角色副本 (replica) 连接。 字符串
seedingModeDesc 描述种子设定模式。 字符串
sessionTimeout 可用性组会话的超时期限副本 (replica) (以秒为单位)。 int

AvailabilityGroupState

名称 说明
availabilityGroupReplicaRole 可用性组副本 (replica) 的角色说明。 字符串
connectedStateDesc 可用性组副本 (replica) 的连接状态说明。 字符串
lastConnectErrorDescription 可用性组副本 (replica) 的上次连接错误说明。 字符串
lastConnectErrorTimestamp 可用性组副本 (replica) 的上次连接错误时间戳。 字符串
operationalStateDesc 可用性组副本 (replica) 的操作状态说明 字符串
recoveryHealthDesc 可用性组副本 (replica) 的恢复运行状况说明。 字符串
synchronizationHealthDesc 可用性组副本 (replica) 的同步运行状况说明。 字符串