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

Microsoft。KubernetesConfiguration fluxConfigurations

Bicep 资源定义

fluxConfigurations 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 Bicep 中设置扩展资源的范围

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

资源格式

创建Microsoft。KubernetesConfiguration/fluxConfigurations 资源,将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.KubernetesConfiguration/fluxConfigurations@2022-11-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    azureBlob: {
      accountKey: 'string'
      containerName: 'string'
      localAuthRef: 'string'
      managedIdentity: {
        clientId: 'string'
      }
      sasToken: 'string'
      servicePrincipal: {
        clientCertificate: 'string'
        clientCertificatePassword: 'string'
        clientCertificateSendChain: bool
        clientId: 'string'
        clientSecret: 'string'
        tenantId: 'string'
      }
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    bucket: {
      accessKey: 'string'
      bucketName: 'string'
      insecure: bool
      localAuthRef: 'string'
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    configurationProtectedSettings: {}
    gitRepository: {
      httpsCACert: 'string'
      httpsUser: 'string'
      localAuthRef: 'string'
      repositoryRef: {
        branch: 'string'
        commit: 'string'
        semver: 'string'
        tag: 'string'
      }
      sshKnownHosts: 'string'
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    kustomizations: {}
    namespace: 'string'
    scope: 'string'
    sourceKind: 'string'
    suspend: bool
  }
}

属性值

fluxConfigurations

名称 说明 Value
name 资源名称 字符串 (必需)
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 Bicep,请将此属性设置为要应用 扩展资源的符号名称。
properties 用于创建 Flux 配置资源的属性 FluxConfigurationProperties

FluxConfigurationProperties

名称 说明
azureBlob 用于与 AzureBlob 源类型协调的参数。 AzureBlobDefinition
Bucket 用于与 Bucket 源类型协调的参数。 BucketDefinition
configurationProtectedSettings 配置的受保护配置设置的键值对 对象
gitRepository 用于与 GitRepository 源类型协调的参数。 GitRepositoryDefinition
kustomizations 用于协调群集上源类型拉取的项目的自定义数组。 对象
命名空间 此配置安装到的命名空间。 最多 253 个小写字母数字字符、连字符和句点。 字符串
scope 将安装运算符的范围。 “cluster”
“namespace”
sourceKind 要从中拉取配置数据的源类型。 “AzureBlob”
“Bucket”
'GitRepository'
挂起 此配置是否应暂停其自定义和源的对帐。 bool

AzureBlobDefinition

名称 说明
accountKey 帐户密钥 (用于访问存储帐户的共享密钥) 字符串
containerName 要从 flux 配置的 URL 终结点同步的 Azure Blob 容器名称。 字符串
localAuthRef Kubernetes 群集上用作身份验证机密而不是托管或用户提供的配置机密的本地机密的名称。 字符串
managedIdentity 使用托管标识进行身份验证的参数。 ManagedIdentityDefinition
sasToken 用于访问存储容器的共享访问令牌 字符串
servicePrincipal 使用服务主体进行身份验证的参数。 ServicePrincipalDefinition
syncIntervalInSeconds 重新协调群集 Azure Blob 源与远程的时间间隔。 int
timeoutInSeconds 尝试将群集 Azure Blob 源与远程进行协调的最长时间。 int
url 要同步 Flux 配置 Azure Blob 存储帐户的 URL。 字符串

ManagedIdentityDefinition

名称 说明 Value
clientId 用于对托管标识进行身份验证的客户端 ID。 字符串

ServicePrincipalDefinition

名称 说明
clientCertificate 用于对服务主体进行身份验证的 Base64 编码证书 字符串
clientCertificatePassword 用于对服务主体进行身份验证的证书的密码 字符串
clientCertificateSendChain 指定在获取令牌时是否在客户端声明中包括 x5c 标头,以便为客户端证书启用基于使用者名称/颁发者的身份验证 bool
clientId 用于对服务主体进行身份验证的客户端 ID。 字符串
clientSecret 用于对服务主体进行身份验证的客户端密码 字符串
tenantId 用于对服务主体进行身份验证的租户 ID 字符串

BucketDefinition

名称 说明 Value
accessKey 用于安全访问 S3 存储桶的纯文本访问密钥 字符串
bucketName 要从 flux 配置的 URL 终结点同步的存储桶名称。 字符串
不安 指定在从 S3 存储桶中打出数据时是否使用不安全的通信。 bool
localAuthRef Kubernetes 群集上要用作身份验证机密的本地机密的名称,而不是托管或用户提供的配置机密。 字符串
syncIntervalInSeconds 重新协调群集存储桶源与远程的间隔。 int
timeoutInSeconds 尝试将群集存储桶源与远程进行协调的最长时间。 int
url 要同步的 flux 配置 S3 存储桶的 URL。 字符串

GitRepositoryDefinition

名称 说明
httpsCACert 用于通过 HTTPS 访问 git 专用 git 存储库的 Base64 编码 HTTPS 证书颁发机构内容 字符串
httpsUser 用于通过 HTTPS 访问专用 Git 存储库的纯文本 HTTPS 用户名 字符串
localAuthRef Kubernetes 群集上要用作身份验证机密的本地机密的名称,而不是托管或用户提供的配置机密。 字符串
repositoryRef GitRepository 对象的源引用。 RepositoryRefDefinition
sshKnownHosts Base64 编码known_hosts值,其中包含通过 SSH 访问专用 git 存储库所需的公共 SSH 密钥 字符串
syncIntervalInSeconds 重新协调群集 git 存储库源与远程的间隔。 int
timeoutInSeconds 尝试将群集 git 存储库源与远程进行协调的最长时间。 int
url 要同步的 flux 配置 git 存储库的 URL。 字符串

RepositoryRefDefinition

名称 说明
branch 要签出的 git 存储库分支名称。 字符串
提交 (commit) 提交 SHA 以签出。 此值必须与分支名称结合使用才能有效。 这优先于 semver。 字符串
semver 用于与 git 存储库标记匹配的 semver 范围。 这优先于标记。 字符串
标记 要签出的 git 存储库标记名称。 这优先于分支。 字符串

ARM 模板资源定义

fluxConfigurations 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 ARM 模板中设置扩展资源的范围

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

资源格式

创建Microsoft。KubernetesConfiguration/fluxConfigurations 资源,将以下 JSON 添加到模板。

{
  "type": "Microsoft.KubernetesConfiguration/fluxConfigurations",
  "apiVersion": "2022-11-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "azureBlob": {
      "accountKey": "string",
      "containerName": "string",
      "localAuthRef": "string",
      "managedIdentity": {
        "clientId": "string"
      },
      "sasToken": "string",
      "servicePrincipal": {
        "clientCertificate": "string",
        "clientCertificatePassword": "string",
        "clientCertificateSendChain": "bool",
        "clientId": "string",
        "clientSecret": "string",
        "tenantId": "string"
      },
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "bucket": {
      "accessKey": "string",
      "bucketName": "string",
      "insecure": "bool",
      "localAuthRef": "string",
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "configurationProtectedSettings": {},
    "gitRepository": {
      "httpsCACert": "string",
      "httpsUser": "string",
      "localAuthRef": "string",
      "repositoryRef": {
        "branch": "string",
        "commit": "string",
        "semver": "string",
        "tag": "string"
      },
      "sshKnownHosts": "string",
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "kustomizations": {},
    "namespace": "string",
    "scope": "string",
    "sourceKind": "string",
    "suspend": "bool"
  }
}

属性值

fluxConfigurations

名称 说明 Value
type 资源类型 'Microsoft.KubernetesConfiguration/fluxConfigurations'
apiVersion 资源 API 版本 '2022-11-01'
name 资源名称 字符串 (必需)
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 JSON,请将值设置为要向其应用 扩展资源的资源 的全名。
properties 用于创建 Flux 配置资源的属性 FluxConfigurationProperties

FluxConfigurationProperties

名称 说明
azureBlob 用于与 AzureBlob 源类型协调的参数。 AzureBlobDefinition
Bucket 用于与 Bucket 源类型协调的参数。 BucketDefinition
configurationProtectedSettings 配置的受保护配置设置的键值对 对象
gitRepository 用于与 GitRepository 源类型协调的参数。 GitRepositoryDefinition
kustomizations 用于协调群集上源类型拉取的项目的自定义数组。 对象
命名空间 此配置安装到的命名空间。 最多 253 个小写字母数字字符、连字符和句点。 字符串
scope 将安装运算符的范围。 “cluster”
“namespace”
sourceKind 要从中拉取配置数据的源类型。 “AzureBlob”
“Bucket”
'GitRepository'
挂起 此配置是否应暂停其自定义和源的对帐。 bool

AzureBlobDefinition

名称 说明
accountKey 帐户密钥 (用于访问存储帐户的共享密钥) 字符串
containerName 要从 flux 配置的 URL 终结点同步的 Azure Blob 容器名称。 字符串
localAuthRef Kubernetes 群集上用作身份验证机密而不是托管或用户提供的配置机密的本地机密的名称。 字符串
managedIdentity 使用托管标识进行身份验证的参数。 ManagedIdentityDefinition
sasToken 用于访问存储容器的共享访问令牌 字符串
servicePrincipal 使用服务主体进行身份验证的参数。 ServicePrincipalDefinition
syncIntervalInSeconds 重新协调群集 Azure Blob 源与远程的时间间隔。 int
timeoutInSeconds 尝试将群集 Azure Blob 源与远程进行协调的最长时间。 int
url 要同步 Flux 配置 Azure Blob 存储帐户的 URL。 字符串

ManagedIdentityDefinition

名称 说明
clientId 用于对托管标识进行身份验证的客户端 ID。 字符串

ServicePrincipalDefinition

名称 说明
clientCertificate 用于对服务主体进行身份验证的 Base64 编码证书 字符串
clientCertificatePassword 用于对服务主体进行身份验证的证书的密码 字符串
clientCertificateSendChain 指定在获取令牌时是否在客户端声明中包括 x5c 标头,以便为客户端证书启用基于使用者名称/颁发者的身份验证 bool
clientId 用于对服务主体进行身份验证的客户端 ID。 字符串
clientSecret 用于对服务主体进行身份验证的客户端密码 字符串
tenantId 用于对服务主体进行身份验证的租户 ID 字符串

BucketDefinition

名称 说明
accessKey 用于安全访问 S3 存储桶的纯文本访问密钥 字符串
bucketName 要从 flux 配置的 URL 终结点同步的存储桶名称。 字符串
不安 指定在从 S3 存储桶中打出数据时是否使用不安全的通信。 bool
localAuthRef Kubernetes 群集上用作身份验证机密而不是托管或用户提供的配置机密的本地机密的名称。 字符串
syncIntervalInSeconds 重新协调群集存储桶源与远程的间隔。 int
timeoutInSeconds 尝试将群集存储桶源与远程进行协调的最长时间。 int
url 要同步 Flux 配置 S3 存储桶的 URL。 字符串

GitRepositoryDefinition

名称 说明
httpsCACert 用于通过 HTTPS 访问 git 专用 git 存储库的 Base64 编码 HTTPS 证书颁发机构内容 字符串
httpsUser 用于通过 HTTPS 访问专用 git 存储库的纯文本 HTTPS 用户名 字符串
localAuthRef Kubernetes 群集上用作身份验证机密而不是托管或用户提供的配置机密的本地机密的名称。 字符串
repositoryRef GitRepository 对象的源引用。 RepositoryRefDefinition
sshKnownHosts Base64 编码known_hosts值,其中包含通过 SSH 访问专用 git 存储库所需的公共 SSH 密钥 字符串
syncIntervalInSeconds 重新协调群集 git 存储库源与远程的时间间隔。 int
timeoutInSeconds 尝试将群集 git 存储库源与远程进行协调的最长时间。 int
url 要同步的 flux 配置 git 存储库的 URL。 字符串

RepositoryRefDefinition

名称 说明
branch 要签出的 git 存储库分支名称。 字符串
提交 (commit) 要签出的提交 SHA。 此值必须与分支名称结合使用才能有效。 这优先于 semver。 字符串
semver 用于与 git 存储库标记匹配的 semver 范围。 这优先于 标记。 字符串
标记 要签出的 git 存储库标记名称。 这优先于分支。 字符串

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

fluxConfigurations 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

parent_id使用此资源上的 属性可设置此资源的作用域。

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

资源格式

创建Microsoft。KubernetesConfiguration/fluxConfigurations 资源,将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KubernetesConfiguration/fluxConfigurations@2022-11-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      azureBlob = {
        accountKey = "string"
        containerName = "string"
        localAuthRef = "string"
        managedIdentity = {
          clientId = "string"
        }
        sasToken = "string"
        servicePrincipal = {
          clientCertificate = "string"
          clientCertificatePassword = "string"
          clientCertificateSendChain = bool
          clientId = "string"
          clientSecret = "string"
          tenantId = "string"
        }
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      bucket = {
        accessKey = "string"
        bucketName = "string"
        insecure = bool
        localAuthRef = "string"
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      configurationProtectedSettings = {}
      gitRepository = {
        httpsCACert = "string"
        httpsUser = "string"
        localAuthRef = "string"
        repositoryRef = {
          branch = "string"
          commit = "string"
          semver = "string"
          tag = "string"
        }
        sshKnownHosts = "string"
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      kustomizations = {}
      namespace = "string"
      scope = "string"
      sourceKind = "string"
      suspend = bool
    }
  })
}

属性值

fluxConfigurations

名称 说明 Value
type 资源类型 “Microsoft。KubernetesConfiguration/fluxConfigurations@2022-11-01”
name 资源名称 字符串 (必需)
parent_id 要应用此扩展资源的资源的 ID。 字符串 (必需)
properties 用于创建 Flux 配置资源的属性 FluxConfigurationProperties

FluxConfigurationProperties

名称 说明
azureBlob 用于与 AzureBlob 源类型协调的参数。 AzureBlobDefinition
Bucket 用于与 Bucket 源类型协调的参数。 BucketDefinition
configurationProtectedSettings 配置的受保护配置设置的键值对 对象
gitRepository 用于与 GitRepository 源类型协调的参数。 GitRepositoryDefinition
kustomizations 用于协调群集上源类型拉取的项目的自定义数组。 对象
命名空间 此配置安装到的命名空间。 最多 253 个小写字母数字字符、连字符和句点。 字符串
scope 将安装运算符的范围。 “cluster”
"命名空间"
sourceKind 要从中拉取配置数据的源类型。 “AzureBlob”
“Bucket”
“GitRepository”
挂起 此配置是否应暂停其自定义和源的对帐。 bool

AzureBlobDefinition

名称 说明
accountKey 帐户密钥 (用于访问存储帐户的共享密钥) 字符串
containerName 要从 flux 配置的 URL 终结点同步的 Azure Blob 容器名称。 字符串
localAuthRef Kubernetes 群集上用作身份验证机密而不是托管或用户提供的配置机密的本地机密的名称。 字符串
managedIdentity 使用托管标识进行身份验证的参数。 ManagedIdentityDefinition
sasToken 用于访问存储容器的共享访问令牌 字符串
servicePrincipal 使用服务主体进行身份验证的参数。 ServicePrincipalDefinition
syncIntervalInSeconds 重新协调群集 Azure Blob 源与远程的时间间隔。 int
timeoutInSeconds 尝试将群集 Azure Blob 源与远程进行协调的最长时间。 int
url 要同步 Flux 配置 Azure Blob 存储帐户的 URL。 字符串

ManagedIdentityDefinition

名称 说明 Value
clientId 用于对托管标识进行身份验证的客户端 ID。 字符串

ServicePrincipalDefinition

名称 说明 Value
clientCertificate 用于对服务主体进行身份验证的 Base64 编码证书 字符串
clientCertificatePassword 用于对服务主体进行身份验证的证书的密码 字符串
clientCertificateSendChain 指定在获取令牌时是否在客户端声明中包括 x5c 标头,以便为客户端证书启用基于使用者名称/颁发者的身份验证 bool
clientId 用于对服务主体进行身份验证的客户端 ID。 字符串
clientSecret 用于对服务主体进行身份验证的客户端密码 字符串
tenantId 用于对服务主体进行身份验证的租户 ID 字符串

BucketDefinition

名称 说明
accessKey 用于安全访问 S3 存储桶的纯文本访问密钥 字符串
bucketName 要从 flux 配置的 URL 终结点同步的存储桶名称。 字符串
不安 指定在从 S3 存储桶中打出数据时是否使用不安全的通信。 bool
localAuthRef Kubernetes 群集上要用作身份验证机密的本地机密的名称,而不是托管或用户提供的配置机密。 字符串
syncIntervalInSeconds 重新协调群集存储桶源与远程的间隔。 int
timeoutInSeconds 尝试将群集存储桶源与远程进行协调的最长时间。 int
url 要同步的 flux 配置 S3 存储桶的 URL。 字符串

GitRepositoryDefinition

名称 说明
httpsCACert 用于通过 HTTPS 访问 git 专用 git 存储库的 Base64 编码 HTTPS 证书颁发机构内容 字符串
httpsUser 用于通过 HTTPS 访问专用 Git 存储库的纯文本 HTTPS 用户名 字符串
localAuthRef Kubernetes 群集上要用作身份验证机密的本地机密的名称,而不是托管或用户提供的配置机密。 字符串
repositoryRef GitRepository 对象的源引用。 RepositoryRefDefinition
sshKnownHosts Base64 编码known_hosts值,其中包含通过 SSH 访问专用 git 存储库所需的公共 SSH 密钥 字符串
syncIntervalInSeconds 重新协调群集 git 存储库源与远程的间隔。 int
timeoutInSeconds 尝试将群集 git 存储库源与远程进行协调的最长时间。 int
url 要同步的 flux 配置 git 存储库的 URL。 字符串

RepositoryRefDefinition

名称 说明
branch 要签出的 git 存储库分支名称。 字符串
提交 (commit) 提交 SHA 以签出。 此值必须与分支名称结合使用才能有效。 这优先于 semver。 字符串
semver 用于与 git 存储库标记匹配的 semver 范围。 这优先于标记。 字符串
标记 要签出的 git 存储库标记名称。 这优先于分支。 字符串