Microsoft. KubernetesConfigurations fluxConfigurations 01-11-2022

Article
07/20/2023

Définition de ressource Bicep

Le type de ressource fluxConfigurations est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans Bicep.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer un Microsoft. Ressource KubernetesConfiguration/fluxConfigurations, ajoutez le Bicep suivant à votre modèle.

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
  }
}

Valeurs de propriétés

fluxConfigurations

Nom	Description	Valeur
name	Nom de la ressource	chaîne (obligatoire)
scope	Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue du déploiement.	Ressource cible Pour Bicep, définissez cette propriété sur le nom symbolique de la ressource pour appliquer la ressource d’extension.
properties	Propriétés permettant de créer une ressource Flux Configuration	FluxConfigurationProperties

FluxConfigurationProperties

Nom	Description	Valeur
azureBlob	Paramètres à rapprocher avec le type de type source AzureBlob.	AzureBlobDefinition
Compartiment	Paramètres à rapprocher avec le type de type source compartiment.	BucketDefinition
configurationProtectedSettings	Paires clé-valeur des paramètres de configuration protégés pour la configuration	object
gitRepository	Paramètres à rapprocher du type de source GitRepository.	GitRepositoryDefinition
Kustomizations	Tableau de kustomizations utilisées pour rapprocher l’artefact extrait par le type source sur le cluster.	object
espace de noms	Espace de noms sur lequel cette configuration est installée. Maximum de 253 caractères alphanumériques minuscules, trait d’union et point uniquement.	string
scope	Étendue à laquelle l’opérateur sera installé.	'cluster' 'namespace'
sourceKind	Type de source à partir duquel extraire les données de configuration.	'AzureBlob' 'Compartiment' 'GitRepository'
suspendre	Si cette configuration doit suspendre son rapprochement de ses kustomisations et sources.	bool

AzureBlobDefinition

Nom	Description	Valeur
accountKey	Clé de compte (clé partagée) pour accéder au compte de stockage	string
containerName	Nom du conteneur d’objets blob Azure à synchroniser à partir du point de terminaison d’URL pour la configuration du flux.	string
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
managedIdentity	Paramètres d’authentification à l’aide d’une identité managée.	ManagedIdentityDefinition
sasToken	Jeton d’accès partagé pour accéder au conteneur de stockage	string
servicePrincipal	Paramètres pour l’authentification à l’aide du principal de service.	ServicePrincipalDefinition
syncIntervalInSeconds	Intervalle auquel réconcilier la source d’objets blob Azure du cluster avec la source distante.	int
timeoutInSeconds	Durée maximale de tentative de rapprochement de la source d’objets blob Azure de cluster avec la source distante.	int
url	URL à synchroniser pour le compte de stockage Blob Azure de configuration de flux.	string

ManagedIdentityDefinition

Nom	Description	Valeur
clientId	ID client pour l’authentification d’une identité managée.	string

ServicePrincipalDefinition

Nom	Description	Valeur
clientCertificate	Certificat encodé en base64 utilisé pour authentifier un principal de service	string
clientCertificatePassword	Mot de passe du certificat utilisé pour authentifier un principal de service	string
clientCertificateSendChain	Spécifie s’il faut inclure l’en-tête x5c dans les revendications clientes lors de l’acquisition d’un jeton pour activer l’authentification basée sur le nom de l’objet/l’émetteur pour le certificat client	bool
clientId	ID client pour l’authentification d’un principal de service.	string
clientSecret	Clé secrète client pour l’authentification d’un principal de service	string
tenantId	ID de locataire pour l’authentification d’un principal de service	string

BucketDefinition

Nom	Description	Valeur
accessKey	Clé d’accès en texte clair utilisée pour accéder en toute sécurité au compartiment S3	string
bucketName	Nom du compartiment à synchroniser à partir du point de terminaison d’URL pour la configuration du flux.	string
Insécurité	Spécifiez s’il faut utiliser une communication non sécurisée lors de la pulsation de données à partir du compartiment S3.	bool
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
syncIntervalInSeconds	Intervalle auquel réconcilier la source de compartiment de cluster avec la source distante.	int
timeoutInSeconds	Durée maximale de tentative de rapprochement de la source du compartiment de cluster avec la source distante.	int
url	URL à synchroniser pour le compartiment S3 de configuration de flux.	string

GitRepositoryDefinition

