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

Microsoft.Sql server/jobAgents

  • 项目

Bicep 资源定义

servers/jobAgents 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

若要创建 Microsoft.Sql/servers/jobAgents 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Sql/servers/jobAgents@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  identity: {
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    databaseId: 'string'
  }
}

属性值

servers/jobAgents

名称 说明 值
name 资源名称

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

有关详细信息，请参阅 父资源之外的子资源。		 类型为“服务器”的资源的符号名称
标识 作业代理的标识。 JobAgentIdentity
properties 资源属性。 JobAgentProperties

JobAgentIdentity

名称 说明 值
tenantId 作业代理标识租户 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
类型 作业代理标识类型 “None”
“SystemAssigned”
“SystemAssignedUserAssigned”
“UserAssigned” (必需)
userAssignedIdentities 要使用的用户分配标识的资源 ID JobAgentIdentityUserAssignedIdentities

JobAgentIdentityUserAssignedIdentities

名称 说明 值
{customized property} JobAgentUserAssignedIdentity

JobAgentUserAssignedIdentity

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

JobAgentProperties

名称 说明 值
databaseId 要存储作业元数据的数据库的资源 ID。 字符串 (必需)

SKU

名称 说明 值
容量 特定 SKU 的容量。 int
family 如果服务具有不同代系的硬件（对于同一 SKU），则可以在此处进行捕获。 字符串
name SKU 的名称，通常为字母 + 数字代码，例如 P3。 字符串 (必需)
大小 特定 SKU 的大小 字符串
层 特定 SKU 的层或版本，例如“基本”、“高级”。 字符串

ARM 模板资源定义

servers/jobAgents 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

若要创建 Microsoft.Sql/servers/jobAgents 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Sql/servers/jobAgents",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "identity": {
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "databaseId": "string"
  }
}

属性值

servers/jobAgents

名称 说明 Value
type 资源类型 “Microsoft.Sql/servers/jobAgents”
apiVersion 资源 API 版本 “2023-05-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku SKU 的名称和层。 Sku
标识 作业代理的标识。 JobAgentIdentity
properties 资源属性。 JobAgentProperties

JobAgentIdentity

名称 说明 值
tenantId 作业代理标识租户 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
类型 作业代理标识类型 “None”
“SystemAssigned”
“SystemAssignedUserAssigned”
“UserAssigned” (必需)
userAssignedIdentities 要使用的用户分配标识的资源 ID JobAgentIdentityUserAssignedIdentities

JobAgentIdentityUserAssignedIdentities

名称 说明 值
{customized property} JobAgentUserAssignedIdentity

JobAgentUserAssignedIdentity

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

JobAgentProperties

名称 说明 值
databaseId 要存储作业元数据的数据库的资源 ID。 字符串 (必需)

SKU

名称 说明 值
容量 特定 SKU 的容量。 int
family 如果服务具有不同代系的硬件（对于同一 SKU），则可以在此处进行捕获。 字符串
name SKU 的名称，通常为字母 + 数字代码，例如 P3。 字符串 (必需)
大小 特定 SKU 的大小 字符串
层 特定 SKU 的层或版本，例如“基本”、“高级”。 字符串

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

servers/jobAgents 资源类型可以使用面向以下对象的操作进行部署：

  • 资源组

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

资源格式

若要创建 Microsoft.Sql/servers/jobAgents 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      databaseId = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

属性值

servers/jobAgents

名称 说明 Value
type 资源类型 “Microsoft.Sql/servers/jobAgents@2023-05-01-preview”
name 资源名称 字符串 (必需)
location 资源位置。 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为“服务器”的资源的 ID
标记 资源标记。 标记名称和值的字典。
sku SKU 的名称和层。 Sku
标识 作业代理的标识。 JobAgentIdentity
properties 资源属性。 JobAgentProperties

JobAgentIdentity

名称 说明 Value
type 作业代理标识类型 “SystemAssigned”
“SystemAssignedUserAssigned”
“UserAssigned” (必需)
identity_ids 要使用的用户分配标识的资源 ID 用户标识 ID 数组。

JobAgentIdentityUserAssignedIdentities

名称 说明 值
{customized property} JobAgentUserAssignedIdentity

JobAgentUserAssignedIdentity

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

JobAgentProperties

名称 说明 值
databaseId 要存储作业元数据的数据库的资源 ID。 字符串 (必需)

SKU

名称 说明 值
容量 特定 SKU 的容量。 int
family 如果服务具有不同代系的硬件（对于同一 SKU），则可以在此处进行捕获。 字符串
name SKU 的名称，通常为字母 + 数字代码，例如 P3。 字符串 (必需)
大小 特定 SKU 的大小 字符串
层 特定 SKU 的层或版本，例如“基本”、“高级”。 字符串