@azure/arm-azurestack 2.1.1 → 3.0.0-beta.1

package/review/arm-azurestack.api.md

@@ -0,0 +1,695 @@
+## API Report File for "@azure/arm-azurestack"
+
+> 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 { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public
+export interface ActivationKeyResult {
+    activationKey?: string;
+}
+
+// @public (undocumented)
+export class AzureStackManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureStackManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    cloudManifestFile: CloudManifestFile;
+    // (undocumented)
+    customerSubscriptions: CustomerSubscriptions;
+    // (undocumented)
+    linkedSubscriptions: LinkedSubscriptions;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    products: Products;
+    // (undocumented)
+    registrations: Registrations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface AzureStackManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type Category = string;
+
+// @public
+export interface CloudManifestFile {
+    get(verificationVersion: string, options?: CloudManifestFileGetOptionalParams): Promise<CloudManifestFileGetResponse>;
+    list(options?: CloudManifestFileListOptionalParams): Promise<CloudManifestFileListResponse>;
+}
+
+// @public
+export interface CloudManifestFileDeploymentData {
+    customCloudArmEndpoint?: string;
+    customCloudVerificationKey?: string;
+    externalDsmsCertificates?: string;
+    externalDsmsEndpoint?: string;
+}
+
+// @public
+export interface CloudManifestFileGetOptionalParams extends coreClient.OperationOptions {
+    versionCreationDate?: string;
+}
+
+// @public
+export type CloudManifestFileGetResponse = CloudManifestFileResponse;
+
+// @public
+export interface CloudManifestFileListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CloudManifestFileListResponse = CloudManifestFileResponse;
+
+// @public
+export interface CloudManifestFileProperties {
+    deploymentData?: CloudManifestFileDeploymentData;
+    signature?: string;
+}
+
+// @public
+export type CloudManifestFileResponse = Resource & {
+    properties?: CloudManifestFileProperties;
+};
+
+// @public
+export interface Compatibility {
+    description?: string;
+    isCompatible?: boolean;
+    issues?: CompatibilityIssue[];
+    message?: string;
+}
+
+// @public
+export type CompatibilityIssue = string;
+
+// @public
+export type ComputeRole = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export type CustomerSubscription = Resource & {
+    readonly systemData?: SystemData;
+    tenantId?: string;
+};
+
+// @public
+export interface CustomerSubscriptionList {
+    nextLink?: string;
+    value?: CustomerSubscription[];
+}
+
+// @public
+export interface CustomerSubscriptions {
+    create(resourceGroup: string, registrationName: string, customerSubscriptionName: string, customerCreationParameters: CustomerSubscription, options?: CustomerSubscriptionsCreateOptionalParams): Promise<CustomerSubscriptionsCreateResponse>;
+    delete(resourceGroup: string, registrationName: string, customerSubscriptionName: string, options?: CustomerSubscriptionsDeleteOptionalParams): Promise<void>;
+    get(resourceGroup: string, registrationName: string, customerSubscriptionName: string, options?: CustomerSubscriptionsGetOptionalParams): Promise<CustomerSubscriptionsGetResponse>;
+    list(resourceGroup: string, registrationName: string, options?: CustomerSubscriptionsListOptionalParams): PagedAsyncIterableIterator<CustomerSubscription>;
+}
+
+// @public
+export interface CustomerSubscriptionsCreateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CustomerSubscriptionsCreateResponse = CustomerSubscription;
+
+// @public
+export interface CustomerSubscriptionsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface CustomerSubscriptionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CustomerSubscriptionsGetResponse = CustomerSubscription;
+
+// @public
+export interface CustomerSubscriptionsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CustomerSubscriptionsListNextResponse = CustomerSubscriptionList;
+
+// @public
+export interface CustomerSubscriptionsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CustomerSubscriptionsListResponse = CustomerSubscriptionList;
+
+// @public
+export interface DataDiskImage {
+    readonly lun?: number;
+    readonly sourceBlobSasUri?: string;
+}
+
+// @public
+export interface DeviceConfiguration {
+    readonly deviceVersion?: string;
+    readonly identitySystem?: Category;
+}
+
+// @public
+export interface Display {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface ErrorDetails {
+    readonly code?: string;
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetails;
+}
+
+// @public
+export interface ExtendedProduct {
+    readonly computeRole?: ComputeRole;
+    readonly dataDiskImages?: DataDiskImage[];
+    readonly galleryPackageBlobSasUri?: string;
+    readonly isSystemExtension?: boolean;
+    readonly osDiskImage?: OsDiskImage;
+    readonly productKind?: string;
+    readonly supportMultipleExtensions?: boolean;
+    readonly uri?: string;
+    readonly version?: string;
+    readonly versionPropertiesVersion?: string;
+    readonly vmOsType?: OperatingSystem;
+    readonly vmScaleSetEnabled?: boolean;
+}
+
+// @public
+export type ExtendedProductProperties = VirtualMachineExtensionProductProperties & VirtualMachineProductProperties & {};
+
+// @public
+export interface IconUris {
+    hero?: string;
+    large?: string;
+    medium?: string;
+    small?: string;
+    wide?: string;
+}
+
+// @public
+export enum KnownCategory {
+    // (undocumented)
+    Adfs = "ADFS",
+    // (undocumented)
+    AzureAD = "AzureAD"
+}
+
+// @public
+export enum KnownCompatibilityIssue {
+    // (undocumented)
+    AdfsIdentitySystemRequired = "ADFSIdentitySystemRequired",
+    // (undocumented)
+    AzureADIdentitySystemRequired = "AzureADIdentitySystemRequired",
+    // (undocumented)
+    CapacityBillingModelRequired = "CapacityBillingModelRequired",
+    // (undocumented)
+    ConnectionToAzureRequired = "ConnectionToAzureRequired",
+    // (undocumented)
+    ConnectionToInternetRequired = "ConnectionToInternetRequired",
+    // (undocumented)
+    DevelopmentBillingModelRequired = "DevelopmentBillingModelRequired",
+    // (undocumented)
+    DisconnectedEnvironmentRequired = "DisconnectedEnvironmentRequired",
+    // (undocumented)
+    HigherDeviceVersionRequired = "HigherDeviceVersionRequired",
+    // (undocumented)
+    LowerDeviceVersionRequired = "LowerDeviceVersionRequired",
+    // (undocumented)
+    PayAsYouGoBillingModelRequired = "PayAsYouGoBillingModelRequired"
+}
+
+// @public
+export enum KnownComputeRole {
+    // (undocumented)
+    IaaS = "IaaS",
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    PaaS = "PaaS"
+}
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownLocation {
+    // (undocumented)
+    Global = "global"
+}
+
+// @public
+export enum KnownOperatingSystem {
+    // (undocumented)
+    Linux = "Linux",
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    Windows = "Windows"
+}
+
+// @public
+export type LinkedSubscription = TrackedResource & {
+    linkedSubscriptionId?: string;
+    registrationResourceId?: string;
+    readonly deviceId?: string;
+    readonly deviceObjectId?: string;
+    readonly deviceLinkState?: string;
+    readonly lastConnectedTime?: string;
+    readonly deviceConnectionStatus?: string;
+};
+
+// @public
+export interface LinkedSubscriptionParameter {
+    linkedSubscriptionId: string;
+    location: Location_2;
+    registrationResourceId: string;
+}
+
+// @public
+export interface LinkedSubscriptions {
+    createOrUpdate(resourceGroup: string, linkedSubscriptionName: string, resource: LinkedSubscriptionParameter, options?: LinkedSubscriptionsCreateOrUpdateOptionalParams): Promise<LinkedSubscriptionsCreateOrUpdateResponse>;
+    delete(resourceGroup: string, linkedSubscriptionName: string, options?: LinkedSubscriptionsDeleteOptionalParams): Promise<void>;
+    get(resourceGroup: string, linkedSubscriptionName: string, options?: LinkedSubscriptionsGetOptionalParams): Promise<LinkedSubscriptionsGetResponse>;
+    listByResourceGroup(resourceGroup: string, options?: LinkedSubscriptionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<LinkedSubscription>;
+    listBySubscription(options?: LinkedSubscriptionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<LinkedSubscription>;
+    update(resourceGroup: string, linkedSubscriptionName: string, resource: LinkedSubscriptionParameter, options?: LinkedSubscriptionsUpdateOptionalParams): Promise<LinkedSubscriptionsUpdateResponse>;
+}
+
+// @public
+export interface LinkedSubscriptionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsCreateOrUpdateResponse = LinkedSubscription;
+
+// @public
+export interface LinkedSubscriptionsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface LinkedSubscriptionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsGetResponse = LinkedSubscription;
+
+// @public
+export interface LinkedSubscriptionsList {
+    nextLink?: string;
+    value?: LinkedSubscription[];
+}
+
+// @public
+export interface LinkedSubscriptionsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsListByResourceGroupNextResponse = LinkedSubscriptionsList;
+
+// @public
+export interface LinkedSubscriptionsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsListByResourceGroupResponse = LinkedSubscriptionsList;
+
+// @public
+export interface LinkedSubscriptionsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsListBySubscriptionNextResponse = LinkedSubscriptionsList;
+
+// @public
+export interface LinkedSubscriptionsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsListBySubscriptionResponse = LinkedSubscriptionsList;
+
+// @public
+export interface LinkedSubscriptionsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LinkedSubscriptionsUpdateResponse = LinkedSubscription;
+
+// @public
+type Location_2 = string;
+export { Location_2 as Location }
+
+// @public
+export interface MarketplaceProductLogUpdate {
+    readonly details?: string;
+    readonly error?: string;
+    readonly operation?: string;
+    readonly status?: string;
+}
+
+// @public
+export type OperatingSystem = string;
+
+// @public
+export interface Operation {
+    display?: Display;
+    name?: string;
+    origin?: string;
+}
+
+// @public
+export interface OperationList {
+    nextLink?: string;
+    value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationList;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationList;
+
+// @public
+export interface OsDiskImage {
+    readonly operatingSystem?: OperatingSystem;
+    readonly sourceBlobSasUri?: string;
+}
+
+// @public
+export type Product = Resource & {
+    readonly systemData?: SystemData;
+    displayName?: string;
+    description?: string;
+    publisherDisplayName?: string;
+    publisherIdentifier?: string;
+    offer?: string;
+    offerVersion?: string;
+    sku?: string;
+    billingPartNumber?: string;
+    vmExtensionType?: string;
+    galleryItemIdentity?: string;
+    iconUris?: IconUris;
+    links?: ProductLink[];
+    legalTerms?: string;
+    privacyPolicy?: string;
+    payloadLength?: number;
+    productKind?: string;
+    productProperties?: ProductProperties;
+    compatibility?: Compatibility;
+};
+
+// @public
+export interface ProductLink {
+    displayName?: string;
+    uri?: string;
+}
+
+// @public
+export interface ProductList {
+    nextLink?: string;
+    value?: Product[];
+}
+
+// @public
+export interface ProductLog {
+    readonly details?: string;
+    readonly endDate?: string;
+    readonly error?: string;
+    readonly id?: string;
+    readonly operation?: string;
+    readonly productId?: string;
+    readonly registrationName?: string;
+    readonly resourceGroupName?: string;
+    readonly startDate?: string;
+    readonly status?: string;
+    readonly subscriptionId?: string;
+}
+
+// @public
+export interface ProductProperties {
+    version?: string;
+}
+
+// @public
+export interface Products {
+    get(resourceGroup: string, registrationName: string, productName: string, options?: ProductsGetOptionalParams): Promise<ProductsGetResponse>;
+    getProduct(resourceGroup: string, registrationName: string, productName: string, options?: ProductsGetProductOptionalParams): Promise<ProductsGetProductResponse>;
+    getProducts(resourceGroup: string, registrationName: string, productName: string, options?: ProductsGetProductsOptionalParams): Promise<ProductsGetProductsResponse>;
+    list(resourceGroup: string, registrationName: string, options?: ProductsListOptionalParams): PagedAsyncIterableIterator<Product>;
+    listDetails(resourceGroup: string, registrationName: string, productName: string, options?: ProductsListDetailsOptionalParams): Promise<ProductsListDetailsResponse>;
+    uploadLog(resourceGroup: string, registrationName: string, productName: string, options?: ProductsUploadLogOptionalParams): Promise<ProductsUploadLogResponse>;
+}
+
+// @public
+export interface ProductsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ProductsGetProductOptionalParams extends coreClient.OperationOptions {
+    deviceConfiguration?: DeviceConfiguration;
+}
+
+// @public
+export type ProductsGetProductResponse = Product;
+
+// @public
+export interface ProductsGetProductsOptionalParams extends coreClient.OperationOptions {
+    deviceConfiguration?: DeviceConfiguration;
+}
+
+// @public
+export type ProductsGetProductsResponse = ProductList;
+
+// @public
+export type ProductsGetResponse = Product;
+
+// @public
+export interface ProductsListDetailsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProductsListDetailsResponse = ExtendedProduct;
+
+// @public
+export interface ProductsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProductsListNextResponse = ProductList;
+
+// @public
+export interface ProductsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProductsListResponse = ProductList;
+
+// @public
+export interface ProductsUploadLogOptionalParams extends coreClient.OperationOptions {
+    marketplaceProductLogUpdate?: MarketplaceProductLogUpdate;
+}
+
+// @public
+export type ProductsUploadLogResponse = ProductLog;
+
+// @public
+export type ProvisioningState = "Creating" | "Failed" | "Succeeded" | "Canceled";
+
+// @public
+export type Registration = TrackedResource & {
+    objectId?: string;
+    cloudId?: string;
+    billingModel?: string;
+};
+
+// @public
+export interface RegistrationList {
+    nextLink?: string;
+    value?: Registration[];
+}
+
+// @public
+export interface RegistrationParameter {
+    location: Location_2;
+    registrationToken: string;
+}
+
+// @public
+export interface Registrations {
+    createOrUpdate(resourceGroup: string, registrationName: string, token: RegistrationParameter, options?: RegistrationsCreateOrUpdateOptionalParams): Promise<RegistrationsCreateOrUpdateResponse>;
+    delete(resourceGroup: string, registrationName: string, options?: RegistrationsDeleteOptionalParams): Promise<void>;
+    enableRemoteManagement(resourceGroup: string, registrationName: string, options?: RegistrationsEnableRemoteManagementOptionalParams): Promise<void>;
+    get(resourceGroup: string, registrationName: string, options?: RegistrationsGetOptionalParams): Promise<RegistrationsGetResponse>;
+    getActivationKey(resourceGroup: string, registrationName: string, options?: RegistrationsGetActivationKeyOptionalParams): Promise<RegistrationsGetActivationKeyResponse>;
+    list(resourceGroup: string, options?: RegistrationsListOptionalParams): PagedAsyncIterableIterator<Registration>;
+    listBySubscription(options?: RegistrationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Registration>;
+    update(resourceGroup: string, registrationName: string, token: RegistrationParameter, options?: RegistrationsUpdateOptionalParams): Promise<RegistrationsUpdateResponse>;
+}
+
+// @public
+export interface RegistrationsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsCreateOrUpdateResponse = Registration;
+
+// @public
+export interface RegistrationsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface RegistrationsEnableRemoteManagementOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface RegistrationsGetActivationKeyOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsGetActivationKeyResponse = ActivationKeyResult;
+
+// @public
+export interface RegistrationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsGetResponse = Registration;
+
+// @public
+export interface RegistrationsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsListBySubscriptionNextResponse = RegistrationList;
+
+// @public
+export interface RegistrationsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsListBySubscriptionResponse = RegistrationList;
+
+// @public
+export interface RegistrationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsListNextResponse = RegistrationList;
+
+// @public
+export interface RegistrationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsListResponse = RegistrationList;
+
+// @public
+export interface RegistrationsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RegistrationsUpdateResponse = Registration;
+
+// @public
+export interface Resource {
+    etag?: string;
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource {
+    etag?: string;
+    readonly id?: string;
+    readonly kind?: string;
+    location: Location_2;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface VirtualMachineExtensionProductProperties {
+    readonly computeRole?: ComputeRole;
+    readonly isSystemExtension?: boolean;
+    readonly supportMultipleExtensions?: boolean;
+    readonly uri?: string;
+    readonly version?: string;
+    readonly vmOsType?: OperatingSystem;
+    readonly vmScaleSetEnabled?: boolean;
+}
+
+// @public
+export interface VirtualMachineProductProperties {
+    readonly dataDiskImages?: DataDiskImage[];
+    readonly osDiskImage?: OsDiskImage;
+    readonly version?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```