Nom	Description	Valeur
httpsCACert	Contenu de l’autorité de certification HTTPS encodé en base64 utilisé pour accéder aux dépôts Git privés Git via HTTPS	string
httpsUser	Nom d’utilisateur HTTPS en clair utilisé pour accéder aux dépôts Git privés via HTTPS	string
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
repositoryRef	Référence source pour l’objet GitRepository.	RepositoryRefDefinition
sshKnownHosts	Valeur de known_hosts encodée en base64 contenant des clés SSH publiques requises pour accéder aux dépôts Git privés via SSH	string
syncIntervalInSeconds	Intervalle auquel réconcilier la source de dépôt git du cluster avec le distant.	int
timeoutInSeconds	Durée maximale de tentative de rapprochement de la source de dépôt git de cluster avec la source distante.	int
url	URL à synchroniser pour le dépôt git de configuration de flux.	string

RepositoryRefDefinition

Nom	Description	Valeur
branche	Nom de la branche du référentiel git à extraire.	string
validation	Sha de validation à l’extraction. Cette valeur doit être combinée avec le nom de la branche pour être valide. Cela est prioritaire sur semver.	string
semver	Plage semver utilisée pour faire la correspondance avec les balises de dépôt git. Cela est prioritaire sur la balise.	string
étiquette	Nom de la balise de dépôt git à extraire. Cela est prioritaire sur la branche.	string

Définition de ressources de modèle ARM

Le type de ressource fluxConfigurations est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans les modèles ARM.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer un Microsoft. Ressource KubernetesConfiguration/fluxConfigurations, ajoutez le code JSON suivant à votre modèle.

{
  "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"
  }
}

Valeurs de propriétés

fluxConfigurations

Nom	Description	Valeur
type	Type de ressource	'Microsoft. KubernetesConfiguration/fluxConfigurations'
apiVersion	Version de l’API de ressource	'2022-11-01'
name	Nom de la ressource	chaîne (obligatoire)
scope	Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue du déploiement.	Ressource cible Pour JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension .
properties	Propriétés permettant de créer une ressource Flux Configuration	FluxConfigurationProperties

FluxConfigurationProperties

Nom	Description	Valeur
azureBlob	Paramètres à rapprocher avec le type de type source AzureBlob.	AzureBlobDefinition
Compartiment	Paramètres à rapprocher avec le type de type source compartiment.	BucketDefinition
configurationProtectedSettings	Paires clé-valeur des paramètres de configuration protégés pour la configuration	object
gitRepository	Paramètres à rapprocher du type de source GitRepository.	GitRepositoryDefinition
Kustomizations	Tableau de kustomizations utilisées pour rapprocher l’artefact extrait par le type source sur le cluster.	object
espace de noms	Espace de noms sur lequel cette configuration est installée. Maximum de 253 caractères alphanumériques minuscules, trait d’union et point uniquement.	string
scope	Étendue à laquelle l’opérateur sera installé.	'cluster' 'namespace'
sourceKind	Type de source à partir duquel extraire les données de configuration.	'AzureBlob' 'Compartiment' 'GitRepository'
suspendre	Si cette configuration doit suspendre son rapprochement de ses kustomisations et sources.	bool

AzureBlobDefinition

Nom	Description	Valeur
accountKey	Clé de compte (clé partagée) pour accéder au compte de stockage	string
containerName	Nom du conteneur d’objets blob Azure à synchroniser à partir du point de terminaison d’URL pour la configuration du flux.	string
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
managedIdentity	Paramètres d’authentification à l’aide d’une identité managée.	ManagedIdentityDefinition
sasToken	Jeton d’accès partagé pour accéder au conteneur de stockage	string
servicePrincipal	Paramètres pour l’authentification à l’aide du principal de service.	ServicePrincipalDefinition
syncIntervalInSeconds	Intervalle auquel réconcilier la source d’objets blob Azure du cluster avec la source distante.	int
timeoutInSeconds	Durée maximale de tentative de rapprochement de la source d’objets blob Azure de cluster avec la source distante.	int
url	URL à synchroniser pour le compte de stockage Blob Azure de configuration de flux.	string

ManagedIdentityDefinition

Nom	Description	Valeur
clientId	ID client pour l’authentification d’une identité managée.	string

ServicePrincipalDefinition

Nom	Description	Valeur
clientCertificate	Certificat encodé en base64 utilisé pour authentifier un principal de service	string
clientCertificatePassword	Mot de passe du certificat utilisé pour authentifier un principal de service	string
clientCertificateSendChain	Spécifie s’il faut inclure l’en-tête x5c dans les revendications clientes lors de l’acquisition d’un jeton pour activer l’authentification basée sur le nom de l’objet/l’émetteur pour le certificat client	bool
clientId	ID client pour l’authentification d’un principal de service.	string
clientSecret	Clé secrète client pour l’authentification d’un principal de service	string
tenantId	ID de locataire pour l’authentification d’un principal de service	string

