arm-planetarycomputer-node.api.md

API Report File for "@azure/arm-planetarycomputer"

Do not edit this file. It is a report generated by API Extractor.

import type { AbortSignalLike } from '@azure/abort-controller';
import type { ClientOptions } from '@azure-rest/core-client';
import type { OperationOptions } from '@azure-rest/core-client';
import type { OperationState } from '@azure/core-lro';
import type { PathUncheckedResponse } from '@azure-rest/core-client';
import type { Pipeline } from '@azure/core-rest-pipeline';
import type { PollerLike } from '@azure/core-lro';
import type { TokenCredential } from '@azure/core-auth';

// @public
export type AutoGeneratedDomainNameLabelScope = string;

// @public
export enum AzureClouds {
    AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
    AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
    AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
}

// @public
export type AzureSupportedClouds = `${AzureClouds}`;

// @public
export type CatalogTier = string;

// @public
export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
    continuationToken?: string;
};

// @public
export type CreatedByType = string;

// @public
export interface ErrorAdditionalInfo {
    readonly info?: any;
    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 GeoCatalog extends TrackedResource {
    identity?: ManagedServiceIdentity;
    properties?: GeoCatalogProperties;
}

// @public
export interface GeoCatalogProperties {
    autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope;
    readonly catalogUri?: string;
    readonly provisioningState?: ProvisioningState;
    tier?: CatalogTier;
}

// @public
export interface GeoCatalogsCreateOptionalParams extends OperationOptions {
    updateIntervalInMs?: number;
}

// @public
export interface GeoCatalogsDeleteOptionalParams extends OperationOptions {
    updateIntervalInMs?: number;
}

// @public
export interface GeoCatalogsGetOptionalParams extends OperationOptions {
}

// @public
export interface GeoCatalogsListByResourceGroupOptionalParams extends OperationOptions {
}

// @public
export interface GeoCatalogsListBySubscriptionOptionalParams extends OperationOptions {
}

// @public
export interface GeoCatalogsOperations {
    create: (resourceGroupName: string, catalogName: string, resource: GeoCatalog, options?: GeoCatalogsCreateOptionalParams) => PollerLike<OperationState<GeoCatalog>, GeoCatalog>;
    delete: (resourceGroupName: string, catalogName: string, options?: GeoCatalogsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
    get: (resourceGroupName: string, catalogName: string, options?: GeoCatalogsGetOptionalParams) => Promise<GeoCatalog>;
    listByResourceGroup: (resourceGroupName: string, options?: GeoCatalogsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<GeoCatalog>;
    listBySubscription: (options?: GeoCatalogsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<GeoCatalog>;
    update: (resourceGroupName: string, catalogName: string, properties: GeoCatalogUpdate, options?: GeoCatalogsUpdateOptionalParams) => PollerLike<OperationState<GeoCatalog>, GeoCatalog>;
}

// @public
export interface GeoCatalogsUpdateOptionalParams extends OperationOptions {
    updateIntervalInMs?: number;
}

// @public
export interface GeoCatalogUpdate {
    identity?: ManagedServiceIdentityUpdate;
    tags?: Record<string, string>;
}

// @public
export enum KnownAutoGeneratedDomainNameLabelScope {
    NoReuse = "NoReuse",
    ResourceGroupReuse = "ResourceGroupReuse",
    SubscriptionReuse = "SubscriptionReuse",
    TenantReuse = "TenantReuse"
}

// @public
export enum KnownCatalogTier {
    Basic = "Basic"
}

// @public
export enum KnownCreatedByType {
    Application = "Application",
    Key = "Key",
    ManagedIdentity = "ManagedIdentity",
    User = "User"
}

// @public
export enum KnownManagedServiceIdentityType {
    None = "None",
    SystemAssigned = "SystemAssigned",
    SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
    UserAssigned = "UserAssigned"
}

// @public
export enum KnownProvisioningState {
    Accepted = "Accepted",
    Canceled = "Canceled",
    Deleting = "Deleting",
    Failed = "Failed",
    Provisioning = "Provisioning",
    Succeeded = "Succeeded",
    Updating = "Updating"
}

// @public
export enum KnownVersions {
    _20260415 = "2026-04-15"
}

// @public
export interface ManagedServiceIdentity {
    readonly principalId?: string;
    readonly tenantId?: string;
    type: ManagedServiceIdentityType;
    userAssignedIdentities?: Record<string, UserAssignedIdentity>;
}

// @public
export type ManagedServiceIdentityType = string;

// @public
export interface ManagedServiceIdentityUpdate {
    type?: ManagedServiceIdentityType;
    userAssignedIdentities?: Record<string, UserAssignedIdentity>;
}

// @public
export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
    next(): Promise<IteratorResult<TElement>>;
}

// @public
export interface PageSettings {
    continuationToken?: string;
}

// @public
export type ProvisioningState = string;

// @public
export interface Resource {
    readonly id?: string;
    readonly name?: string;
    readonly systemData?: SystemData;
    readonly type?: string;
}

// @public
export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: SpatioClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;

// @public (undocumented)
export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
    abortSignal?: AbortSignalLike;
    processResponseBody?: (result: TResponse) => Promise<TResult>;
    updateIntervalInMs?: number;
}

// @public (undocumented)
export class SpatioClient {
    constructor(credential: TokenCredential, subscriptionId: string, options?: SpatioClientOptionalParams);
    readonly geoCatalogs: GeoCatalogsOperations;
    readonly pipeline: Pipeline;
}

// @public
export interface SpatioClientOptionalParams extends ClientOptions {
    apiVersion?: string;
    cloudSetting?: AzureSupportedClouds;
}

// @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?: Record<string, string>;
}

// @public
export interface UserAssignedIdentity {
    readonly clientId?: string;
    readonly principalId?: string;
}

// (No @packageDocumentation comment for this package)