kubernetesconfiguration.azure.com/v1api20230501

Package v1api20230501 contains API Schema definitions for the kubernetesconfiguration v1api20230501 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2023-05-01"

AzureBlobDefinition

(Appears on:FluxConfiguration_Spec)

Parameters to reconcile to the AzureBlob source kind type.

Field	Description
`accountKey` genruntime.SecretReference	AccountKey: The account key (shared key) to access the storage account
`containerName` string	ContainerName: The Azure Blob container name to sync from the url endpoint for the flux configuration.
`localAuthRef` string	LocalAuthRef: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets.
`managedIdentity` ManagedIdentityDefinition	ManagedIdentity: Parameters to authenticate using a Managed Identity.
`sasToken` genruntime.SecretReference	SasToken: The Shared Access token to access the storage container
`servicePrincipal` ServicePrincipalDefinition	ServicePrincipal: Parameters to authenticate using Service Principal.
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the cluster Azure Blob source with the remote.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the cluster Azure Blob source with the remote.
`url` string	Url: The URL to sync for the flux configuration Azure Blob storage account.

AzureBlobDefinition_STATUS

(Appears on:FluxConfiguration_STATUS)

Parameters to reconcile to the AzureBlob source kind type.

Field	Description
`containerName` string	ContainerName: The Azure Blob container name to sync from the url endpoint for the flux configuration.
`localAuthRef` string	LocalAuthRef: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets.
`managedIdentity` ManagedIdentityDefinition_STATUS	ManagedIdentity: Parameters to authenticate using a Managed Identity.
`servicePrincipal` ServicePrincipalDefinition_STATUS	ServicePrincipal: Parameters to authenticate using Service Principal.
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the cluster Azure Blob source with the remote.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the cluster Azure Blob source with the remote.
`url` string	Url: The URL to sync for the flux configuration Azure Blob storage account.

BucketDefinition

(Appears on:FluxConfiguration_Spec)

Parameters to reconcile to the Bucket source kind type.

Field	Description
`accessKey` genruntime.SecretReference	AccessKey: Plaintext access key used to securely access the S3 bucket
`bucketName` string	BucketName: The bucket name to sync from the url endpoint for the flux configuration.
`insecure` bool	Insecure: Specify whether to use insecure communication when puling data from the S3 bucket.
`localAuthRef` string	LocalAuthRef: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets.
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the cluster bucket source with the remote.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the cluster bucket source with the remote.
`url` string	Url: The URL to sync for the flux configuration S3 bucket.

BucketDefinition_STATUS

(Appears on:FluxConfiguration_STATUS)

Parameters to reconcile to the Bucket source kind type.

Field	Description
`bucketName` string	BucketName: The bucket name to sync from the url endpoint for the flux configuration.
`insecure` bool	Insecure: Specify whether to use insecure communication when puling data from the S3 bucket.
`localAuthRef` string	LocalAuthRef: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets.
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the cluster bucket source with the remote.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the cluster bucket source with the remote.
`url` string	Url: The URL to sync for the flux configuration S3 bucket.

ErrorAdditionalInfo_STATUS

(Appears on:ErrorDetail_STATUS, ErrorDetail_STATUS_Unrolled)

The resource management error additional info.

Field	Description
`info` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Info: The additional info.
`type` string	Type: The additional info type.

ErrorDetail_STATUS

(Appears on:Extension_STATUS)

The error detail.

Field	Description
`additionalInfo` []ErrorAdditionalInfo_STATUS	AdditionalInfo: The error additional info.
`code` string	Code: The error code.
`details` []ErrorDetail_STATUS_Unrolled	Details: The error details.
`message` string	Message: The error message.
`target` string	Target: The error target.

ErrorDetail_STATUS_Unrolled

(Appears on:ErrorDetail_STATUS)

Field	Description
`additionalInfo` []ErrorAdditionalInfo_STATUS	AdditionalInfo: The error additional info.
`code` string	Code: The error code.
`message` string	Message: The error message.
`target` string	Target: The error target.

Extension

Generator information: - Generated from: /kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Extension_Spec