BucketDefinition

Nom	Description	Valeur
accessKey	Clé d’accès en texte clair utilisée pour accéder en toute sécurité au compartiment S3	string
bucketName	Nom du compartiment à synchroniser à partir du point de terminaison d’URL pour la configuration du flux.	string
Insécurité	Spécifiez s’il faut utiliser une communication non sécurisée lors de la pulsation de données à partir du compartiment S3.	bool
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
syncIntervalInSeconds	Intervalle auquel réconcilier la source de compartiment de cluster avec la source distante.	int
timeoutInSeconds	Durée maximale de tentative de rapprochement de la source du compartiment de cluster avec la source distante.	int
url	URL à synchroniser pour le compartiment S3 de configuration de flux.	string

GitRepositoryDefinition

Nom	Description	Valeur
httpsCACert	Contenu de l’autorité de certification HTTPS encodé en base64 utilisé pour accéder aux dépôts Git privés Git via HTTPS	string
httpsUser	Nom d’utilisateur HTTPS en clair utilisé pour accéder aux dépôts Git privés via HTTPS	string
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
repositoryRef	Référence source pour l’objet GitRepository.	RepositoryRefDefinition
sshKnownHosts	Valeur de known_hosts encodée en base64 contenant des clés SSH publiques requises pour accéder aux dépôts Git privés via SSH	string
syncIntervalInSeconds	Intervalle auquel réconcilier la source de dépôt git du cluster avec le distant.	int
timeoutInSeconds	Durée maximale de tentative de rapprochement de la source de dépôt git de cluster avec la source distante.	int
url	URL à synchroniser pour le dépôt git de configuration de flux.	string

RepositoryRefDefinition

Nom	Description	Valeur
branche	Nom de la branche du référentiel git à extraire.	string
validation	Sha de validation à l’extraction. Cette valeur doit être combinée avec le nom de la branche pour être valide. Cela est prioritaire sur semver.	string
semver	Plage semver utilisée pour faire la correspondance avec les balises de dépôt git. Cela est prioritaire sur la balise.	string
étiquette	Nom de la balise de dépôt git à extraire. Cela est prioritaire sur la branche.	string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource fluxConfigurations est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la parent_id propriété sur cette ressource pour définir l’étendue de cette ressource.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer un Microsoft. Ressource KubernetesConfiguration/fluxConfigurations, ajoutez le Terraform suivant à votre modèle.

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
    }
  })
}

Valeurs de propriétés

fluxConfigurations

Nom	Description	Valeur
type	Type de ressource	« Microsoft. KubernetesConfiguration/fluxConfigurations@2022-11-01 »
name	Nom de la ressource	string (obligatoire)
parent_id	ID de la ressource à laquelle appliquer cette ressource d’extension.	string (obligatoire)
properties	Propriétés permettant de créer une ressource de configuration de flux	FluxConfigurationProperties

FluxConfigurationProperties

Nom	Description	Valeur
azureBlob	Paramètres à rapprocher avec le type de type de source AzureBlob.	AzureBlobDefinition
Compartiment	Paramètres à rapprocher du type de source bucket.	BucketDefinition
configurationProtectedSettings	Paires clé-valeur de paramètres de configuration protégés pour la configuration	object
gitRepository	Paramètres à rapprocher du type de source GitRepository.	GitRepositoryDefinition
Kustomizations	Tableau de kustomisations utilisées pour rapprocher l’artefact extrait par type de source sur le cluster.	object
espace de noms	Espace de noms sur lequel cette configuration est installée. Maximum de 253 caractères alphanumériques minuscules, trait d’union et point uniquement.	string
scope	Étendue au niveau de laquelle l’opérateur sera installé.	« cluster » "espace de noms"
sourceKind	Type de source à partir duquel extraire les données de configuration.	« AzureBlob » « Bucket » « GitRepository »
suspendre	Indique si cette configuration doit suspendre son rapprochement de ses kustomisations et sources.	bool

AzureBlobDefinition

