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

Microsoft.ServiceFabric managedClusters 2021-05-01

  • 项目

Bicep 资源定义

可以使用面向以下操作部署 managedClusters 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.ServiceFabric/managedClusters@2021-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  properties: {
    addonFeatures: [
      'string'
    ]
    adminPassword: 'string'
    adminUserName: 'string'
    allowRdpAccess: bool
    applicationTypeVersionsCleanupPolicy: {
      maxUnusedVersionsToKeep: int
    }
    azureActiveDirectory: {
      clientApplication: 'string'
      clusterApplication: 'string'
      tenantId: 'string'
    }
    clientConnectionPort: int
    clients: [
      {
        commonName: 'string'
        isAdmin: bool
        issuerThumbprint: 'string'
        thumbprint: 'string'
      }
    ]
    clusterCodeVersion: 'string'
    clusterUpgradeCadence: 'string'
    clusterUpgradeMode: 'string'
    dnsName: 'string'
    enableAutoOSUpgrade: bool
    fabricSettings: [
      {
        name: 'string'
        parameters: [
          {
            name: 'string'
            value: 'string'
          }
        ]
      }
    ]
    httpGatewayConnectionPort: int
    loadBalancingRules: [
      {
        backendPort: int
        frontendPort: int
        probePort: int
        probeProtocol: 'string'
        probeRequestPath: 'string'
        protocol: 'string'
      }
    ]
    networkSecurityRules: [
      {
        access: 'string'
        description: 'string'
        destinationAddressPrefixes: [
          'string'
        ]
        destinationPortRanges: [
          'string'
        ]
        direction: 'string'
        name: 'string'
        priority: int
        protocol: 'string'
        sourceAddressPrefixes: [
          'string'
        ]
        sourcePortRanges: [
          'string'
        ]
      }
    ]
    zonalResiliency: bool
  }
}

属性值

managedClusters

名称 说明 值
name 资源名称 字符串 (必需)
location Azure 资源位置。 字符串 (必需)
标记 Azure 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 托管群集的 SKU Sku
properties 托管群集资源属性 ManagedClusterProperties

ManagedClusterProperties

名称 说明 值
addonFeatures 要对群集启用的附加功能的列表。 包含任意项的字符串数组：
“BackupRestoreService”
“DnsService”
“ResourceMonitorService”
adminPassword VM 管理员用户密码。 字符串

约束：
敏感值。 作为安全参数传入。
adminUserName VM 管理员用户名。 字符串 (必需)
allowRdpAccess 将此设置为 true 可启用对 VM 的 RDP 访问。 默认 NSG 规则将打开 RDP 到 Internet 的端口，可以使用自定义网络安全规则重写该端口。 此设置的默认值为 false。 bool
applicationTypeVersionsCleanupPolicy 用于清理未使用版本的策略。 ApplicationTypeVersionsCleanupPolicy
azureActiveDirectory 群集的 AAD 身份验证设置。 AzureActiveDirectory
clientConnectionPort 用于客户端连接到群集的端口。 int
客户端 允许管理群集的客户端证书。 ClientCertificate[]
clusterCodeVersion 群集的 Service Fabric 运行时版本。 当 clusterUpgradeMode 设置为“Manual”时，此属性是必需的。 若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。 若要获取现有群集的可用版本列表，请使用 availableClusterVersions。 字符串
clusterUpgradeCadence 指示在发布新的群集运行时版本升级后何时应用这些升级。 默认情况下为 Wave0。 仅当 clusterUpgradeMode 设置为“Automatic”时适用。 “Wave0”
“Wave1”
“Wave2”
clusterUpgradeMode 新的 Service Fabric 运行时版本可用时群集的升级模式。 “自动”
“手动”
dnsName 群集 dns 名称。 字符串 (必需)
enableAutoOSUpgrade 将此项设置为 true 可为使用版本“latest”的任何平台 OS 映像创建的节点类型启用自动 OS 升级。 此设置的默认值为 false。 bool
fabricSettings 用于配置群集的自定义结构设置列表。 SettingsSectionDescription[]
httpGatewayConnectionPort 用于与群集建立 HTTP 连接的端口。 int
loadBalancingRules 应用于群集的公共负载均衡器的负载均衡规则。 LoadBalancingRule[]
networkSecurityRules 应用于群集虚拟网络的自定义网络安全规则。 NetworkSecurityRule[]
zonalResiliency 指示群集是否具有区域复原能力。 bool

ApplicationTypeVersionsCleanupPolicy

