@azure/arm-kubernetesconfiguration-fluxconfigurations package

Classes

FluxConfigurationClient

Interfaces

AzureBlobDefinition	Parameters to reconcile to the AzureBlob source kind type.
AzureBlobPatchDefinition	Parameters to reconcile to the AzureBlob source kind type.
BucketDefinition	Parameters to reconcile to the Bucket source kind type.
BucketPatchDefinition	Parameters to reconcile to the Bucket source kind type.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FluxConfigOperationStatusGetOptionalParams	Optional parameters.
FluxConfigOperationStatusOperations	Interface representing a FluxConfigOperationStatus operations.
FluxConfiguration	The Flux Configuration object returned in Get & Put response.
FluxConfigurationClientOptionalParams	Optional parameters for the client.
FluxConfigurationPatch	The Flux Configuration Patch Request object.
FluxConfigurationPatchProperties	Updatable properties of an Flux Configuration Patch Request
FluxConfigurationProperties	Properties to create a Flux Configuration resource
FluxConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
FluxConfigurationsDeleteOptionalParams	Optional parameters.
FluxConfigurationsGetOptionalParams	Optional parameters.
FluxConfigurationsListOptionalParams	Optional parameters.
FluxConfigurationsOperations	Interface representing a FluxConfigurations operations.
FluxConfigurationsUpdateOptionalParams	Optional parameters.
GitRepositoryDefinition	Parameters to reconcile to the GitRepository source kind type.
GitRepositoryPatchDefinition	Parameters to reconcile to the GitRepository source kind type.
HelmReleasePropertiesDefinition	Properties for HelmRelease objects
KustomizationDefinition	The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.
KustomizationPatchDefinition	The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.
LayerSelectorDefinition	Parameters to specify which layer to pull from the OCI artifact. By default, the first layer in the artifact is pulled.
LayerSelectorPatchDefinition	Parameters to specify which layer to pull from the OCI artifact. By default, the first layer in the artifact is pulled.
ManagedIdentityDefinition	Parameters to authenticate using a Managed Identity.
ManagedIdentityPatchDefinition	Parameters to authenticate using a Managed Identity.
MatchOidcIdentityDefinition	MatchOIDCIdentity defines the criteria for matching the identity while verifying an OCI artifact.
MatchOidcIdentityPatchDefinition	MatchOIDCIdentity defines the criteria for matching the identity while verifying an OCI artifact.
OCIRepositoryDefinition	Parameters to reconcile to the OCIRepository source kind type.
OCIRepositoryPatchDefinition	Parameters to reconcile to the OCIRepository source kind type.
OCIRepositoryRefDefinition	The source reference for the OCIRepository object.
OCIRepositoryRefPatchDefinition	The source reference for the OCIRepository object.
ObjectReferenceDefinition	Object reference to a Kubernetes object on a cluster
ObjectStatusConditionDefinition	Status condition of Kubernetes object
ObjectStatusDefinition	Statuses of objects deployed by the user-specified kustomizations from the git repository.
OperationStatusResult	The current status of an async operation.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PostBuildDefinition	The postBuild definitions defining variable substitutions for this Kustomization after kustomize build.
PostBuildPatchDefinition	The postBuild definitions defining variable substitutions for this Kustomization after kustomize build.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RepositoryRefDefinition	The source reference for the GitRepository object.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ServicePrincipalDefinition	Parameters to authenticate using Service Principal.
ServicePrincipalPatchDefinition	Parameters to authenticate using Service Principal.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SubstituteFromDefinition	Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.
SubstituteFromPatchDefinition	Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization.
SystemData	Metadata pertaining to creation and last modification of the resource.
TlsConfigDefinition	Parameters to authenticate using TLS config for OCI repository.
TlsConfigPatchDefinition	Parameters to authenticate using TLS config for OCI repository.
VerifyDefinition	Parameters to verify the authenticity of an OCI Artifact.
VerifyPatchDefinition	Parameters to verify the authenticity of an OCI Artifact.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
FluxComplianceState	Compliance state of the cluster object. KnownFluxComplianceState can be used interchangeably with FluxComplianceState, this enum contains the known values that the service supports. Known values supported by the service Compliant: Compliant Non-Compliant: Non-Compliant Pending: Pending Suspended: Suspended Unknown: Unknown
OperationType	The operation to be performed on the selected layer. The default value is 'extract', but it can be set to 'copy'. KnownOperationType can be used interchangeably with OperationType, this enum contains the known values that the service supports. Known values supported by the service extract: extract copy: copy
ProviderType	Name of the provider used for authentication. KnownProviderType can be used interchangeably with ProviderType, this enum contains the known values that the service supports. Known values supported by the service Azure: Azure provider can be used to authenticate to Azure DevOps repositories using Managed Identity. GitHub: GitHub provider can be used to authenticate Generic: Generic is the default provider that indicates secret-based authentication mechanism.
ProvisioningState	The provisioning state of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Succeeded Failed: Failed Canceled: Canceled Creating: Creating Updating: Updating Deleting: Deleting
ScopeType	Scope at which the configuration will be installed. KnownScopeType can be used interchangeably with ScopeType, this enum contains the known values that the service supports. Known values supported by the service cluster: cluster namespace: namespace
SourceKindType	Source Kind to pull the configuration data from. KnownSourceKindType can be used interchangeably with SourceKindType, this enum contains the known values that the service supports. Known values supported by the service GitRepository: GitRepository Bucket: Bucket AzureBlob: AzureBlob OCIRepository: OCIRepository

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownFluxComplianceState	Compliance state of the cluster object.
KnownOperationType	The operation to be performed on the selected layer. The default value is 'extract', but it can be set to 'copy'.
KnownProviderType	Name of the provider used for authentication.
KnownProvisioningState	The provisioning state of the resource.
KnownScopeType	Scope at which the configuration will be installed.
KnownSourceKindType	Source Kind to pull the configuration data from.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(FluxConfigurationClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(FluxConfigurationClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: FluxConfigurationClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

FluxConfigurationClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>