`aksAssignedIdentity` Extension_Properties_AksAssignedIdentity_Spec	AksAssignedIdentity: Identity of the Extension resource in an AKS cluster
`autoUpgradeMinorVersion` bool	AutoUpgradeMinorVersion: Flag to note if this extension participates in auto upgrade of minor version, or not.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`configurationProtectedSettings` genruntime.SecretMapReference	ConfigurationProtectedSettings: Configuration settings that are sensitive, as name-value pairs for configuring this extension.
`configurationSettings` map[string]string	ConfigurationSettings: Configuration settings, as name-value pairs for configuring this extension.
`extensionType` string	ExtensionType: Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.
`identity` Identity	Identity: Identity of the Extension resource
`operatorSpec` ExtensionOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.ArbitraryOwnerReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner.
`plan` Plan	Plan: The plan information.
`releaseTrain` string	ReleaseTrain: ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ‘true’.
`scope` Scope	Scope: Scope at which the extension is installed.
`systemData` SystemData	SystemData: Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
`version` string	Version: User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’.

status
Extension_STATUS

ExtensionOperatorConfigMaps

(Appears on:ExtensionOperatorSpec)

Field	Description
`principalId` genruntime.ConfigMapDestination	PrincipalId: indicates where the PrincipalId config map should be placed. If omitted, no config map will be created.

ExtensionOperatorSpec