名称 说明 值
maxUnusedVersionsToKeep 要保留的每个应用程序类型未使用的版本数。 int (必需)

约束：
最小值 = 0

AzureActiveDirectory

名称 说明 值
clientApplication Azure Active Directory 客户端应用程序 ID。 字符串
clusterApplication Azure Active directory 群集应用程序 ID。 字符串
tenantId Azure Active Directory 租户 ID。 字符串

ClientCertificate

名称 说明 值
CommonName 证书公用名。 字符串
isAdmin 指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能对群集执行只读操作。 bool (必需)
issuerThumbprint 证书的颁发者指纹。 仅与 CommonName 一起使用。 字符串
thumbprint 证书指纹。 字符串

SettingsSectionDescription

名称 说明 值
name 构造设置的节名称。 字符串 (必需)
parameters 节中的参数集合。 SettingsParameterDescription[] (必需的)

SettingsParameterDescription

名称 说明 值
name 构造设置的参数名称。 字符串 (必需)
value 构造设置的参数值。 字符串 (必需)

LoadBalancingRule

名称 说明 值
backendPort 用于在终结点上建立内部连接的端口。 可接受的值介于 1 和 65535 之间。 int (必需)

约束：
最小值 = 1
最大值 = 65534
frontendPort 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值介于 1 和 65534 之间。 int (必需)

约束：
最小值 = 1
最大值 = 65534
probePort 负载均衡规则使用的探测端口。 可接受的值介于 1 和 65535 之间。 int

约束：
最小值 = 1
最大值 = 65534
probeProtocol 对负载均衡规则使用的负载均衡器探测的引用。 'http'
'https'
“tcp” (必需)
probeRequestPath 探测请求路径。 仅支持 HTTP/HTTPS 探测。 字符串
protocol 对负载均衡规则使用的传输协议的引用。 'tcp'
需要“udp” ()

NetworkSecurityRule

名称 说明 值
access 允许或拒绝网络流量。 'allow'
需要“拒绝” ()
description 网络安全规则说明。 字符串
destinationAddressPrefixes 目标地址前缀。 CIDR 或目标 IP 范围。 string[]
destinationPortRanges 目标端口范围。 string[]
direction 网络安全规则方向。 'inbound'
需要“出站” ()
name 网络安全规则名称。 字符串 (必需)
priority 规则的优先级。 该值的范围可以是 1000 到 3000。 超出此范围的值是为 Service Fabric ManagerCluster 资源提供程序保留的。 对于集合中的每个规则，优先级编号必须是唯一的。 优先级编号越低，规则优先级越高。 int (必需)

约束：
最小值 = 1000
最大值 = 3000
protocol 此规则应用到的网络协议。 'ah'
'esp'
'http'
'https'
'icmp'
'tcp'
需要“udp” ()
sourceAddressPrefixes CIDR 或源 IP 范围。 string[]
sourcePortRanges 源端口范围。 string[]

SKU

名称 说明 值
name SKU 名称。 'Basic'
需要“标准” ()

ARM 模板资源定义

可以使用面向以下操作部署 managedClusters 资源类型：

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

资源格式

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

