@azure/arm-containerservicefleet 1.0.0-alpha.20230620.2

package/review/arm-containerservicefleet.api.md

@@ -0,0 +1,623 @@
+## API Report File for "@azure/arm-containerservicefleet"
+
+> 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 ActionType = string;
+
+// @public (undocumented)
+export class ContainerServiceFleetClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ContainerServiceFleetClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    fleetMembers: FleetMembers;
+    // (undocumented)
+    fleets: Fleets;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    updateRuns: UpdateRuns;
+}
+
+// @public
+export interface ContainerServiceFleetClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: 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 interface Fleet extends TrackedResource {
+    readonly eTag?: string;
+    hubProfile?: FleetHubProfile;
+    readonly provisioningState?: FleetProvisioningState;
+}
+
+// @public
+export interface FleetCredentialResult {
+    readonly name?: string;
+    readonly value?: Uint8Array;
+}
+
+// @public
+export interface FleetCredentialResults {
+    readonly kubeconfigs?: FleetCredentialResult[];
+}
+
+// @public
+export interface FleetHubProfile {
+    dnsPrefix?: string;
+    readonly fqdn?: string;
+    readonly kubernetesVersion?: string;
+}
+
+// @public
+export interface FleetListResult {
+    nextLink?: string;
+    value: Fleet[];
+}
+
+// @public
+export interface FleetMember extends ProxyResource {
+    clusterResourceId?: string;
+    readonly eTag?: string;
+    group?: string;
+    readonly provisioningState?: FleetMemberProvisioningState;
+}
+
+// @public
+export interface FleetMemberListResult {
+    nextLink?: string;
+    value: FleetMember[];
+}
+
+// @public
+export type FleetMemberProvisioningState = string;
+
+// @public
+export interface FleetMembers {
+    beginCreate(resourceGroupName: string, fleetName: string, fleetMemberName: string, resource: FleetMember, options?: FleetMembersCreateOptionalParams): Promise<SimplePollerLike<OperationState<FleetMembersCreateResponse>, FleetMembersCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, fleetName: string, fleetMemberName: string, resource: FleetMember, options?: FleetMembersCreateOptionalParams): Promise<FleetMembersCreateResponse>;
+    beginDelete(resourceGroupName: string, fleetName: string, fleetMemberName: string, options?: FleetMembersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, fleetName: string, fleetMemberName: string, options?: FleetMembersDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, fleetName: string, fleetMemberName: string, options?: FleetMembersGetOptionalParams): Promise<FleetMembersGetResponse>;
+    listByFleet(resourceGroupName: string, fleetName: string, options?: FleetMembersListByFleetOptionalParams): PagedAsyncIterableIterator<FleetMember>;
+    update(resourceGroupName: string, fleetName: string, fleetMemberName: string, properties: FleetMemberUpdate, options?: FleetMembersUpdateOptionalParams): Promise<FleetMembersUpdateResponse>;
+}
+
+// @public
+export interface FleetMembersCreateHeaders {
+    retryAfter?: number;
+}
+
+// @public
+export interface FleetMembersCreateOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    ifNoneMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type FleetMembersCreateResponse = FleetMember;
+
+// @public
+export interface FleetMembersDeleteHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface FleetMembersDeleteOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface FleetMembersGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetMembersGetResponse = FleetMember;
+
+// @public
+export interface FleetMembersListByFleetNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetMembersListByFleetNextResponse = FleetMemberListResult;
+
+// @public
+export interface FleetMembersListByFleetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetMembersListByFleetResponse = FleetMemberListResult;
+
+// @public
+export interface FleetMembersUpdateOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+}
+
+// @public
+export type FleetMembersUpdateResponse = FleetMember;
+
+// @public
+export interface FleetMemberUpdate {
+    group?: string;
+}
+
+// @public
+export interface FleetPatch {
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type FleetProvisioningState = string;
+
+// @public
+export interface Fleets {
+    beginCreateOrUpdate(resourceGroupName: string, fleetName: string, resource: Fleet, options?: FleetsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FleetsCreateOrUpdateResponse>, FleetsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, resource: Fleet, options?: FleetsCreateOrUpdateOptionalParams): Promise<FleetsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, fleetName: string, options?: FleetsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, fleetName: string, options?: FleetsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, fleetName: string, options?: FleetsGetOptionalParams): Promise<FleetsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: FleetsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Fleet>;
+    listBySubscription(options?: FleetsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Fleet>;
+    listCredentials(resourceGroupName: string, fleetName: string, options?: FleetsListCredentialsOptionalParams): Promise<FleetsListCredentialsResponse>;
+    update(resourceGroupName: string, fleetName: string, properties: FleetPatch, options?: FleetsUpdateOptionalParams): Promise<FleetsUpdateResponse>;
+}
+
+// @public
+export interface FleetsCreateOrUpdateHeaders {
+    retryAfter?: number;
+}
+
+// @public
+export interface FleetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    ifNoneMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type FleetsCreateOrUpdateResponse = Fleet;
+
+// @public
+export interface FleetsDeleteHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface FleetsDeleteOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface FleetsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetsGetResponse = Fleet;
+
+// @public
+export interface FleetsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetsListByResourceGroupNextResponse = FleetListResult;
+
+// @public
+export interface FleetsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetsListByResourceGroupResponse = FleetListResult;
+
+// @public
+export interface FleetsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetsListBySubscriptionNextResponse = FleetListResult;
+
+// @public
+export interface FleetsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetsListBySubscriptionResponse = FleetListResult;
+
+// @public
+export interface FleetsListCredentialsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FleetsListCredentialsResponse = FleetCredentialResults;
+
+// @public
+export interface FleetsUpdateOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+}
+
+// @public
+export type FleetsUpdateResponse = Fleet;
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownFleetMemberProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Joining = "Joining",
+    Leaving = "Leaving",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownFleetProvisioningState {
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownManagedClusterUpgradeType {
+    Full = "Full",
+    NodeImageOnly = "NodeImageOnly"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownUpdateRunProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownUpdateState {
+    Completed = "Completed",
+    Failed = "Failed",
+    NotStarted = "NotStarted",
+    Running = "Running",
+    Stopped = "Stopped",
+    Stopping = "Stopping"
+}
+
+// @public
+export interface ManagedClusterUpdate {
+    upgrade: ManagedClusterUpgradeSpec;
+}
+
+// @public
+export interface ManagedClusterUpgradeSpec {
+    kubernetesVersion?: string;
+    type: ManagedClusterUpgradeType;
+}
+
+// @public
+export type ManagedClusterUpgradeType = string;
+
+// @public
+export interface MemberUpdateStatus {
+    readonly clusterResourceId?: string;
+    readonly name?: string;
+    readonly operationId?: string;
+    readonly status?: UpdateStatus;
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type Origin = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface UpdateGroup {
+    name: string;
+}
+
+// @public
+export interface UpdateGroupStatus {
+    readonly members?: MemberUpdateStatus[];
+    readonly name?: string;
+    readonly status?: UpdateStatus;
+}
+
+// @public
+export interface UpdateRun extends ProxyResource {
+    readonly eTag?: string;
+    managedClusterUpdate?: ManagedClusterUpdate;
+    readonly provisioningState?: UpdateRunProvisioningState;
+    readonly status?: UpdateRunStatus;
+    strategy?: UpdateRunStrategy;
+}
+
+// @public
+export interface UpdateRunListResult {
+    nextLink?: string;
+    value: UpdateRun[];
+}
+
+// @public
+export type UpdateRunProvisioningState = string;
+
+// @public
+export interface UpdateRuns {
+    beginCreateOrUpdate(resourceGroupName: string, fleetName: string, updateRunName: string, resource: UpdateRun, options?: UpdateRunsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRunsCreateOrUpdateResponse>, UpdateRunsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, resource: UpdateRun, options?: UpdateRunsCreateOrUpdateOptionalParams): Promise<UpdateRunsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsDeleteOptionalParams): Promise<void>;
+    beginStart(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStartOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRunsStartResponse>, UpdateRunsStartResponse>>;
+    beginStartAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStartOptionalParams): Promise<UpdateRunsStartResponse>;
+    beginStop(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStopOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRunsStopResponse>, UpdateRunsStopResponse>>;
+    beginStopAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStopOptionalParams): Promise<UpdateRunsStopResponse>;
+    get(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsGetOptionalParams): Promise<UpdateRunsGetResponse>;
+    listByFleet(resourceGroupName: string, fleetName: string, options?: UpdateRunsListByFleetOptionalParams): PagedAsyncIterableIterator<UpdateRun>;
+}
+
+// @public
+export interface UpdateRunsCreateOrUpdateHeaders {
+    retryAfter?: number;
+}
+
+// @public
+export interface UpdateRunsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    ifNoneMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type UpdateRunsCreateOrUpdateResponse = UpdateRun;
+
+// @public
+export interface UpdateRunsDeleteHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface UpdateRunsDeleteOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface UpdateRunsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type UpdateRunsGetResponse = UpdateRun;
+
+// @public
+export interface UpdateRunsListByFleetNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type UpdateRunsListByFleetNextResponse = UpdateRunListResult;
+
+// @public
+export interface UpdateRunsListByFleetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type UpdateRunsListByFleetResponse = UpdateRunListResult;
+
+// @public
+export interface UpdateRunsStartHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface UpdateRunsStartOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type UpdateRunsStartResponse = UpdateRun;
+
+// @public
+export interface UpdateRunsStopHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface UpdateRunsStopOptionalParams extends coreClient.OperationOptions {
+    ifMatch?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type UpdateRunsStopResponse = UpdateRun;
+
+// @public
+export interface UpdateRunStatus {
+    readonly stages?: UpdateStageStatus[];
+    readonly status?: UpdateStatus;
+}
+
+// @public
+export interface UpdateRunStrategy {
+    stages: UpdateStage[];
+}
+
+// @public
+export interface UpdateStage {
+    afterStageWaitInSeconds?: number;
+    groups?: UpdateGroup[];
+    name: string;
+}
+
+// @public
+export interface UpdateStageStatus {
+    readonly afterStageWaitStatus?: WaitStatus;
+    readonly groups?: UpdateGroupStatus[];
+    readonly name?: string;
+    readonly status?: UpdateStatus;
+}
+
+// @public
+export type UpdateState = string;
+
+// @public
+export interface UpdateStatus {
+    readonly completedTime?: Date;
+    readonly error?: ErrorDetail;
+    readonly startTime?: Date;
+    readonly state?: UpdateState;
+}
+
+// @public
+export interface WaitStatus {
+    readonly status?: UpdateStatus;
+    readonly waitDurationInSeconds?: number;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```