kubernetesconfiguration.azure.com/v1api20230501
APIVersion
| Value | Description |
|---|---|
| “2023-05-01” |
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}
Used by: ExtensionList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Extension_Spec Optional |
|
| status | Extension_STATUS Optional |
Extension_Spec
| Property | Description | Type |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | Extension_Properties_AksAssignedIdentity_Spec Optional |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool Optional |
| 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. | string Optional |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | genruntime.SecretMapReference Optional |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | map[string]string Optional |
| 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. | string Optional |
| identity | Identity of the Extension resource | Identity Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ExtensionOperatorSpec Optional |
| 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. | genruntime.ArbitraryOwnerReference Required |
| plan | The plan information. | Plan Optional |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ’true'. | string Optional |
| scope | Scope at which the extension is installed. | Scope Optional |
| 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 | SystemData Optional |
| version | User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’. | string Optional |
Extension_STATUS
| Property | Description | Type |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | Extension_Properties_AksAssignedIdentity_STATUS Optional |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | map[string]string Optional |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | map[string]string Optional |
| currentVersion | Currently installed version of the extension. | string Optional |
| customLocationSettings | Custom Location settings properties. | map[string]string Optional |
| errorInfo | Error information from the Agent - e.g. errors during installation. | ErrorDetail_STATUS Optional |
| 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. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity of the Extension resource | Identity_STATUS Optional |
| isSystemExtension | Flag to note if this extension is a system extension | bool Optional |
| name | The name of the resource | string Optional |
| packageUri | Uri of the Helm package | string Optional |
| plan | The plan information. | Plan_STATUS Optional |
| provisioningState | Status of installation of this extension. | ProvisioningStateDefinition_STATUS Optional |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ’true’. | string Optional |
| scope | Scope at which the extension is installed. | Scope_STATUS Optional |
| statuses | Status from this extension. | ExtensionStatus_STATUS[] Optional |
| 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 | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| version | User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’. | string Optional |
ExtensionList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Extension[] Optional |
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}
Used by: FluxConfigurationList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | FluxConfiguration_Spec Optional |
|
| status | FluxConfiguration_STATUS Optional |
FluxConfiguration_Spec
| Property | Description | Type |
|---|---|---|
| azureBlob | Parameters to reconcile to the AzureBlob source kind type. | AzureBlobDefinition Optional |
| 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. | string Optional |
| bucket | Parameters to reconcile to the Bucket source kind type. | BucketDefinition Optional |
| configurationProtectedSettings | Key-value pairs of protected configuration settings for the configuration | genruntime.SecretMapReference Optional |
| gitRepository | Parameters to reconcile to the GitRepository source kind type. | GitRepositoryDefinition Optional |
| kustomizations | Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. | map[string]KustomizationDefinition Optional |
| namespace | The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FluxConfigurationOperatorSpec Optional |
| 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. | genruntime.ArbitraryOwnerReference Required |
| reconciliationWaitDuration | Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D | string Optional |
| scope | Scope at which the operator will be installed. | ScopeDefinition Optional |
| sourceKind | Source Kind to pull the configuration data from. | SourceKindDefinition Optional |
| suspend | Whether this configuration should suspend its reconciliation of its kustomizations and sources. | bool Optional |
| waitForReconciliation | Whether flux configuration deployment should wait for cluster to reconcile the kustomizations. | bool Optional |
FluxConfiguration_STATUS
| Property | Description | Type |
|---|---|---|
| azureBlob | Parameters to reconcile to the AzureBlob source kind type. | AzureBlobDefinition_STATUS Optional |
| bucket | Parameters to reconcile to the Bucket source kind type. | BucketDefinition_STATUS Optional |
| complianceState | Combined status of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects. | FluxComplianceStateDefinition_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationProtectedSettings | Key-value pairs of protected configuration settings for the configuration | map[string]string Optional |
| errorMessage | Error message returned to the user in the case of provisioning failure. | string Optional |
| gitRepository | Parameters to reconcile to the GitRepository source kind type. | GitRepositoryDefinition_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| kustomizations | Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. | map[string]KustomizationDefinition_STATUS Optional |
| name | The name of the resource | string Optional |
| namespace | The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string Optional |
| provisioningState | Status of the creation of the fluxConfiguration. | ProvisioningStateDefinition_STATUS Optional |
| reconciliationWaitDuration | Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D | string Optional |
| repositoryPublicKey | Public Key associated with this fluxConfiguration (either generated within the cluster or provided by the user). | string Optional |
| scope | Scope at which the operator will be installed. | ScopeDefinition_STATUS Optional |
| sourceKind | Source Kind to pull the configuration data from. | SourceKindDefinition_STATUS Optional |
| sourceSyncedCommitId | Branch and/or SHA of the source commit synced with the cluster. | string Optional |
| sourceUpdatedAt | Datetime the fluxConfiguration synced its source on the cluster. | string Optional |
| statuses | Statuses of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects provisioned by the fluxConfiguration. | ObjectStatusDefinition_STATUS[] Optional |
| statusUpdatedAt | Datetime the fluxConfiguration synced its status on the cluster with Azure. | string Optional |
| suspend | Whether this configuration should suspend its reconciliation of its kustomizations and sources. | bool Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| waitForReconciliation | Whether flux configuration deployment should wait for cluster to reconcile the kustomizations. | bool Optional |
FluxConfigurationList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | FluxConfiguration[] Optional |
Extension_Spec
Used by: Extension.
| Property | Description | Type |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | Extension_Properties_AksAssignedIdentity_Spec Optional |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool Optional |
| 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. | string Optional |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | genruntime.SecretMapReference Optional |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | map[string]string Optional |
| 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. | string Optional |
| identity | Identity of the Extension resource | Identity Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ExtensionOperatorSpec Optional |
| 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. | genruntime.ArbitraryOwnerReference Required |
| plan | The plan information. | Plan Optional |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ’true’. | string Optional |
| scope | Scope at which the extension is installed. | Scope Optional |
| 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 | SystemData Optional |
| version | User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’. | string Optional |
Extension_STATUS
The Extension object.
Used by: Extension.
| Property | Description | Type |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | Extension_Properties_AksAssignedIdentity_STATUS Optional |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | map[string]string Optional |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | map[string]string Optional |
| currentVersion | Currently installed version of the extension. | string Optional |
| customLocationSettings | Custom Location settings properties. | map[string]string Optional |
| errorInfo | Error information from the Agent - e.g. errors during installation. | ErrorDetail_STATUS Optional |
| 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. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity of the Extension resource | Identity_STATUS Optional |
| isSystemExtension | Flag to note if this extension is a system extension | bool Optional |
| name | The name of the resource | string Optional |
| packageUri | Uri of the Helm package | string Optional |
| plan | The plan information. | Plan_STATUS Optional |
| provisioningState | Status of installation of this extension. | ProvisioningStateDefinition_STATUS Optional |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is ’true’. | string Optional |
| scope | Scope at which the extension is installed. | Scope_STATUS Optional |
| statuses | Status from this extension. | ExtensionStatus_STATUS[] Optional |
| 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 | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| version | User-specified version of the extension for this extension to ‘pin’. To use ‘version’, autoUpgradeMinorVersion must be ‘false’. | string Optional |
FluxConfiguration_Spec
Used by: FluxConfiguration.
| Property | Description | Type |
|---|---|---|
| azureBlob | Parameters to reconcile to the AzureBlob source kind type. | AzureBlobDefinition Optional |
| 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. | string Optional |
| bucket | Parameters to reconcile to the Bucket source kind type. | BucketDefinition Optional |
| configurationProtectedSettings | Key-value pairs of protected configuration settings for the configuration | genruntime.SecretMapReference Optional |
| gitRepository | Parameters to reconcile to the GitRepository source kind type. | GitRepositoryDefinition Optional |
| kustomizations | Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. | map[string]KustomizationDefinition Optional |
| namespace | The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FluxConfigurationOperatorSpec Optional |
| 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. | genruntime.ArbitraryOwnerReference Required |
| reconciliationWaitDuration | Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D | string Optional |
| scope | Scope at which the operator will be installed. | ScopeDefinition Optional |
| sourceKind | Source Kind to pull the configuration data from. | SourceKindDefinition Optional |
| suspend | Whether this configuration should suspend its reconciliation of its kustomizations and sources. | bool Optional |
| waitForReconciliation | Whether flux configuration deployment should wait for cluster to reconcile the kustomizations. | bool Optional |
FluxConfiguration_STATUS
The Flux Configuration object returned in Get & Put response.
Used by: FluxConfiguration.
| Property | Description | Type |
|---|---|---|
| azureBlob | Parameters to reconcile to the AzureBlob source kind type. | AzureBlobDefinition_STATUS Optional |
| bucket | Parameters to reconcile to the Bucket source kind type. | BucketDefinition_STATUS Optional |
| complianceState | Combined status of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects. | FluxComplianceStateDefinition_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationProtectedSettings | Key-value pairs of protected configuration settings for the configuration | map[string]string Optional |
| errorMessage | Error message returned to the user in the case of provisioning failure. | string Optional |
| gitRepository | Parameters to reconcile to the GitRepository source kind type. | GitRepositoryDefinition_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| kustomizations | Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. | map[string]KustomizationDefinition_STATUS Optional |
| name | The name of the resource | string Optional |
| namespace | The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. | string Optional |
| provisioningState | Status of the creation of the fluxConfiguration. | ProvisioningStateDefinition_STATUS Optional |
| reconciliationWaitDuration | Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D | string Optional |
| repositoryPublicKey | Public Key associated with this fluxConfiguration (either generated within the cluster or provided by the user). | string Optional |
| scope | Scope at which the operator will be installed. | ScopeDefinition_STATUS Optional |
| sourceKind | Source Kind to pull the configuration data from. | SourceKindDefinition_STATUS Optional |
| sourceSyncedCommitId | Branch and/or SHA of the source commit synced with the cluster. | string Optional |
| sourceUpdatedAt | Datetime the fluxConfiguration synced its source on the cluster. | string Optional |
| statuses | Statuses of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects provisioned by the fluxConfiguration. | ObjectStatusDefinition_STATUS[] Optional |
| statusUpdatedAt | Datetime the fluxConfiguration synced its status on the cluster with Azure. | string Optional |
| suspend | Whether this configuration should suspend its reconciliation of its kustomizations and sources. | bool Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| waitForReconciliation | Whether flux configuration deployment should wait for cluster to reconcile the kustomizations. | bool Optional |
AzureBlobDefinition
Parameters to reconcile to the AzureBlob source kind type.
Used by: FluxConfiguration_Spec.
| Property | Description | Type |
|---|---|---|
| accountKey | The account key (shared key) to access the storage account | genruntime.SecretReference Optional |
| containerName | The Azure Blob container name to sync from the url endpoint for the flux configuration. | string Optional |
| 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. | string Optional |
| managedIdentity | Parameters to authenticate using a Managed Identity. | ManagedIdentityDefinition Optional |
| sasToken | The Shared Access token to access the storage container | genruntime.SecretReference Optional |
| servicePrincipal | Parameters to authenticate using Service Principal. | ServicePrincipalDefinition Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the cluster Azure Blob source with the remote. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the cluster Azure Blob source with the remote. | int Optional |
| url | The URL to sync for the flux configuration Azure Blob storage account. | string Optional |
AzureBlobDefinition_STATUS
Parameters to reconcile to the AzureBlob source kind type.
Used by: FluxConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| containerName | The Azure Blob container name to sync from the url endpoint for the flux configuration. | string Optional |
| 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. | string Optional |
| managedIdentity | Parameters to authenticate using a Managed Identity. | ManagedIdentityDefinition_STATUS Optional |
| servicePrincipal | Parameters to authenticate using Service Principal. | ServicePrincipalDefinition_STATUS Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the cluster Azure Blob source with the remote. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the cluster Azure Blob source with the remote. | int Optional |
| url | The URL to sync for the flux configuration Azure Blob storage account. | string Optional |
BucketDefinition
Parameters to reconcile to the Bucket source kind type.
Used by: FluxConfiguration_Spec.
| Property | Description | Type |
|---|---|---|
| accessKey | Plaintext access key used to securely access the S3 bucket | genruntime.SecretReference Optional |
| bucketName | The bucket name to sync from the url endpoint for the flux configuration. | string Optional |
| insecure | Specify whether to use insecure communication when puling data from the S3 bucket. | bool Optional |
| 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. | string Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the cluster bucket source with the remote. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the cluster bucket source with the remote. | int Optional |
| url | The URL to sync for the flux configuration S3 bucket. | string Optional |
BucketDefinition_STATUS
Parameters to reconcile to the Bucket source kind type.
Used by: FluxConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| bucketName | The bucket name to sync from the url endpoint for the flux configuration. | string Optional |
| insecure | Specify whether to use insecure communication when puling data from the S3 bucket. | bool Optional |
| 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. | string Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the cluster bucket source with the remote. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the cluster bucket source with the remote. | int Optional |
| url | The URL to sync for the flux configuration S3 bucket. | string Optional |
ErrorDetail_STATUS
The error detail.
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| additionalInfo | The error additional info. | ErrorAdditionalInfo_STATUS[] Optional |
| code | The error code. | string Optional |
| details | The error details. | ErrorDetail_STATUS_Unrolled[] Optional |
| message | The error message. | string Optional |
| target | The error target. | string Optional |
Extension_Properties_AksAssignedIdentity_Spec
Used by: Extension_Spec.
| Property | Description | Type |
|---|---|---|
| type | The identity type. | Extension_Properties_AksAssignedIdentity_Type_Spec Optional |
Extension_Properties_AksAssignedIdentity_STATUS
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of resource identity. | string Optional |
| tenantId | The tenant ID of resource. | string Optional |
| type | The identity type. | Extension_Properties_AksAssignedIdentity_Type_STATUS Optional |
ExtensionOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Extension_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| configMaps | configures where to place operator written ConfigMaps. | ExtensionOperatorConfigMaps Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ExtensionStatus_STATUS
Status from the extension.
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| code | Status code provided by the Extension | string Optional |
| displayStatus | Short description of status of the extension. | string Optional |
| level | Level of the status. | ExtensionStatus_Level_STATUS Optional |
| message | Detailed message of the status from the Extension. | string Optional |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string Optional |
FluxComplianceStateDefinition_STATUS
Compliance state of the cluster object.
Used by: FluxConfiguration_STATUS, and ObjectStatusDefinition_STATUS.
| Value | Description |
|---|---|
| “Compliant” | |
| “Non-Compliant” | |
| “Pending” | |
| “Suspended” | |
| “Unknown” |
FluxConfigurationOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FluxConfiguration_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
GitRepositoryDefinition
Parameters to reconcile to the GitRepository source kind type.
Used by: FluxConfiguration_Spec.
| Property | Description | Type |
|---|---|---|
| httpsCACert | Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS | genruntime.SecretReference Optional |
| httpsUser | Plaintext HTTPS username used to access private git repositories over HTTPS | string Optional |
| 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. | string Optional |
| repositoryRef | The source reference for the GitRepository object. | RepositoryRefDefinition Optional |
| sshKnownHosts | Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH | string Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the cluster git repository source with the remote. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the cluster git repository source with the remote. | int Optional |
| url | The URL to sync for the flux configuration git repository. | string Optional |
GitRepositoryDefinition_STATUS
Parameters to reconcile to the GitRepository source kind type.
Used by: FluxConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| httpsUser | Plaintext HTTPS username used to access private git repositories over HTTPS | string Optional |
| 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. | string Optional |
| repositoryRef | The source reference for the GitRepository object. | RepositoryRefDefinition_STATUS Optional |
| sshKnownHosts | Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH | string Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the cluster git repository source with the remote. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the cluster git repository source with the remote. | int Optional |
| url | The URL to sync for the flux configuration git repository. | string Optional |
Identity
Identity for the resource.
Used by: Extension_Spec.
| Property | Description | Type |
|---|---|---|
| type | The identity type. | Identity_Type Optional |
Identity_STATUS
Identity for the resource.
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of resource identity. | string Optional |
| tenantId | The tenant ID of resource. | string Optional |
| type | The identity type. | Identity_Type_STATUS Optional |
KustomizationDefinition
The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.
Used by: FluxConfiguration_Spec.
| Property | Description | Type |
|---|---|---|
| dependsOn | Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies have completed their reconciliation. | string[] Optional |
| force | Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change. | bool Optional |
| path | The path in the source reference to reconcile on the cluster. | string Optional |
| postBuild | Used for variable substitution for this Kustomization after kustomize build. | PostBuildDefinition Optional |
| prune | Enable/disable garbage collections of Kubernetes objects created by this Kustomization. | bool Optional |
| retryIntervalInSeconds | The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation. | int Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the Kustomization on the cluster. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the Kustomization on the cluster. | int Optional |
| wait | Enable/disable health check for all Kubernetes objects created by this Kustomization. | bool Optional |
KustomizationDefinition_STATUS
The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.
Used by: FluxConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| dependsOn | Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies have completed their reconciliation. | string[] Optional |
| force | Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change. | bool Optional |
| name | Name of the Kustomization, matching the key in the Kustomizations object map. | string Optional |
| path | The path in the source reference to reconcile on the cluster. | string Optional |
| postBuild | Used for variable substitution for this Kustomization after kustomize build. | PostBuildDefinition_STATUS Optional |
| prune | Enable/disable garbage collections of Kubernetes objects created by this Kustomization. | bool Optional |
| retryIntervalInSeconds | The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation. | int Optional |
| syncIntervalInSeconds | The interval at which to re-reconcile the Kustomization on the cluster. | int Optional |
| timeoutInSeconds | The maximum time to attempt to reconcile the Kustomization on the cluster. | int Optional |
| wait | Enable/disable health check for all Kubernetes objects created by this Kustomization. | bool Optional |
ObjectStatusDefinition_STATUS
Statuses of objects deployed by the user-specified kustomizations from the git repository.
Used by: FluxConfiguration_STATUS.
| Property | Description | Type |
|---|---|---|
| appliedBy | Object reference to the Kustomization that applied this object | ObjectReferenceDefinition_STATUS Optional |
| complianceState | Compliance state of the applied object showing whether the applied object has come into a ready state on the cluster. | FluxComplianceStateDefinition_STATUS Optional |
| helmReleaseProperties | Additional properties that are provided from objects of the HelmRelease kind | HelmReleasePropertiesDefinition_STATUS Optional |
| kind | Kind of the applied object | string Optional |
| name | Name of the applied object | string Optional |
| namespace | Namespace of the applied object | string Optional |
| statusConditions | List of Kubernetes object status conditions present on the cluster | ObjectStatusConditionDefinition_STATUS[] Optional |
Plan
Plan for the resource.
Used by: Extension_Spec.
| Property | Description | Type |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string Required |
| 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. | string Required |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string Optional |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string Required |
| version | The version of the desired product/artifact. | string Optional |
Plan_STATUS
Plan for the resource.
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string Optional |
| 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. | string Optional |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string Optional |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string Optional |
| version | The version of the desired product/artifact. | string Optional |
ProvisioningStateDefinition_STATUS
The provisioning state of the resource.
Used by: Extension_STATUS, and FluxConfiguration_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
Scope
Scope of the extension. It can be either Cluster or Namespace; but not both.
Used by: Extension_Spec.
| Property | Description | Type |
|---|---|---|
| cluster | Specifies that the scope of the extension is Cluster | ScopeCluster Optional |
| namespace | Specifies that the scope of the extension is Namespace | ScopeNamespace Optional |
Scope_STATUS
Scope of the extension. It can be either Cluster or Namespace; but not both.
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| cluster | Specifies that the scope of the extension is Cluster | ScopeCluster_STATUS Optional |
| namespace | Specifies that the scope of the extension is Namespace | ScopeNamespace_STATUS Optional |
ScopeDefinition
Scope at which the configuration will be installed.
Used by: FluxConfiguration_Spec.
| Value | Description |
|---|---|
| “cluster” | |
| “namespace” |
ScopeDefinition_STATUS
Scope at which the configuration will be installed.
Used by: FluxConfiguration_STATUS.
| Value | Description |
|---|---|
| “cluster” | |
| “namespace” |
SourceKindDefinition
Source Kind to pull the configuration data from.
Used by: FluxConfiguration_Spec.
| Value | Description |
|---|---|
| “AzureBlob” | |
| “Bucket” | |
| “GitRepository” |
SourceKindDefinition_STATUS
Source Kind to pull the configuration data from.
Used by: FluxConfiguration_STATUS.
| Value | Description |
|---|---|
| “AzureBlob” | |
| “Bucket” | |
| “GitRepository” |
SystemData
Metadata pertaining to creation and last modification of the resource.
Used by: Extension_Spec.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Extension_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
ErrorAdditionalInfo_STATUS
The resource management error additional info.
Used by: ErrorDetail_STATUS, and ErrorDetail_STATUS_Unrolled.
| Property | Description | Type |
|---|---|---|
| info | The additional info. | map[string]v1.JSON Optional |
| type | The additional info type. | string Optional |
ErrorDetail_STATUS_Unrolled
Used by: ErrorDetail_STATUS.
| Property | Description | Type |
|---|---|---|
| additionalInfo | The error additional info. | ErrorAdditionalInfo_STATUS[] Optional |
| code | The error code. | string Optional |
| message | The error message. | string Optional |
| target | The error target. | string Optional |
Extension_Properties_AksAssignedIdentity_Type_Spec
Used by: Extension_Properties_AksAssignedIdentity_Spec.
| Value | Description |
|---|---|
| “SystemAssigned” | |
| “UserAssigned” |
Extension_Properties_AksAssignedIdentity_Type_STATUS
Used by: Extension_Properties_AksAssignedIdentity_STATUS.
| Value | Description |
|---|---|
| “SystemAssigned” | |
| “UserAssigned” |
ExtensionOperatorConfigMaps
Used by: ExtensionOperatorSpec.
| Property | Description | Type |
|---|---|---|
| principalId | indicates where the PrincipalId config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
ExtensionStatus_Level_STATUS
Used by: ExtensionStatus_STATUS.
| Value | Description |
|---|---|
| “Error” | |
| “Information” | |
| “Warning” |
HelmReleasePropertiesDefinition_STATUS
Properties for HelmRelease objects
Used by: ObjectStatusDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| failureCount | Total number of times that the HelmRelease failed to install or upgrade | int Optional |
| helmChartRef | The reference to the HelmChart object used as the source to this HelmRelease | ObjectReferenceDefinition_STATUS Optional |
| installFailureCount | Number of times that the HelmRelease failed to install | int Optional |
| lastRevisionApplied | The revision number of the last released object change | int Optional |
| upgradeFailureCount | Number of times that the HelmRelease failed to upgrade | int Optional |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “SystemAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “SystemAssigned” |
ManagedIdentityDefinition
Parameters to authenticate using a Managed Identity.
Used by: AzureBlobDefinition.
| Property | Description | Type |
|---|---|---|
| clientId | The client Id for authenticating a Managed Identity. | string Optional |
ManagedIdentityDefinition_STATUS
Parameters to authenticate using a Managed Identity.
Used by: AzureBlobDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client Id for authenticating a Managed Identity. | string Optional |
ObjectReferenceDefinition_STATUS
Object reference to a Kubernetes object on a cluster
Used by: HelmReleasePropertiesDefinition_STATUS, and ObjectStatusDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name of the object | string Optional |
| namespace | Namespace of the object | string Optional |
ObjectStatusConditionDefinition_STATUS
Status condition of Kubernetes object
Used by: ObjectStatusDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| lastTransitionTime | Last time this status condition has changed | string Optional |
| message | A more verbose description of the object status condition | string Optional |
| reason | Reason for the specified status condition type status | string Optional |
| status | Status of the Kubernetes object condition type | string Optional |
| type | Object status condition type for this object | string Optional |
PostBuildDefinition
The postBuild definitions defining variable substitutions for this Kustomization after kustomize build.
Used by: KustomizationDefinition.
| Property | Description | Type |
|---|---|---|
| substitute | Key/value pairs holding the variables to be substituted in this Kustomization. | map[string]string Optional |
| substituteFrom | Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization. | SubstituteFromDefinition[] Optional |
PostBuildDefinition_STATUS
The postBuild definitions defining variable substitutions for this Kustomization after kustomize build.
Used by: KustomizationDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| substitute | Key/value pairs holding the variables to be substituted in this Kustomization. | map[string]string Optional |
| substituteFrom | Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization. | SubstituteFromDefinition_STATUS[] Optional |
RepositoryRefDefinition
The source reference for the GitRepository object.
Used by: GitRepositoryDefinition.
| Property | Description | Type |
|---|---|---|
| branch | The git repository branch name to checkout. | string Optional |
| commit | The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. | string Optional |
| semver | The semver range used to match against git repository tags. This takes precedence over tag. | string Optional |
| tag | The git repository tag name to checkout. This takes precedence over branch. | string Optional |
RepositoryRefDefinition_STATUS
The source reference for the GitRepository object.
Used by: GitRepositoryDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| branch | The git repository branch name to checkout. | string Optional |
| commit | The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. | string Optional |
| semver | The semver range used to match against git repository tags. This takes precedence over tag. | string Optional |
| tag | The git repository tag name to checkout. This takes precedence over branch. | string Optional |
ScopeCluster
Specifies that the scope of the extension is Cluster
Used by: Scope.
| Property | Description | Type |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created | string Optional |
ScopeCluster_STATUS
Specifies that the scope of the extension is Cluster
Used by: Scope_STATUS.
| Property | Description | Type |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created | string Optional |
ScopeNamespace
Specifies that the scope of the extension is Namespace
Used by: Scope.
| Property | Description | Type |
|---|---|---|
| targetNamespace | Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created | string Optional |
ScopeNamespace_STATUS
Specifies that the scope of the extension is Namespace
Used by: Scope_STATUS.
| Property | Description | Type |
|---|---|---|
| targetNamespace | Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created | string Optional |
ServicePrincipalDefinition
Parameters to authenticate using Service Principal.
Used by: AzureBlobDefinition.
| Property | Description | Type |
|---|---|---|
| clientCertificate | Base64-encoded certificate used to authenticate a Service Principal | genruntime.SecretReference Optional |
| clientCertificatePassword | The password for the certificate used to authenticate a Service Principal | genruntime.SecretReference Optional |
| 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 | bool Optional |
| clientId | The client Id for authenticating a Service Principal. | string Optional |
| clientIdFromConfig | The client Id for authenticating a Service Principal. | genruntime.ConfigMapReference Optional |
| clientSecret | The client secret for authenticating a Service Principal | genruntime.SecretReference Optional |
| tenantId | The tenant Id for authenticating a Service Principal | string Optional |
| tenantIdFromConfig | The tenant Id for authenticating a Service Principal | genruntime.ConfigMapReference Optional |
ServicePrincipalDefinition_STATUS
Parameters to authenticate using Service Principal.
Used by: AzureBlobDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| 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 | bool Optional |
| clientId | The client Id for authenticating a Service Principal. | string Optional |
| tenantId | The tenant Id for authenticating a Service Principal | string Optional |
SystemData_CreatedByType
Used by: SystemData.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType
Used by: SystemData.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SubstituteFromDefinition
Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.
Used by: PostBuildDefinition.
| Property | Description | Type |
|---|---|---|
| kind | Define whether it is ConfigMap or Secret that holds the variables to be used in substitution. | string Optional |
| name | Name of the ConfigMap/Secret that holds the variables to be used in substitution. | string Optional |
| optional | Set to True to proceed without ConfigMap/Secret, if it is not present. | bool Optional |
SubstituteFromDefinition_STATUS
Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.
Used by: PostBuildDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| kind | Define whether it is ConfigMap or Secret that holds the variables to be used in substitution. | string Optional |
| name | Name of the ConfigMap/Secret that holds the variables to be used in substitution. | string Optional |
| optional | Set to True to proceed without ConfigMap/Secret, if it is not present. | bool Optional |