{
  "type": "Microsoft.ServiceFabric/managedClusters",
  "apiVersion": "2021-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "properties": {
    "addonFeatures": [ "string" ],
    "adminPassword": "string",
    "adminUserName": "string",
    "allowRdpAccess": "bool",
    "applicationTypeVersionsCleanupPolicy": {
      "maxUnusedVersionsToKeep": "int"
    },
    "azureActiveDirectory": {
      "clientApplication": "string",
      "clusterApplication": "string",
      "tenantId": "string"
    },
    "clientConnectionPort": "int",
    "clients": [
      {
        "commonName": "string",
        "isAdmin": "bool",
        "issuerThumbprint": "string",
        "thumbprint": "string"
      }
    ],
    "clusterCodeVersion": "string",
    "clusterUpgradeCadence": "string",
    "clusterUpgradeMode": "string",
    "dnsName": "string",
    "enableAutoOSUpgrade": "bool",
    "fabricSettings": [
      {
        "name": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "httpGatewayConnectionPort": "int",
    "loadBalancingRules": [
      {
        "backendPort": "int",
        "frontendPort": "int",
        "probePort": "int",
        "probeProtocol": "string",
        "probeRequestPath": "string",
        "protocol": "string"
      }
    ],
    "networkSecurityRules": [
      {
        "access": "string",
        "description": "string",
        "destinationAddressPrefixes": [ "string" ],
        "destinationPortRanges": [ "string" ],
        "direction": "string",
        "name": "string",
        "priority": "int",
        "protocol": "string",
        "sourceAddressPrefixes": [ "string" ],
        "sourcePortRanges": [ "string" ]
      }
    ],
    "zonalResiliency": "bool"
  }
}

属性值

managedClusters

名称 说明 Value
type 资源类型 'Microsoft.ServiceFabric/managedClusters'
apiVersion 资源 API 版本 '2021-05-01'
name 资源名称 字符串 (必需)
location Azure 资源位置。 字符串 (必需)
标记 Azure 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 托管群集的 SKU Sku
properties 托管群集资源属性 ManagedClusterProperties

ManagedClusterProperties

名称 说明 值
addonFeatures 要对群集启用的附加功能列表。 包含任何一项的字符串数组：
'BackupRestoreService'
'DnsService'
“ResourceMonitorService”
adminPassword VM 管理员用户密码。 字符串

约束：
敏感值。 作为安全参数传入。
adminUserName VM 管理员用户名。 字符串 (必需)
allowRdpAccess 将其设置为 true 可启用对 VM 的 RDP 访问。 默认 NSG 规则打开可连接到 Internet 的 RDP 端口，可以使用自定义网络安全规则重写该端口。 此设置的默认值为 false。 bool
applicationTypeVersionsCleanupPolicy 用于清理未使用版本的策略。 ApplicationTypeVersionsCleanupPolicy
azureActiveDirectory 群集的 AAD 身份验证设置。 AzureActiveDirectory
clientConnectionPort 用于客户端连接到群集的端口。 int
客户端 允许管理群集的客户端证书。 ClientCertificate[]
clusterCodeVersion 群集的 Service Fabric 运行时版本。 当 clusterUpgradeMode 设置为“Manual”时，此属性是必需的。 若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。 若要获取现有群集的可用版本列表，请使用 availableClusterVersions。 字符串
clusterUpgradeCadence 指示发布新的群集运行时版本升级后何时应用这些升级。 默认情况下为 Wave0。 仅当 clusterUpgradeMode 设置为“Automatic”时适用。 “Wave0”
“Wave1”
“Wave2”
clusterUpgradeMode 新的 Service Fabric 运行时版本可用时群集的升级模式。 'Automatic'
“Manual”
dnsName 群集 DNS 名称。 字符串 (必需)
enableAutoOSUpgrade 将此项设置为 true 可为使用版本“latest”的任何平台 OS 映像创建的节点类型启用自动 OS 升级。 此设置的默认值为 false。 bool
fabricSettings 用于配置群集的自定义结构设置的列表。 SettingsSectionDescription[]
httpGatewayConnectionPort 用于与群集建立 HTTP 连接的端口。 int
loadBalancingRules 应用于群集的公共负载均衡器的负载均衡规则。 LoadBalancingRule[]
networkSecurityRules 应用于群集虚拟网络的自定义网络安全规则。 NetworkSecurityRule[]
zonalResiliency 指示群集是否具有区域复原能力。 bool

ApplicationTypeVersionsCleanupPolicy

名称 说明 值
maxUnusedVersionsToKeep 要保留的每个应用程序类型未使用的版本数。 int (必需)

约束：
最小值 = 0

AzureActiveDirectory

名称 说明 值
clientApplication Azure Active Directory 客户端应用程序 ID。 字符串
clusterApplication Azure Active directory 群集应用程序 ID。 字符串
tenantId Azure Active Directory 租户 ID。 字符串

ClientCertificate

名称 说明 值
CommonName 证书公用名。 字符串
isAdmin 指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能对群集执行只读操作。 bool (必需)
issuerThumbprint 证书的颁发者指纹。 仅与 CommonName 一起使用。 字符串
thumbprint 证书指纹。 字符串

SettingsSectionDescription

名称 说明 值
name 构造设置的节名称。 字符串 (必需)
parameters 节中的参数集合。 SettingsParameterDescription[] (必需的)

SettingsParameterDescription

名称 说明 值
name 构造设置的参数名称。 字符串 (必需)
value 构造设置的参数值。 字符串 (必需)

LoadBalancingRule

名称 说明 值
backendPort 用于在终结点上建立内部连接的端口。 可接受的值介于 1 和 65535 之间。 int (必需)

约束：
最小值 = 1
最大值 = 65534
frontendPort 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值介于 1 和 65534 之间。 int (必需)

约束：
最小值 = 1
最大值 = 65534
probePort 负载均衡规则使用的 prob 端口。 可接受的值介于 1 和 65535 之间。 int

约束：
最小值 = 1
最大值 = 65534
probeProtocol 对负载均衡规则使用的负载均衡器探测的引用。 'http'
'https'
“tcp” (必需)
probeRequestPath 探测请求路径。 仅 HTTP/HTTPS 探测支持。 字符串
protocol 对负载均衡规则使用的传输协议的引用。 “tcp”
“udp” (必需)

NetworkSecurityRule

名称 说明 值
access 允许或拒绝网络流量。 “allow”
“deny” (必需)
description 网络安全规则说明。 字符串
destinationAddressPrefixes 目标地址前缀。 CIDR 或目标 IP 范围。 string[]
destinationPortRanges 目标端口范围。 string[]
direction 网络安全规则方向。 'inbound'
需要“出站” ()
name 网络安全规则名称。 字符串 (必需)
priority 规则的优先级。 该值的范围可以是 1000 到 3000。 超出此范围的值是为 Service Fabric ManagerCluster 资源提供程序保留的。 对于集合中的每个规则，优先级编号必须是唯一的。 优先级编号越低，规则优先级越高。 int (必需)

约束：
最小值 = 1000
最大值 = 3000
protocol 此规则应用到的网络协议。 'ah'
'esp'
'http'
'https'
'icmp'
'tcp'
需要“udp” ()
sourceAddressPrefixes CIDR 或源 IP 范围。 string[]
sourcePortRanges 源端口范围。 string[]

SKU

名称 说明 值
name SKU 名称。 'Basic'
需要“标准” ()

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

可以使用面向以下操作部署 managedClusters 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceFabric/managedClusters@2021-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      addonFeatures = [
        "string"
      ]
      adminPassword = "string"
      adminUserName = "string"
      allowRdpAccess = bool
      applicationTypeVersionsCleanupPolicy = {
        maxUnusedVersionsToKeep = int
      }
      azureActiveDirectory = {
        clientApplication = "string"
        clusterApplication = "string"
        tenantId = "string"
      }
      clientConnectionPort = int
      clients = [
        {
          commonName = "string"
          isAdmin = bool
          issuerThumbprint = "string"
          thumbprint = "string"
        }
      ]
      clusterCodeVersion = "string"
      clusterUpgradeCadence = "string"
      clusterUpgradeMode = "string"
      dnsName = "string"
      enableAutoOSUpgrade = bool
      fabricSettings = [
        {
          name = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
        }
      ]
      httpGatewayConnectionPort = int
      loadBalancingRules = [
        {
          backendPort = int
          frontendPort = int
          probePort = int
          probeProtocol = "string"
          probeRequestPath = "string"
          protocol = "string"
        }
      ]
      networkSecurityRules = [
        {
          access = "string"
          description = "string"
          destinationAddressPrefixes = [
            "string"
          ]
          destinationPortRanges = [
            "string"
          ]
          direction = "string"
          name = "string"
          priority = int
          protocol = "string"
          sourceAddressPrefixes = [
            "string"
          ]
          sourcePortRanges = [
            "string"
          ]
        }
      ]
      zonalResiliency = bool
    }
    sku = {
      name = "string"
    }
  })
}

