@azure/arm-programmableconnectivity 1.0.0-alpha.20250505.1

package/review/arm-programmableconnectivity-models.api.md

@@ -0,0 +1,232 @@
+## API Report File for "@azure/arm-programmableconnectivity"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type AccountType = string;
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface ApplicationProperties {
+    applicationDescription?: string;
+    applicationType?: string;
+    legalName?: string;
+    name?: string;
+    organizationDescription?: string;
+    privacyContactEmailAddress?: string;
+    taxNumber?: string;
+}
+
+// @public
+export type CreatedByType = 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 Gateway extends TrackedResource {
+    properties?: GatewayProperties;
+}
+
+// @public
+export interface GatewayProperties {
+    readonly gatewayBaseUrl?: string;
+    readonly operatorApiConnections?: string[];
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface GatewayTagsUpdate {
+    tags?: Record<string, string>;
+}
+
+// @public
+export enum KnownAccountType {
+    AzureManaged = "AzureManaged",
+    UserManaged = "UserManaged"
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Provisioning = "Provisioning",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownVersions {
+    V20240115Preview = "2024-01-15-preview"
+}
+
+// @public
+export interface MarketplaceProperties {
+    legacyOfferId?: string;
+    offerId?: string;
+    planId?: string;
+    publisherId?: string;
+    termId?: string;
+}
+
+// @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 OperatorApiConnection extends TrackedResource {
+    properties?: OperatorApiConnectionProperties;
+}
+
+// @public
+export interface OperatorApiConnectionProperties {
+    accountType: AccountType;
+    appId?: string;
+    appSecret?: string;
+    readonly camaraApiName?: string;
+    configuredApplication?: ApplicationProperties;
+    gatewayId: string;
+    operatorApiPlanId: string;
+    readonly operatorName?: string;
+    readonly provisioningState?: ProvisioningState;
+    saasProperties?: SaasProperties;
+    readonly status?: Status;
+}
+
+// @public
+export interface OperatorApiConnectionUpdate {
+    properties?: OperatorApiConnectionUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface OperatorApiConnectionUpdateProperties {
+    appId?: string;
+    appSecret?: string;
+    configuredApplication?: ApplicationProperties;
+    operatorApiPlanId?: string;
+    saasProperties?: SaasProperties;
+}
+
+// @public
+export interface OperatorApiPlan extends ProxyResource {
+    properties?: OperatorApiPlanProperties;
+}
+
+// @public
+export interface OperatorApiPlanProperties {
+    camaraApiName?: string;
+    limits?: string;
+    marketplaceProperties?: MarketplaceProperties;
+    markets?: string[];
+    operatorName?: string;
+    operatorRegions?: string[];
+    readonly provisioningState?: ProvisioningState;
+    supportedLocations?: string[];
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export type ProvisioningState = 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 SaasProperties {
+    saasResourceId?: string;
+    saasSubscriptionId?: string;
+}
+
+// @public
+export interface Status {
+    reason?: string;
+    state?: 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?: Record<string, string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/review/arm-programmableconnectivity.api.md

@@ -0,0 +1,382 @@
+## API Report File for "@azure/arm-programmableconnectivity"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PathUncheckedResponse } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { PollerLike } from '@azure/core-lro';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type AccountType = string;
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface ApplicationProperties {
+    applicationDescription?: string;
+    applicationType?: string;
+    legalName?: string;
+    name?: string;
+    organizationDescription?: string;
+    privacyContactEmailAddress?: string;
+    taxNumber?: string;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = 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 Gateway extends TrackedResource {
+    properties?: GatewayProperties;
+}
+
+// @public
+export interface GatewayProperties {
+    readonly gatewayBaseUrl?: string;
+    readonly operatorApiConnections?: string[];
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface GatewaysCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface GatewaysDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface GatewaysGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface GatewaysListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface GatewaysListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface GatewaysOperations {
+    createOrUpdate: (resourceGroupName: string, gatewayName: string, resource: Gateway, options?: GatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<Gateway>, Gateway>;
+    delete: (resourceGroupName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, gatewayName: string, options?: GatewaysGetOptionalParams) => Promise<Gateway>;
+    listByResourceGroup: (resourceGroupName: string, options?: GatewaysListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Gateway>;
+    listBySubscription: (options?: GatewaysListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Gateway>;
+    update: (resourceGroupName: string, gatewayName: string, properties: GatewayTagsUpdate, options?: GatewaysUpdateOptionalParams) => Promise<Gateway>;
+}
+
+// @public
+export interface GatewaysUpdateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface GatewayTagsUpdate {
+    tags?: Record<string, string>;
+}
+
+// @public
+export enum KnownAccountType {
+    AzureManaged = "AzureManaged",
+    UserManaged = "UserManaged"
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Provisioning = "Provisioning",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownVersions {
+    V20240115Preview = "2024-01-15-preview"
+}
+
+// @public
+export interface MarketplaceProperties {
+    legacyOfferId?: string;
+    offerId?: string;
+    planId?: string;
+    publisherId?: string;
+    termId?: string;
+}
+
+// @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 OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperatorApiConnection extends TrackedResource {
+    properties?: OperatorApiConnectionProperties;
+}
+
+// @public
+export interface OperatorApiConnectionProperties {
+    accountType: AccountType;
+    appId?: string;
+    appSecret?: string;
+    readonly camaraApiName?: string;
+    configuredApplication?: ApplicationProperties;
+    gatewayId: string;
+    operatorApiPlanId: string;
+    readonly operatorName?: string;
+    readonly provisioningState?: ProvisioningState;
+    saasProperties?: SaasProperties;
+    readonly status?: Status;
+}
+
+// @public
+export interface OperatorApiConnectionsCreateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OperatorApiConnectionsDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OperatorApiConnectionsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperatorApiConnectionsListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperatorApiConnectionsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperatorApiConnectionsOperations {
+    create: (resourceGroupName: string, operatorApiConnectionName: string, resource: OperatorApiConnection, options?: OperatorApiConnectionsCreateOptionalParams) => PollerLike<OperationState<OperatorApiConnection>, OperatorApiConnection>;
+    delete: (resourceGroupName: string, operatorApiConnectionName: string, options?: OperatorApiConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, operatorApiConnectionName: string, options?: OperatorApiConnectionsGetOptionalParams) => Promise<OperatorApiConnection>;
+    listByResourceGroup: (resourceGroupName: string, options?: OperatorApiConnectionsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<OperatorApiConnection>;
+    listBySubscription: (options?: OperatorApiConnectionsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<OperatorApiConnection>;
+    update: (resourceGroupName: string, operatorApiConnectionName: string, properties: OperatorApiConnectionUpdate, options?: OperatorApiConnectionsUpdateOptionalParams) => PollerLike<OperationState<OperatorApiConnection>, OperatorApiConnection>;
+}
+
+// @public
+export interface OperatorApiConnectionsUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OperatorApiConnectionUpdate {
+    properties?: OperatorApiConnectionUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface OperatorApiConnectionUpdateProperties {
+    appId?: string;
+    appSecret?: string;
+    configuredApplication?: ApplicationProperties;
+    operatorApiPlanId?: string;
+    saasProperties?: SaasProperties;
+}
+
+// @public
+export interface OperatorApiPlan extends ProxyResource {
+    properties?: OperatorApiPlanProperties;
+}
+
+// @public
+export interface OperatorApiPlanProperties {
+    camaraApiName?: string;
+    limits?: string;
+    marketplaceProperties?: MarketplaceProperties;
+    markets?: string[];
+    operatorName?: string;
+    operatorRegions?: string[];
+    readonly provisioningState?: ProvisioningState;
+    supportedLocations?: string[];
+}
+
+// @public
+export interface OperatorApiPlansGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperatorApiPlansListBySubscriptionOptionalParams extends OperationOptions {
+    filter?: string;
+    skip?: number;
+    top?: number;
+}
+
+// @public
+export interface OperatorApiPlansOperations {
+    get: (operatorApiPlanName: string, options?: OperatorApiPlansGetOptionalParams) => Promise<OperatorApiPlan>;
+    listBySubscription: (options?: OperatorApiPlansListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<OperatorApiPlan>;
+}
+
+// @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 (undocumented)
+export class ProgrammableConnectivityClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: ProgrammableConnectivityClientOptionalParams);
+    readonly gateways: GatewaysOperations;
+    readonly operations: OperationsOperations;
+    readonly operatorApiConnections: OperatorApiConnectionsOperations;
+    readonly operatorApiPlans: OperatorApiPlansOperations;
+    readonly pipeline: Pipeline;
+}
+
+// @public
+export interface ProgrammableConnectivityClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export type ProvisioningState = 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 function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: ProgrammableConnectivityClient, 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
+export interface SaasProperties {
+    saasResourceId?: string;
+    saasSubscriptionId?: string;
+}
+
+// @public
+export interface Status {
+    reason?: string;
+    state?: 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?: Record<string, string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```