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

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

@@ -0,0 +1,294 @@
+## API Report File for "@azure/arm-kubernetesconfiguration-extensions"
+
+> 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 type AKSIdentityType = "SystemAssigned" | "UserAssigned";
+
+// @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 interface Extension extends ProxyResource {
+    aksAssignedIdentity?: ExtensionPropertiesAksAssignedIdentity;
+    autoUpgradeMinorVersion?: boolean;
+    configurationProtectedSettings?: {
+        [propertyName: string]: string;
+    };
+    configurationSettings?: {
+        [propertyName: string]: string;
+    };
+    readonly currentVersion?: string;
+    readonly customLocationSettings?: {
+        [propertyName: string]: string;
+    };
+    readonly errorInfo?: ErrorDetail;
+    extensionType?: string;
+    identity?: Identity;
+    readonly isSystemExtension?: boolean;
+    readonly packageUri?: string;
+    plan?: Plan;
+    readonly provisioningState?: ProvisioningState;
+    releaseTrain?: string;
+    scope?: Scope;
+    statuses?: ExtensionStatus[];
+    readonly systemData?: SystemData;
+    version?: string;
+}
+
+// @public
+export interface ExtensionPropertiesAksAssignedIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: AKSIdentityType;
+}
+
+// @public
+export interface Extensions {
+    beginCreate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<ExtensionsCreateResponse>, ExtensionsCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<ExtensionsCreateResponse>;
+    beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, patchExtension: PatchExtension, options?: ExtensionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ExtensionsUpdateResponse>, ExtensionsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, patchExtension: PatchExtension, options?: ExtensionsUpdateOptionalParams): Promise<ExtensionsUpdateResponse>;
+    get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, options?: ExtensionsGetOptionalParams): Promise<ExtensionsGetResponse>;
+    list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: ExtensionsListOptionalParams): PagedAsyncIterableIterator<Extension>;
+}
+
+// @public (undocumented)
+export class ExtensionsClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ExtensionsClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    extensions: Extensions;
+    // (undocumented)
+    operationStatus: OperationStatus;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface ExtensionsClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ExtensionsCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ExtensionsCreateResponse = Extension;
+
+// @public
+export interface ExtensionsDeleteOptionalParams extends coreClient.OperationOptions {
+    forceDelete?: boolean;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface ExtensionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExtensionsGetResponse = Extension;
+
+// @public
+export interface ExtensionsList {
+    readonly nextLink?: string;
+    readonly value?: Extension[];
+}
+
+// @public
+export interface ExtensionsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExtensionsListNextResponse = ExtensionsList;
+
+// @public
+export interface ExtensionsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExtensionsListResponse = ExtensionsList;
+
+// @public
+export interface ExtensionStatus {
+    code?: string;
+    displayStatus?: string;
+    level?: LevelType;
+    message?: string;
+    time?: string;
+}
+
+// @public
+export interface ExtensionsUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ExtensionsUpdateResponse = Extension;
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface Identity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: "SystemAssigned";
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownLevelType {
+    Error = "Error",
+    Information = "Information",
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export type LevelType = string;
+
+// @public
+export interface OperationStatus {
+    get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, extensionName: string, operationId: string, options?: OperationStatusGetOptionalParams): Promise<OperationStatusGetResponse>;
+}
+
+// @public
+export interface OperationStatusGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationStatusGetResponse = OperationStatusResult;
+
+// @public
+export interface OperationStatusResult {
+    readonly error?: ErrorDetail;
+    id?: string;
+    name?: string;
+    properties?: {
+        [propertyName: string]: string;
+    };
+    status: string;
+}
+
+// @public
+export interface PatchExtension {
+    autoUpgradeMinorVersion?: boolean;
+    configurationProtectedSettings?: {
+        [propertyName: string]: string;
+    };
+    configurationSettings?: {
+        [propertyName: string]: string;
+    };
+    releaseTrain?: string;
+    version?: string;
+}
+
+// @public
+export interface Plan {
+    name: string;
+    product: string;
+    promotionCode?: string;
+    publisher: string;
+    version?: string;
+}
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface Scope {
+    cluster?: ScopeCluster;
+    namespace?: ScopeNamespace;
+}
+
+// @public
+export interface ScopeCluster {
+    releaseNamespace?: string;
+}
+
+// @public
+export interface ScopeNamespace {
+    targetNamespace?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```