属性值

managedClusters

名称 说明 Value
type 资源类型 “Microsoft.ServiceFabric/managedClusters@2021-05-01”
name 资源名称 字符串 (必需)
location Azure 资源位置。 字符串 (必需)
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 Azure 资源标记。 标记名称和值的字典。
sku 托管群集的 SKU Sku
properties 托管群集资源属性 ManagedClusterProperties

ManagedClusterProperties

名称 说明 值
addonFeatures 要对群集启用的附加功能列表。 包含任何一项的字符串数组：
“BackupRestoreService”
“DnsService”
“ResourceMonitorService”
adminPassword VM 管理员用户密码。 字符串

约束：
敏感值。 作为安全参数传入。
adminUserName VM 管理员用户名。 字符串 (必需)
allowRdpAccess 将其设置为 true 可启用对 VM 的 RDP 访问。 默认 NSG 规则打开可连接到 Internet 的 RDP 端口，可以使用自定义网络安全规则重写该端口。 此设置的默认值为 false。 bool
applicationTypeVersionsCleanupPolicy 用于清理未使用版本的策略。 ApplicationTypeVersionsCleanupPolicy
azureActiveDirectory 群集的 AAD 身份验证设置。 AzureActiveDirectory
clientConnectionPort 用于客户端连接到群集的端口。 int
客户端 允许管理群集的客户端证书。 ClientCertificate[]
clusterCodeVersion 群集的 Service Fabric 运行时版本。 当 clusterUpgradeMode 设置为“Manual”时，此属性是必需的。 若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。 若要获取现有群集的可用版本列表，请使用 availableClusterVersions。 字符串
clusterUpgradeCadence 指示在发布新的群集运行时版本升级后何时应用这些升级。 默认情况下为 Wave0。 仅当 clusterUpgradeMode 设置为“Automatic”时适用。 “Wave0”
“Wave1”
“Wave2”
clusterUpgradeMode 新的 Service Fabric 运行时版本可用时群集的升级模式。 “自动”
“手动”
dnsName 群集 dns 名称。 字符串 (必需)
enableAutoOSUpgrade 将此项设置为 true 可为使用版本“latest”的任何平台 OS 映像创建的节点类型启用自动 OS 升级。 此设置的默认值为 false。 bool
fabricSettings 用于配置群集的自定义结构设置列表。 SettingsSectionDescription[]
httpGatewayConnectionPort 用于与群集建立 HTTP 连接的端口。 int
loadBalancingRules 应用于群集的公共负载均衡器的负载均衡规则。 LoadBalancingRule[]
networkSecurityRules 应用于群集虚拟网络的自定义网络安全规则。 NetworkSecurityRule[]
zonalResiliency 指示群集是否具有区域复原能力。 bool

