@azure/arm-edgezones 1.0.0-beta.1

package/review/arm-edgezones.api.md

@@ -0,0 +1,209 @@
+## API Report File for "@azure/arm-edgezones"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public (undocumented)
+export class EdgeZonesClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: EdgeZonesClientOptionalParams);
+    readonly extendedZones: ExtendedZonesOperations;
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+}
+
+// @public
+export interface EdgeZonesClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, 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 ExtendedZone extends ProxyResource {
+    properties?: ExtendedZoneProperties;
+}
+
+// @public
+export interface ExtendedZoneProperties {
+    readonly displayName: string;
+    readonly geography: string;
+    readonly geographyGroup: string;
+    readonly homeLocation: string;
+    readonly latitude: string;
+    readonly longitude: string;
+    readonly provisioningState?: ProvisioningState;
+    readonly regionalDisplayName: string;
+    readonly regionCategory: string;
+    readonly regionType: string;
+    readonly registrationState?: RegistrationState;
+}
+
+// @public
+export interface ExtendedZonesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ExtendedZonesListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ExtendedZonesOperations {
+    get: (extendedZoneName: string, options?: ExtendedZonesGetOptionalParams) => Promise<ExtendedZone>;
+    listBySubscription: (options?: ExtendedZonesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ExtendedZone>;
+    register: (extendedZoneName: string, options?: ExtendedZonesRegisterOptionalParams) => Promise<ExtendedZone>;
+    unregister: (extendedZoneName: string, options?: ExtendedZonesUnregisterOptionalParams) => Promise<ExtendedZone>;
+}
+
+// @public
+export interface ExtendedZonesRegisterOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ExtendedZonesUnregisterOptionalParams extends OperationOptions {
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    "user,system" = "user,system",
+    system = "system",
+    user = "user"
+}
+
+// @public
+export enum KnownRegistrationState {
+    NotRegistered = "NotRegistered",
+    PendingRegister = "PendingRegister",
+    PendingUnregister = "PendingUnregister",
+    Registered = "Registered"
+}
+
+// @public
+export enum KnownResourceProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export interface Operation {
+    actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export type Origin = string;
+
+// @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 | ResourceProvisioningState | "Provisioning" | "Updating" | "Deleting" | "Accepted";
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export type RegistrationState = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceProvisioningState = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```