(Appears on:Extension_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`configMaps` ExtensionOperatorConfigMaps	ConfigMaps: configures where to place operator written ConfigMaps.
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

ExtensionStatus_Level_STATUS (`string` alias)

(Appears on:ExtensionStatus_STATUS)

Value	Description
"Error"
"Information"
"Warning"

ExtensionStatus_STATUS

(Appears on:Extension_STATUS)

Status from the extension.

Field	Description
`code` string	Code: Status code provided by the Extension
`displayStatus` string	DisplayStatus: Short description of status of the extension.
`level` ExtensionStatus_Level_STATUS	Level: Level of the status.
`message` string	Message: Detailed message of the status from the Extension.
`time` string	Time: DateLiteral (per ISO8601) noting the time of installation status.

Extension_Properties_AksAssignedIdentity_STATUS

(Appears on:Extension_STATUS)

Field	Description
`principalId` string	PrincipalId: The principal ID of resource identity.
`tenantId` string	TenantId: The tenant ID of resource.
`type` Extension_Properties_AksAssignedIdentity_Type_STATUS	Type: The identity type.

Extension_Properties_AksAssignedIdentity_Spec

(Appears on:Extension_Spec)

Field	Description
`type` Extension_Properties_AksAssignedIdentity_Type_Spec	Type: The identity type.

Extension_Properties_AksAssignedIdentity_Type_STATUS (`string` alias)

(Appears on:Extension_Properties_AksAssignedIdentity_STATUS)

Value	Description
"SystemAssigned"
"UserAssigned"

Extension_Properties_AksAssignedIdentity_Type_Spec (`string` alias)

(Appears on:Extension_Properties_AksAssignedIdentity_Spec)

Value	Description
"SystemAssigned"
"UserAssigned"

Extension_STATUS

(Appears on:Extension)

The Extension object.

Field	Description
`aksAssignedIdentity` Extension_Properties_AksAssignedIdentity_STATUS	AksAssignedIdentity: Identity of the Extension resource in an AKS cluster
`autoUpgradeMinorVersion` bool	AutoUpgradeMinorVersion: Flag to note if this extension participates in auto upgrade of minor version, or not.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`configurationProtectedSettings` map[string]string	ConfigurationProtectedSettings: Configuration settings that are sensitive, as name-value pairs for configuring this extension.
`configurationSettings` map[string]string	ConfigurationSettings: Configuration settings, as name-value pairs for configuring this extension.
`currentVersion` string	CurrentVersion: Currently installed version of the extension.
`customLocationSettings` map[string]string	CustomLocationSettings: Custom Location settings properties.
`errorInfo` ErrorDetail_STATUS	ErrorInfo: Error information from the Agent - e.g. errors during installation.
`extensionType` string	ExtensionType: Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` Identity_STATUS	Identity: Identity of the Extension resource
`isSystemExtension` bool	IsSystemExtension: Flag to note if this extension is a system extension
`name` string	Name: The name of the resource
`packageUri` string	PackageUri: Uri of the Helm package
`plan` Plan_STATUS	Plan: The plan information.
`provisioningState` ProvisioningStateDefinition_STATUS	ProvisioningState: Status of installation of this extension.
`releaseTrain` string	ReleaseTrain: ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ‘true’.
`scope` Scope_STATUS	Scope: Scope at which the extension is installed.
`statuses` []ExtensionStatus_STATUS	Statuses: Status from this extension.
`systemData` SystemData_STATUS	SystemData: Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`version` string	Version: User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’.

Extension_Spec

(Appears on:Extension)

Field	Description
`aksAssignedIdentity` Extension_Properties_AksAssignedIdentity_Spec	AksAssignedIdentity: Identity of the Extension resource in an AKS cluster
`autoUpgradeMinorVersion` bool	AutoUpgradeMinorVersion: Flag to note if this extension participates in auto upgrade of minor version, or not.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`configurationProtectedSettings` genruntime.SecretMapReference	ConfigurationProtectedSettings: Configuration settings that are sensitive, as name-value pairs for configuring this extension.
`configurationSettings` map[string]string	ConfigurationSettings: Configuration settings, as name-value pairs for configuring this extension.
`extensionType` string	ExtensionType: Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.
`identity` Identity	Identity: Identity of the Extension resource
`operatorSpec` ExtensionOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.ArbitraryOwnerReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner.
`plan` Plan	Plan: The plan information.
`releaseTrain` string	ReleaseTrain: ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ‘true’.
`scope` Scope	Scope: Scope at which the extension is installed.
`systemData` SystemData	SystemData: Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
`version` string	Version: User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’.

FluxComplianceStateDefinition_STATUS (`string` alias)

(Appears on:FluxConfiguration_STATUS, ObjectStatusDefinition_STATUS)

Compliance state of the cluster object.

Value	Description
"Compliant"
"Non-Compliant"
"Pending"
"Suspended"
"Unknown"

FluxConfiguration

Generator information: - Generated from: /kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/fluxConfigurations/{fluxConfigurationName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
FluxConfiguration_Spec

`azureBlob` AzureBlobDefinition	AzureBlob: Parameters to reconcile to the AzureBlob source kind type.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`bucket` BucketDefinition	Bucket: Parameters to reconcile to the Bucket source kind type.
`configurationProtectedSettings` genruntime.SecretMapReference	ConfigurationProtectedSettings: Key-value pairs of protected configuration settings for the configuration
`gitRepository` GitRepositoryDefinition	GitRepository: Parameters to reconcile to the GitRepository source kind type.
`kustomizations` map[string]./api/kubernetesconfiguration/v1api20230501.KustomizationDefinition	Kustomizations: Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.
`namespace` string	Namespace: The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only.
`operatorSpec` FluxConfigurationOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.ArbitraryOwnerReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner.
`reconciliationWaitDuration` string	ReconciliationWaitDuration: Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D
`scope` ScopeDefinition	Scope: Scope at which the operator will be installed.
`sourceKind` SourceKindDefinition	SourceKind: Source Kind to pull the configuration data from.
`suspend` bool	Suspend: Whether this configuration should suspend its reconciliation of its kustomizations and sources.
`waitForReconciliation` bool	WaitForReconciliation: Whether flux configuration deployment should wait for cluster to reconcile the kustomizations.

status
FluxConfiguration_STATUS

FluxConfigurationOperatorSpec

(Appears on:FluxConfiguration_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

FluxConfiguration_STATUS

(Appears on:FluxConfiguration)

The Flux Configuration object returned in Get & Put response.

Field	Description
`azureBlob` AzureBlobDefinition_STATUS	AzureBlob: Parameters to reconcile to the AzureBlob source kind type.
`bucket` BucketDefinition_STATUS	Bucket: Parameters to reconcile to the Bucket source kind type.
`complianceState` FluxComplianceStateDefinition_STATUS	ComplianceState: Combined status of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`configurationProtectedSettings` map[string]string	ConfigurationProtectedSettings: Key-value pairs of protected configuration settings for the configuration
`errorMessage` string	ErrorMessage: Error message returned to the user in the case of provisioning failure.
`gitRepository` GitRepositoryDefinition_STATUS	GitRepository: Parameters to reconcile to the GitRepository source kind type.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`kustomizations` map[string]./api/kubernetesconfiguration/v1api20230501.KustomizationDefinition_STATUS	Kustomizations: Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.
`name` string	Name: The name of the resource
`namespace` string	Namespace: The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only.
`provisioningState` ProvisioningStateDefinition_STATUS	ProvisioningState: Status of the creation of the fluxConfiguration.
`reconciliationWaitDuration` string	ReconciliationWaitDuration: Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D
`repositoryPublicKey` string	RepositoryPublicKey: Public Key associated with this fluxConfiguration (either generated within the cluster or provided by the user).
`scope` ScopeDefinition_STATUS	Scope: Scope at which the operator will be installed.
`sourceKind` SourceKindDefinition_STATUS	SourceKind: Source Kind to pull the configuration data from.
`sourceSyncedCommitId` string	SourceSyncedCommitId: Branch and/or SHA of the source commit synced with the cluster.
`sourceUpdatedAt` string	SourceUpdatedAt: Datetime the fluxConfiguration synced its source on the cluster.
`statusUpdatedAt` string	StatusUpdatedAt: Datetime the fluxConfiguration synced its status on the cluster with Azure.
`statuses` []ObjectStatusDefinition_STATUS	Statuses: Statuses of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects provisioned by the fluxConfiguration.
`suspend` bool	Suspend: Whether this configuration should suspend its reconciliation of its kustomizations and sources.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`waitForReconciliation` bool	WaitForReconciliation: Whether flux configuration deployment should wait for cluster to reconcile the kustomizations.

FluxConfiguration_Spec

(Appears on:FluxConfiguration)

Field	Description
`azureBlob` AzureBlobDefinition	AzureBlob: Parameters to reconcile to the AzureBlob source kind type.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`bucket` BucketDefinition	Bucket: Parameters to reconcile to the Bucket source kind type.
`configurationProtectedSettings` genruntime.SecretMapReference	ConfigurationProtectedSettings: Key-value pairs of protected configuration settings for the configuration
`gitRepository` GitRepositoryDefinition	GitRepository: Parameters to reconcile to the GitRepository source kind type.
`kustomizations` map[string]./api/kubernetesconfiguration/v1api20230501.KustomizationDefinition	Kustomizations: Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.
`namespace` string	Namespace: The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only.
`operatorSpec` FluxConfigurationOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.ArbitraryOwnerReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. This resource is an extension resource, which means that any other Azure resource can be its owner.
`reconciliationWaitDuration` string	ReconciliationWaitDuration: Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D
`scope` ScopeDefinition	Scope: Scope at which the operator will be installed.
`sourceKind` SourceKindDefinition	SourceKind: Source Kind to pull the configuration data from.
`suspend` bool	Suspend: Whether this configuration should suspend its reconciliation of its kustomizations and sources.
`waitForReconciliation` bool	WaitForReconciliation: Whether flux configuration deployment should wait for cluster to reconcile the kustomizations.

GitRepositoryDefinition

(Appears on:FluxConfiguration_Spec)

Parameters to reconcile to the GitRepository source kind type.

Field	Description
`httpsCACert` genruntime.SecretReference	HttpsCACert: Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS
`httpsUser` string	HttpsUser: Plaintext HTTPS username used to access private git repositories over HTTPS
`localAuthRef` string	LocalAuthRef: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets.
`repositoryRef` RepositoryRefDefinition	RepositoryRef: The source reference for the GitRepository object.
`sshKnownHosts` string	SshKnownHosts: Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the cluster git repository source with the remote.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the cluster git repository source with the remote.
`url` string	Url: The URL to sync for the flux configuration git repository.

GitRepositoryDefinition_STATUS

(Appears on:FluxConfiguration_STATUS)

Parameters to reconcile to the GitRepository source kind type.

Field	Description
`httpsUser` string	HttpsUser: Plaintext HTTPS username used to access private git repositories over HTTPS
`localAuthRef` string	LocalAuthRef: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets.
`repositoryRef` RepositoryRefDefinition_STATUS	RepositoryRef: The source reference for the GitRepository object.
`sshKnownHosts` string	SshKnownHosts: Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the cluster git repository source with the remote.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the cluster git repository source with the remote.
`url` string	Url: The URL to sync for the flux configuration git repository.

HelmReleasePropertiesDefinition_STATUS

(Appears on:ObjectStatusDefinition_STATUS)

Properties for HelmRelease objects

Field	Description
`failureCount` int	FailureCount: Total number of times that the HelmRelease failed to install or upgrade
`helmChartRef` ObjectReferenceDefinition_STATUS	HelmChartRef: The reference to the HelmChart object used as the source to this HelmRelease
`installFailureCount` int	InstallFailureCount: Number of times that the HelmRelease failed to install
`lastRevisionApplied` int	LastRevisionApplied: The revision number of the last released object change
`upgradeFailureCount` int	UpgradeFailureCount: Number of times that the HelmRelease failed to upgrade

Identity

(Appears on:Extension_Spec)

Identity for the resource.

Field	Description
`type` Identity_Type	Type: The identity type.

Identity_STATUS

(Appears on:Extension_STATUS)

Identity for the resource.

Field	Description
`principalId` string	PrincipalId: The principal ID of resource identity.
`tenantId` string	TenantId: The tenant ID of resource.
`type` Identity_Type_STATUS	Type: The identity type.

Identity_Type (`string` alias)

(Appears on:Identity)

Value	Description
"SystemAssigned"

Identity_Type_STATUS (`string` alias)

(Appears on:Identity_STATUS)

Value	Description
"SystemAssigned"

KustomizationDefinition

(Appears on:FluxConfiguration_Spec)

The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.

Field	Description
`dependsOn` []string	DependsOn: Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies have completed their reconciliation.
`force` bool	Force: Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change.
`path` string	Path: The path in the source reference to reconcile on the cluster.
`postBuild` PostBuildDefinition	PostBuild: Used for variable substitution for this Kustomization after kustomize build.
`prune` bool	Prune: Enable/disable garbage collections of Kubernetes objects created by this Kustomization.
`retryIntervalInSeconds` int	RetryIntervalInSeconds: The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation.
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the Kustomization on the cluster.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the Kustomization on the cluster.
`wait` bool	Wait: Enable/disable health check for all Kubernetes objects created by this Kustomization.

KustomizationDefinition_STATUS

(Appears on:FluxConfiguration_STATUS)

The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.

Field	Description
`dependsOn` []string	DependsOn: Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies have completed their reconciliation.
`force` bool	Force: Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change.
`name` string	Name: Name of the Kustomization, matching the key in the Kustomizations object map.
`path` string	Path: The path in the source reference to reconcile on the cluster.
`postBuild` PostBuildDefinition_STATUS	PostBuild: Used for variable substitution for this Kustomization after kustomize build.
`prune` bool	Prune: Enable/disable garbage collections of Kubernetes objects created by this Kustomization.
`retryIntervalInSeconds` int	RetryIntervalInSeconds: The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation.
`syncIntervalInSeconds` int	SyncIntervalInSeconds: The interval at which to re-reconcile the Kustomization on the cluster.
`timeoutInSeconds` int	TimeoutInSeconds: The maximum time to attempt to reconcile the Kustomization on the cluster.
`wait` bool	Wait: Enable/disable health check for all Kubernetes objects created by this Kustomization.

ManagedIdentityDefinition

(Appears on:AzureBlobDefinition)

Parameters to authenticate using a Managed Identity.

Field	Description
`clientId` string	ClientId: The client Id for authenticating a Managed Identity.

ManagedIdentityDefinition_STATUS

(Appears on:AzureBlobDefinition_STATUS)

Parameters to authenticate using a Managed Identity.

Field	Description
`clientId` string	ClientId: The client Id for authenticating a Managed Identity.

ObjectReferenceDefinition_STATUS

(Appears on:HelmReleasePropertiesDefinition_STATUS, ObjectStatusDefinition_STATUS)

Object reference to a Kubernetes object on a cluster

Field	Description
`name` string	Name: Name of the object
`namespace` string	Namespace: Namespace of the object

ObjectStatusConditionDefinition_STATUS

(Appears on:ObjectStatusDefinition_STATUS)

Status condition of Kubernetes object

Field	Description
`lastTransitionTime` string	LastTransitionTime: Last time this status condition has changed
`message` string	Message: A more verbose description of the object status condition
`reason` string	Reason: Reason for the specified status condition type status
`status` string	Status: Status of the Kubernetes object condition type
`type` string	Type: Object status condition type for this object

ObjectStatusDefinition_STATUS

(Appears on:FluxConfiguration_STATUS)

Statuses of objects deployed by the user-specified kustomizations from the git repository.

Field	Description
`appliedBy` ObjectReferenceDefinition_STATUS	AppliedBy: Object reference to the Kustomization that applied this object
`complianceState` FluxComplianceStateDefinition_STATUS	ComplianceState: Compliance state of the applied object showing whether the applied object has come into a ready state on the cluster.
`helmReleaseProperties` HelmReleasePropertiesDefinition_STATUS	HelmReleaseProperties: Additional properties that are provided from objects of the HelmRelease kind
`kind` string	Kind: Kind of the applied object
`name` string	Name: Name of the applied object
`namespace` string	Namespace: Namespace of the applied object
`statusConditions` []ObjectStatusConditionDefinition_STATUS	StatusConditions: List of Kubernetes object status conditions present on the cluster

Plan

(Appears on:Extension_Spec)

Plan for the resource.

Field	Description
`name` string	Name: A user defined name of the 3rd Party Artifact that is being procured.
`product` string	Product: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
`promotionCode` string	PromotionCode: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
`publisher` string	Publisher: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
`version` string	Version: The version of the desired product/artifact.

Plan_STATUS

(Appears on:Extension_STATUS)

Plan for the resource.

Field	Description
`name` string	Name: A user defined name of the 3rd Party Artifact that is being procured.
`product` string	Product: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
`promotionCode` string	PromotionCode: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
`publisher` string	Publisher: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
`version` string	Version: The version of the desired product/artifact.

PostBuildDefinition

(Appears on:KustomizationDefinition)

The postBuild definitions defining variable substitutions for this Kustomization after kustomize build.

Field	Description
`substitute` map[string]string	Substitute: Key/value pairs holding the variables to be substituted in this Kustomization.
`substituteFrom` []SubstituteFromDefinition	SubstituteFrom: Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.

PostBuildDefinition_STATUS

(Appears on:KustomizationDefinition_STATUS)

The postBuild definitions defining variable substitutions for this Kustomization after kustomize build.

Field	Description
`substitute` map[string]string	Substitute: Key/value pairs holding the variables to be substituted in this Kustomization.
`substituteFrom` []SubstituteFromDefinition_STATUS	SubstituteFrom: Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.

ProvisioningStateDefinition_STATUS (`string` alias)

(Appears on:Extension_STATUS, FluxConfiguration_STATUS)

The provisioning state of the resource.

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"

RepositoryRefDefinition

(Appears on:GitRepositoryDefinition)

The source reference for the GitRepository object.

Field	Description
`branch` string	Branch: The git repository branch name to checkout.
`commit` string	Commit: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver.
`semver` string	Semver: The semver range used to match against git repository tags. This takes precedence over tag.
`tag` string	Tag: The git repository tag name to checkout. This takes precedence over branch.

RepositoryRefDefinition_STATUS

(Appears on:GitRepositoryDefinition_STATUS)

The source reference for the GitRepository object.

Field	Description
`branch` string	Branch: The git repository branch name to checkout.
`commit` string	Commit: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver.
`semver` string	Semver: The semver range used to match against git repository tags. This takes precedence over tag.
`tag` string	Tag: The git repository tag name to checkout. This takes precedence over branch.

Scope

(Appears on:Extension_Spec)

Scope of the extension. It can be either Cluster or Namespace; but not both.

Field	Description
`cluster` ScopeCluster	Cluster: Specifies that the scope of the extension is Cluster
`namespace` ScopeNamespace	Namespace: Specifies that the scope of the extension is Namespace

ScopeCluster

(Appears on:Scope)

Specifies that the scope of the extension is Cluster

Field	Description
`releaseNamespace` string	ReleaseNamespace: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created

ScopeCluster_STATUS

(Appears on:Scope_STATUS)

Specifies that the scope of the extension is Cluster

Field	Description
`releaseNamespace` string	ReleaseNamespace: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created

ScopeDefinition (`string` alias)

(Appears on:FluxConfiguration_Spec)

Scope at which the configuration will be installed.

Value	Description
"cluster"
"namespace"

ScopeDefinition_STATUS (`string` alias)

(Appears on:FluxConfiguration_STATUS)

Scope at which the configuration will be installed.

Value	Description
"cluster"
"namespace"

ScopeNamespace

(Appears on:Scope)

Specifies that the scope of the extension is Namespace

Field	Description
`targetNamespace` string	TargetNamespace: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created

ScopeNamespace_STATUS

(Appears on:Scope_STATUS)

Specifies that the scope of the extension is Namespace

Field	Description
`targetNamespace` string	TargetNamespace: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created

Scope_STATUS

(Appears on:Extension_STATUS)

Scope of the extension. It can be either Cluster or Namespace; but not both.

Field	Description
`cluster` ScopeCluster_STATUS	Cluster: Specifies that the scope of the extension is Cluster
`namespace` ScopeNamespace_STATUS	Namespace: Specifies that the scope of the extension is Namespace

ServicePrincipalDefinition

(Appears on:AzureBlobDefinition)

Parameters to authenticate using Service Principal.

Field	Description
`clientCertificate` genruntime.SecretReference	ClientCertificate: Base64-encoded certificate used to authenticate a Service Principal
`clientCertificatePassword` genruntime.SecretReference	ClientCertificatePassword: The password for the certificate used to authenticate a Service Principal
`clientCertificateSendChain` bool	ClientCertificateSendChain: Specifies whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the Client Certificate
`clientId` string	ClientId: The client Id for authenticating a Service Principal.
`clientIdFromConfig` genruntime.ConfigMapReference	ClientIdFromConfig: The client Id for authenticating a Service Principal.
`clientSecret` genruntime.SecretReference	ClientSecret: The client secret for authenticating a Service Principal
`tenantId` string	TenantId: The tenant Id for authenticating a Service Principal
`tenantIdFromConfig` genruntime.ConfigMapReference	TenantIdFromConfig: The tenant Id for authenticating a Service Principal

ServicePrincipalDefinition_STATUS

(Appears on:AzureBlobDefinition_STATUS)

Parameters to authenticate using Service Principal.

Field	Description
`clientCertificateSendChain` bool	ClientCertificateSendChain: Specifies whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the Client Certificate
`clientId` string	ClientId: The client Id for authenticating a Service Principal.
`tenantId` string	TenantId: The tenant Id for authenticating a Service Principal

SourceKindDefinition (`string` alias)

(Appears on:FluxConfiguration_Spec)

Source Kind to pull the configuration data from.

Value	Description
"AzureBlob"
"Bucket"
"GitRepository"

SourceKindDefinition_STATUS (`string` alias)

(Appears on:FluxConfiguration_STATUS)

Source Kind to pull the configuration data from.

Value	Description
"AzureBlob"
"Bucket"
"GitRepository"

SubstituteFromDefinition

(Appears on:PostBuildDefinition)

Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.

Field	Description
`kind` string	Kind: Define whether it is ConfigMap or Secret that holds the variables to be used in substitution.
`name` string	Name: Name of the ConfigMap/Secret that holds the variables to be used in substitution.
`optional` bool	Optional: Set to True to proceed without ConfigMap/Secret, if it is not present.

SubstituteFromDefinition_STATUS

(Appears on:PostBuildDefinition_STATUS)

Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.

Field	Description
`kind` string	Kind: Define whether it is ConfigMap or Secret that holds the variables to be used in substitution.
`name` string	Name: Name of the ConfigMap/Secret that holds the variables to be used in substitution.
`optional` bool	Optional: Set to True to proceed without ConfigMap/Secret, if it is not present.

SystemData

(Appears on:Extension_Spec)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType	LastModifiedByType: The type of identity that last modified the resource.

SystemData_CreatedByType (`string` alias)

(Appears on:SystemData)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType (`string` alias)

(Appears on:SystemData)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:Extension_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

kubernetesconfiguration.azure.com/v1api20230501