ApplicationTypeVersionsCleanupPolicy

名称 说明 值
maxUnusedVersionsToKeep 要保留的每个应用程序类型未使用的版本数。 int (必需)

约束：
最小值 = 0

AzureActiveDirectory

名称 说明 值
clientApplication Azure Active Directory 客户端应用程序 ID。 字符串
clusterApplication Azure Active directory 群集应用程序 ID。 字符串
tenantId Azure Active Directory 租户 ID。 字符串

ClientCertificate

名称 说明 值
CommonName 证书公用名。 字符串
isAdmin 指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能对群集执行只读操作。 bool (必需)
issuerThumbprint 证书的颁发者指纹。 仅与 CommonName 一起使用。 字符串
thumbprint 证书指纹。 字符串

SettingsSectionDescription

名称 说明 值
name 构造设置的节名称。 字符串 (必需)
parameters 节中的参数集合。 SettingsParameterDescription[] (必需的)

SettingsParameterDescription

名称 说明 值
name 构造设置的参数名称。 字符串 (必需)
value 构造设置的参数值。 字符串 (必需)

LoadBalancingRule

名称 说明 值
backendPort 用于在终结点上建立内部连接的端口。 可接受的值介于 1 和 65535 之间。 int (必需)

约束：
最小值 = 1
最大值 = 65534
frontendPort 外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值介于 1 和 65534 之间。 int (必需)

约束：
最小值 = 1
最大值 = 65534
probePort 负载均衡规则使用的 prob 端口。 可接受的值介于 1 和 65535 之间。 int

约束：
最小值 = 1
最大值 = 65534
probeProtocol 对负载均衡规则使用的负载均衡器探测的引用。 "http"
"https"
“tcp” (必需)
probeRequestPath 探测请求路径。 仅 HTTP/HTTPS 探测支持。 字符串
protocol 对负载均衡规则使用的传输协议的引用。 “tcp”
“udp” (必需)

NetworkSecurityRule

名称 说明 值
access 允许或拒绝网络流量。 “allow”
“拒绝” (必需)
description 网络安全规则说明。 字符串
destinationAddressPrefixes 目标地址前缀。 CIDR 或目标 IP 范围。 string[]
destinationPortRanges 目标端口范围。 string[]
direction 网络安全规则方向。 “inbound”
“出站” (必需)
name 网络安全规则名称。 字符串 (必需)
priority 规则的优先级。 该值的范围可以是 1000 到 3000。 超出此范围的值是为 Service Fabric ManagerCluster 资源提供程序保留的。 集合中每个规则的优先级编号必须是唯一的。 优先级编号越低，规则优先级越高。 int (必需)

约束：
最小值 = 1000
最大值 = 3000
protocol 此规则应用到的网络协议。 “啊”
“esp”
"http"
"https"
“icmp”
“tcp”
“udp” (必需)
sourceAddressPrefixes CIDR 或源 IP 范围。 string[]
sourcePortRanges 源端口范围。 string[]

SKU

名称 说明 值
name Sku 名称。 "Basic"
“标准” (必需)