Nom	Description	Valeur
accountKey	Clé de compte (clé partagée) pour accéder au compte de stockage	string
containerName	Nom du conteneur d’objets blob Azure à synchroniser à partir du point de terminaison d’URL pour la configuration du flux.	string
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
managedIdentity	Paramètres pour l’authentification à l’aide d’une identité managée.	ManagedIdentityDefinition
sasToken	Jeton d’accès partagé permettant d’accéder au conteneur de stockage	string
servicePrincipal	Paramètres pour l’authentification à l’aide du principal de service.	ServicePrincipalDefinition
syncIntervalInSeconds	Intervalle auquel rapprocher à nouveau la source d’objets blob Azure du cluster avec le distant.	int
timeoutInSeconds	Durée maximale pour tenter de rapprocher la source d’objets blob Azure du cluster avec le distant.	int
url	URL à synchroniser pour le compte de stockage Blob Azure de configuration de flux.	string

ManagedIdentityDefinition

Nom	Description	Valeur
clientId	ID client pour l’authentification d’une identité managée.	string

ServicePrincipalDefinition

Nom	Description	Valeur
clientCertificate	Certificat encodé en base64 utilisé pour authentifier un principal de service	string
clientCertificatePassword	Mot de passe du certificat utilisé pour authentifier un principal de service	string
clientCertificateSendChain	Spécifie s’il faut inclure l’en-tête x5c dans les revendications du client lors de l’acquisition d’un jeton pour activer l’authentification basée sur le nom de l’objet/l’émetteur pour le certificat client	bool
clientId	ID client pour l’authentification d’un principal de service.	string
clientSecret	Clé secrète client pour l’authentification d’un principal de service	string
tenantId	ID de locataire pour l’authentification d’un principal de service	string

BucketDefinition

Nom	Description	Valeur
accessKey	Clé d’accès en texte clair utilisée pour accéder en toute sécurité au compartiment S3	string
bucketName	Nom du compartiment à synchroniser à partir du point de terminaison d’URL pour la configuration du flux.	string
Insécurité	Spécifiez s’il faut utiliser une communication non sécurisée lors de la pulsation de données à partir du compartiment S3.	bool
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
syncIntervalInSeconds	Intervalle auquel rapprocher à nouveau la source du compartiment de cluster avec le distant.	int
timeoutInSeconds	Durée maximale pour tenter de rapprocher la source du compartiment de cluster avec le distant.	int
url	URL à synchroniser pour le compartiment S3 de configuration de flux.	string

GitRepositoryDefinition

Nom	Description	Valeur
httpsCACert	Contenu de l’autorité de certification HTTPS encodé en base64 utilisé pour accéder aux dépôts Git privés Git via HTTPS	string
httpsUser	Nom d’utilisateur HTTPS en texte clair utilisé pour accéder aux dépôts Git privés via HTTPS	string
localAuthRef	Nom d’un secret local sur le cluster Kubernetes à utiliser comme secret d’authentification plutôt que les secrets de configuration gérés ou fournis par l’utilisateur.	string
repositoryRef	Référence source pour l’objet GitRepository.	RepositoryRefDefinition
sshKnownHosts	Valeur de known_hosts encodée en base64 contenant les clés SSH publiques requises pour accéder aux dépôts Git privés via SSH	string
syncIntervalInSeconds	Intervalle auquel rapprocher à nouveau la source du dépôt Git du cluster avec le distant.	int
timeoutInSeconds	Durée maximale pour tenter de rapprocher la source du dépôt Git de cluster avec le distant.	int
url	URL à synchroniser pour le dépôt Git de configuration de flux.	string

RepositoryRefDefinition

Nom	Description	Valeur
branche	Nom de la branche du dépôt Git à extraire.	string
validation	Sha de validation à l’extraction. Cette valeur doit être combinée avec le nom de la branche pour être valide. Cela a la priorité sur semver.	string
semver	Plage semver utilisée pour correspondre aux balises de dépôt Git. Cela est prioritaire sur la balise.	string
étiquette	Nom de balise du dépôt Git à extraire. Cela est prioritaire sur la branche.	string

Partager via

Microsoft. KubernetesConfigurations fluxConfigurations 01-11-2022

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

fluxConfigurations

FluxConfigurationProperties

AzureBlobDefinition

ManagedIdentityDefinition

ServicePrincipalDefinition

BucketDefinition

GitRepositoryDefinition

RepositoryRefDefinition

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

fluxConfigurations

FluxConfigurationProperties

AzureBlobDefinition

ManagedIdentityDefinition

ServicePrincipalDefinition

BucketDefinition

GitRepositoryDefinition

RepositoryRefDefinition

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

fluxConfigurations

FluxConfigurationProperties

AzureBlobDefinition

ManagedIdentityDefinition

ServicePrincipalDefinition

BucketDefinition

GitRepositoryDefinition

RepositoryRefDefinition

Commentaires

Ressources supplémentaires