@azure/arm-kubernetesconfiguration-fluxconfigurations 1.0.0-beta.1

package/review/arm-kubernetesconfiguration-fluxconfigurations.api.md

@@ -0,0 +1,602 @@
+## API Report File for "@azure/arm-kubernetesconfiguration-fluxconfigurations"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export interface AzureBlobDefinition {
+    accountKey?: string;
+    containerName?: string;
+    localAuthRef?: string;
+    managedIdentity?: ManagedIdentityDefinition;
+    sasToken?: string;
+    servicePrincipal?: ServicePrincipalDefinition;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    url?: string;
+}
+
+// @public
+export interface AzureBlobPatchDefinition {
+    accountKey?: string;
+    containerName?: string;
+    localAuthRef?: string;
+    managedIdentity?: ManagedIdentityPatchDefinition;
+    sasToken?: string;
+    servicePrincipal?: ServicePrincipalPatchDefinition;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    url?: string;
+}
+
+// @public
+export interface BucketDefinition {
+    accessKey?: string;
+    bucketName?: string;
+    insecure?: boolean;
+    localAuthRef?: string;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    url?: string;
+}
+
+// @public
+export interface BucketPatchDefinition {
+    accessKey?: string;
+    bucketName?: string;
+    insecure?: boolean;
+    localAuthRef?: string;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    url?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export type FluxComplianceState = string;
+
+// @public
+export interface FluxConfigOperationStatus {
+    get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, operationId: string, options?: FluxConfigOperationStatusGetOptionalParams): Promise<FluxConfigOperationStatusGetResponse>;
+}
+
+// @public
+export interface FluxConfigOperationStatusGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FluxConfigOperationStatusGetResponse = OperationStatusResult;
+
+// @public
+export interface FluxConfiguration extends ProxyResource {
+    azureBlob?: AzureBlobDefinition;
+    bucket?: BucketDefinition;
+    readonly complianceState?: FluxComplianceState;
+    configurationProtectedSettings?: {
+        [propertyName: string]: string;
+    };
+    readonly errorMessage?: string;
+    gitRepository?: GitRepositoryDefinition;
+    kustomizations?: {
+        [propertyName: string]: KustomizationDefinition | null;
+    };
+    namespace?: string;
+    ociRepository?: OCIRepositoryDefinition;
+    readonly provisioningState?: ProvisioningState;
+    reconciliationWaitDuration?: string;
+    readonly repositoryPublicKey?: string;
+    scope?: ScopeType;
+    sourceKind?: SourceKindType;
+    readonly sourceSyncedCommitId?: string;
+    readonly sourceUpdatedAt?: Date;
+    readonly statuses?: (ObjectStatusDefinition | null)[];
+    readonly statusUpdatedAt?: Date;
+    suspend?: boolean;
+    readonly systemData?: SystemData;
+    waitForReconciliation?: boolean;
+}
+
+// @public (undocumented)
+export class FluxConfigurationClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: FluxConfigurationClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    fluxConfigOperationStatus: FluxConfigOperationStatus;
+    // (undocumented)
+    fluxConfigurations: FluxConfigurations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface FluxConfigurationClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface FluxConfigurationPatch {
+    azureBlob?: AzureBlobPatchDefinition;
+    bucket?: BucketPatchDefinition;
+    configurationProtectedSettings?: {
+        [propertyName: string]: string;
+    };
+    gitRepository?: GitRepositoryPatchDefinition;
+    kustomizations?: {
+        [propertyName: string]: KustomizationPatchDefinition | null;
+    };
+    ociRepository?: OCIRepositoryPatchDefinition;
+    sourceKind?: SourceKindType;
+    suspend?: boolean;
+}
+
+// @public
+export interface FluxConfigurations {
+    beginCreateOrUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfiguration: FluxConfiguration, options?: FluxConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FluxConfigurationsCreateOrUpdateResponse>, FluxConfigurationsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfiguration: FluxConfiguration, options?: FluxConfigurationsCreateOrUpdateOptionalParams): Promise<FluxConfigurationsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfigurationPatch: FluxConfigurationPatch, options?: FluxConfigurationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FluxConfigurationsUpdateResponse>, FluxConfigurationsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, fluxConfigurationPatch: FluxConfigurationPatch, options?: FluxConfigurationsUpdateOptionalParams): Promise<FluxConfigurationsUpdateResponse>;
+    get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, fluxConfigurationName: string, options?: FluxConfigurationsGetOptionalParams): Promise<FluxConfigurationsGetResponse>;
+    list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: FluxConfigurationsListOptionalParams): PagedAsyncIterableIterator<FluxConfiguration>;
+}
+
+// @public
+export interface FluxConfigurationsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type FluxConfigurationsCreateOrUpdateResponse = FluxConfiguration;
+
+// @public
+export interface FluxConfigurationsDeleteOptionalParams extends coreClient.OperationOptions {
+    forceDelete?: boolean;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface FluxConfigurationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FluxConfigurationsGetResponse = FluxConfiguration;
+
+// @public
+export interface FluxConfigurationsList {
+    readonly nextLink?: string;
+    readonly value?: FluxConfiguration[];
+}
+
+// @public
+export interface FluxConfigurationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FluxConfigurationsListNextResponse = FluxConfigurationsList;
+
+// @public
+export interface FluxConfigurationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FluxConfigurationsListResponse = FluxConfigurationsList;
+
+// @public
+export interface FluxConfigurationsUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type FluxConfigurationsUpdateResponse = FluxConfiguration;
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface GitRepositoryDefinition {
+    httpsCACert?: string;
+    httpsUser?: string;
+    localAuthRef?: string;
+    provider?: ProviderType;
+    repositoryRef?: RepositoryRefDefinition;
+    sshKnownHosts?: string;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    url?: string;
+}
+
+// @public
+export interface GitRepositoryPatchDefinition {
+    httpsCACert?: string;
+    httpsUser?: string;
+    localAuthRef?: string;
+    provider?: ProviderType;
+    repositoryRef?: RepositoryRefDefinition;
+    sshKnownHosts?: string;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    url?: string;
+}
+
+// @public
+export interface HelmReleasePropertiesDefinition {
+    failureCount?: number;
+    helmChartRef?: ObjectReferenceDefinition;
+    installFailureCount?: number;
+    lastRevisionApplied?: number;
+    upgradeFailureCount?: number;
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownFluxComplianceState {
+    Compliant = "Compliant",
+    NonCompliant = "Non-Compliant",
+    Pending = "Pending",
+    Suspended = "Suspended",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownKustomizationValidationType {
+    Client = "client",
+    None = "none",
+    Server = "server"
+}
+
+// @public
+export enum KnownOperationType {
+    Copy = "copy",
+    Extract = "extract"
+}
+
+// @public
+export enum KnownProviderType {
+    Azure = "Azure",
+    Generic = "Generic",
+    GitHub = "GitHub"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownScopeType {
+    Cluster = "cluster",
+    Namespace = "namespace"
+}
+
+// @public
+export enum KnownSourceKindType {
+    AzureBlob = "AzureBlob",
+    Bucket = "Bucket",
+    GitRepository = "GitRepository",
+    OCIRepository = "OCIRepository"
+}
+
+// @public
+export interface KustomizationDefinition {
+    dependsOn?: string[];
+    force?: boolean;
+    readonly name?: string;
+    path?: string;
+    postBuild?: PostBuildDefinition;
+    prune?: boolean;
+    retryIntervalInSeconds?: number;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    wait?: boolean;
+}
+
+// @public
+export interface KustomizationPatchDefinition {
+    dependsOn?: string[];
+    force?: boolean;
+    path?: string;
+    postBuild?: PostBuildPatchDefinition;
+    prune?: boolean;
+    retryIntervalInSeconds?: number;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    wait?: boolean;
+}
+
+// @public
+export type KustomizationValidationType = string;
+
+// @public
+export interface LayerSelectorDefinition {
+    mediaType?: string;
+    operation?: OperationType;
+}
+
+// @public
+export interface LayerSelectorPatchDefinition {
+    mediaType?: string;
+    operation?: OperationType;
+}
+
+// @public
+export interface ManagedIdentityDefinition {
+    clientId?: string;
+}
+
+// @public
+export interface ManagedIdentityPatchDefinition {
+    clientId?: string;
+}
+
+// @public
+export interface MatchOidcIdentityDefinition {
+    issuer?: string;
+    subject?: string;
+}
+
+// @public
+export interface MatchOidcIdentityPatchDefinition {
+    issuer?: string;
+    subject?: string;
+}
+
+// @public
+export interface ObjectReferenceDefinition {
+    name?: string;
+    namespace?: string;
+}
+
+// @public
+export interface ObjectStatusConditionDefinition {
+    lastTransitionTime?: Date;
+    message?: string;
+    reason?: string;
+    status?: string;
+    type?: string;
+}
+
+// @public
+export interface ObjectStatusDefinition {
+    appliedBy?: ObjectReferenceDefinition;
+    complianceState?: FluxComplianceState;
+    helmReleaseProperties?: HelmReleasePropertiesDefinition;
+    kind?: string;
+    name?: string;
+    namespace?: string;
+    statusConditions?: ObjectStatusConditionDefinition[];
+}
+
+// @public
+export interface OCIRepositoryDefinition {
+    insecure?: boolean;
+    layerSelector?: LayerSelectorDefinition;
+    localAuthRef?: string;
+    repositoryRef?: OCIRepositoryRefDefinition;
+    serviceAccountName?: string;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    tlsConfig?: TlsConfigDefinition;
+    url?: string;
+    useWorkloadIdentity?: boolean;
+    verify?: VerifyDefinition;
+}
+
+// @public
+export interface OCIRepositoryPatchDefinition {
+    insecure?: boolean;
+    layerSelector?: LayerSelectorPatchDefinition;
+    localAuthRef?: string;
+    repositoryRef?: OCIRepositoryRefPatchDefinition;
+    serviceAccountName?: string;
+    syncIntervalInSeconds?: number;
+    timeoutInSeconds?: number;
+    tlsConfig?: TlsConfigPatchDefinition;
+    url?: string;
+    useWorkloadIdentity?: boolean;
+    verify?: VerifyPatchDefinition;
+}
+
+// @public
+export interface OCIRepositoryRefDefinition {
+    digest?: string;
+    semver?: string;
+    tag?: string;
+}
+
+// @public
+export interface OCIRepositoryRefPatchDefinition {
+    digest?: string;
+    semver?: string;
+    tag?: string;
+}
+
+// @public
+export interface OperationStatusResult {
+    readonly error?: ErrorDetail;
+    id?: string;
+    name?: string;
+    properties?: {
+        [propertyName: string]: string;
+    };
+    status: string;
+}
+
+// @public
+export type OperationType = string;
+
+// @public
+export interface PostBuildDefinition {
+    substitute?: {
+        [propertyName: string]: string;
+    };
+    substituteFrom?: (SubstituteFromDefinition | null)[];
+}
+
+// @public
+export interface PostBuildPatchDefinition {
+    substitute?: {
+        [propertyName: string]: string;
+    };
+    substituteFrom?: (SubstituteFromPatchDefinition | null)[];
+}
+
+// @public
+export type ProviderType = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface RepositoryRefDefinition {
+    branch?: string;
+    commit?: string;
+    semver?: string;
+    tag?: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export type ScopeType = string;
+
+// @public
+export interface ServicePrincipalDefinition {
+    clientCertificate?: string;
+    clientCertificatePassword?: string;
+    clientCertificateSendChain?: boolean;
+    clientId?: string;
+    clientSecret?: string;
+    tenantId?: string;
+}
+
+// @public
+export interface ServicePrincipalPatchDefinition {
+    clientCertificate?: string;
+    clientCertificatePassword?: string;
+    clientCertificateSendChain?: boolean;
+    clientId?: string;
+    clientSecret?: string;
+    tenantId?: string;
+}
+
+// @public
+export type SourceKindType = string;
+
+// @public
+export interface SubstituteFromDefinition {
+    kind?: string;
+    name?: string;
+    optional?: boolean;
+}
+
+// @public
+export interface SubstituteFromPatchDefinition {
+    kind?: string;
+    name?: string;
+    optional?: boolean;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TlsConfigDefinition {
+    caCertificate?: string;
+    clientCertificate?: string;
+    privateKey?: string;
+}
+
+// @public
+export interface TlsConfigPatchDefinition {
+    caCertificate?: string;
+    clientCertificate?: string;
+    privateKey?: string;
+}
+
+// @public
+export interface VerifyDefinition {
+    matchOidcIdentity?: (MatchOidcIdentityDefinition | null)[];
+    provider?: string;
+    verificationConfig?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface VerifyPatchDefinition {
+    matchOidcIdentity?: (MatchOidcIdentityPatchDefinition | null)[];
+    provider?: string;
+    verificationConfig?: {
+        [propertyName: string]: string;
+    };
+}
+
+// (No @packageDocumentation comment for this package)
+
+```