@azure/arm-purestorageblock 1.0.0-beta.1

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

@@ -0,0 +1,591 @@
+## API Report File for "@azure/arm-purestorageblock"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface Address {
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    country: string;
+    postalCode: string;
+    state: string;
+}
+
+// @public
+export interface Alert {
+    level: AlertLevel;
+    message: string;
+}
+
+// @public
+export type AlertLevel = string;
+
+// @public
+export interface AvsConnection {
+    serviceInitializationCompleted: boolean;
+    serviceInitializationHandle?: ServiceInitializationHandle;
+    serviceInitializationHandleEnc?: string;
+}
+
+// @public
+export interface AvsDiskDetails {
+    avsStorageContainerResourceId: string;
+    avsVmInternalId: string;
+    avsVmName: string;
+    avsVmResourceId: string;
+    diskId: string;
+    diskName: string;
+    folder: string;
+}
+
+// @public
+export interface AvsStatus {
+    avsEnabled: boolean;
+    clusterResourceId?: string;
+    currentConnectionStatus: string;
+}
+
+// @public
+export interface AvsStorageContainer extends ProxyResource {
+    properties?: AvsStorageContainerProperties;
+}
+
+// @public
+export interface AvsStorageContainerProperties {
+    readonly datastore?: string;
+    readonly mounted?: boolean;
+    provisionedLimit?: number;
+    readonly resourceName: string;
+    readonly space?: Space;
+}
+
+// @public
+export interface AvsStorageContainerVolume extends ProxyResource {
+    properties?: VolumeProperties;
+}
+
+// @public
+export interface AvsStorageContainerVolumeUpdate {
+    properties?: AvsStorageContainerVolumeUpdateProperties;
+}
+
+// @public
+export interface AvsStorageContainerVolumeUpdateProperties {
+    softDeletion?: SoftDeletion;
+}
+
+// @public
+export interface AvsVm extends ProxyResource {
+    properties?: AvsVmProperties;
+}
+
+// @public
+export interface AvsVmDetails {
+    avsVmInternalId: string;
+    vmId: string;
+    vmName: string;
+    vmType: VmType;
+}
+
+// @public
+export interface AvsVmProperties {
+    readonly avs?: AvsVmDetails;
+    readonly createdTimestamp?: string;
+    readonly displayName?: string;
+    readonly provisioningState?: ResourceProvisioningState;
+    softDeletion?: SoftDeletion;
+    readonly space?: Space;
+    readonly storagePoolInternalId?: string;
+    readonly storagePoolResourceId?: string;
+    readonly volumeContainerType?: VolumeContainerType;
+}
+
+// @public
+export interface AvsVmUpdate {
+    properties?: AvsVmUpdateProperties;
+}
+
+// @public
+export interface AvsVmUpdateProperties {
+    softDeletion?: SoftDeletion;
+}
+
+// @public
+export interface AvsVmVolume extends ProxyResource {
+    properties?: VolumeProperties;
+}
+
+// @public
+export interface AvsVmVolumeUpdate {
+    properties?: AvsVmVolumeUpdateProperties;
+}
+
+// @public
+export interface AvsVmVolumeUpdateProperties {
+    softDeletion?: SoftDeletion;
+}
+
+// @public
+export interface AzureVmwareService {
+    avsEnabled: boolean;
+    clusterResourceId?: string;
+}
+
+// @public
+export interface BandwidthUsage {
+    current: number;
+    max: number;
+    provisioned: number;
+}
+
+// @public
+export interface BillingUsageProperty {
+    currentValue: string;
+    previousValue?: string;
+    propertyId: string;
+    propertyName: string;
+    severity: UsageSeverity;
+    statusMessage?: string;
+    subProperties?: BillingUsageProperty[];
+}
+
+// @public
+export interface CompanyDetails {
+    address?: Address;
+    companyName: 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 HealthDetails {
+    bandwidthUsage: BandwidthUsage;
+    dataReductionRatio: number;
+    estimatedMaxCapacity: number;
+    iopsUsage: IopsUsage;
+    space: Space;
+    usedCapacityPercentage: number;
+}
+
+// @public
+export interface IopsUsage {
+    current: number;
+    max: number;
+    provisioned: number;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAlertLevel {
+    Error = "error",
+    Info = "info",
+    Warning = "warning"
+}
+
+// @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 KnownMarketplaceSubscriptionStatus {
+    PendingFulfillmentStart = "PendingFulfillmentStart",
+    Subscribed = "Subscribed",
+    Suspended = "Suspended",
+    Unsubscribed = "Unsubscribed"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownResourceProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownUsageSeverity {
+    Alert = "alert",
+    Information = "information",
+    None = "none",
+    Warning = "warning"
+}
+
+// @public
+export enum KnownVersions {
+    V1Preview = "2024-10-01-preview",
+    V2Preview = "2024-11-01-preview"
+}
+
+// @public
+export enum KnownVmType {
+    VVol = "vvol"
+}
+
+// @public
+export enum KnownVolumeContainerType {
+    AVS = "avs"
+}
+
+// @public
+export enum KnownVolumeType {
+    AVS = "avs"
+}
+
+// @public
+export interface LimitDetails {
+    performancePolicy: PerformancePolicyLimits;
+    protectionPolicy: ProtectionPolicyLimits;
+    storagePool: StoragePoolLimits;
+    volume: VolumeLimits;
+}
+
+// @public
+export interface ManagedServiceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ManagedServiceIdentityType;
+    userAssignedIdentities?: Record<string, UserAssignedIdentity | null>;
+}
+
+// @public
+export type ManagedServiceIdentityType = string;
+
+// @public
+export interface MarketplaceDetails {
+    offerDetails: OfferDetails;
+    readonly subscriptionId?: string;
+    subscriptionStatus?: MarketplaceSubscriptionStatus;
+}
+
+// @public
+export type MarketplaceSubscriptionStatus = string;
+
+// @public
+export interface OfferDetails {
+    offerId: string;
+    planId: string;
+    planName?: string;
+    publisherId: string;
+    termId?: string;
+    termUnit?: 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 type Origin = string;
+
+// @public
+export interface PerformancePolicyLimits {
+    bandwidthLimit: RangeLimits;
+    iopsLimit: RangeLimits;
+}
+
+// @public
+export interface ProtectionPolicyLimits {
+    frequency: RangeLimits;
+    retention: RangeLimits;
+}
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface RangeLimits {
+    max: number;
+    min: number;
+}
+
+// @public
+export interface Reservation extends TrackedResource {
+    properties?: ReservationPropertiesBaseResourceProperties;
+}
+
+// @public
+export interface ReservationBillingStatus {
+    drrWeightedAverage: number;
+    extraUsedCapacityLowUsageRounding: number;
+    extraUsedCapacityNonReducible: number;
+    extraUsedCapacityNonReduciblePlanDiscount: number;
+    lowDrrPoolCount: number;
+    timestamp: string;
+    totalNonReducibleReported: number;
+    totalPerformanceIncludedPlan: number;
+    totalPerformanceOverage: number;
+    totalPerformanceReported: number;
+    totalUsedCapacityBilled: number;
+    totalUsedCapacityIncludedPlan: number;
+    totalUsedCapacityOverage: number;
+    totalUsedCapacityReported: number;
+}
+
+// @public
+export interface ReservationBillingUsageReport {
+    billingUsageProperties: BillingUsageProperty[];
+    overallStatusMessage: string;
+    timestamp: string;
+}
+
+// @public
+export interface ReservationPropertiesBaseResourceProperties {
+    marketplace: MarketplaceDetails;
+    readonly provisioningState?: ProvisioningState;
+    readonly reservationInternalId?: string;
+    user: UserDetails;
+}
+
+// @public
+export interface ReservationUpdate {
+    properties?: ReservationUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface ReservationUpdateProperties {
+    user?: UserDetails;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceProvisioningState = string;
+
+// @public
+export interface ServiceInitializationHandle {
+    clusterResourceId?: string;
+    serviceAccountUsername?: string;
+}
+
+// @public
+export interface ServiceInitializationInfo {
+    serviceAccountPassword?: string;
+    serviceAccountUsername?: string;
+    vSphereCertificate?: string;
+    vSphereIp?: string;
+}
+
+// @public
+export interface SoftDeletion {
+    destroyed: boolean;
+    readonly eradicationTimestamp?: string;
+}
+
+// @public
+export interface Space {
+    shared: number;
+    snapshots: number;
+    totalUsed: number;
+    unique: number;
+}
+
+// @public
+export interface StoragePool extends TrackedResource {
+    identity?: ManagedServiceIdentity;
+    properties?: StoragePoolProperties;
+}
+
+// @public
+export interface StoragePoolEnableAvsConnectionPost {
+    clusterResourceId: string;
+}
+
+// @public
+export interface StoragePoolFinalizeAvsConnectionPost {
+    serviceInitializationData?: ServiceInitializationInfo;
+    serviceInitializationDataEnc?: string;
+}
+
+// @public
+export interface StoragePoolHealthInfo {
+    alerts: Alert[];
+    health: HealthDetails;
+}
+
+// @public
+export interface StoragePoolLimits {
+    physicalAvailabilityZones: string[];
+    provisionedBandwidthMbPerSec: RangeLimits;
+    provisionedIops: RangeLimits;
+}
+
+// @public
+export interface StoragePoolProperties {
+    availabilityZone: string;
+    readonly avs?: AzureVmwareService;
+    readonly dataRetentionPeriod?: number;
+    provisionedBandwidthMbPerSec: number;
+    readonly provisionedIops?: number;
+    readonly provisioningState?: ProvisioningState;
+    reservationResourceId: string;
+    readonly storagePoolInternalId?: string;
+    vnetInjection: VnetInjection;
+}
+
+// @public
+export interface StoragePoolUpdate {
+    identity?: ManagedServiceIdentity;
+    properties?: StoragePoolUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface StoragePoolUpdateProperties {
+    provisionedBandwidthMbPerSec?: number;
+}
+
+// @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 type UsageSeverity = string;
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// @public
+export interface UserDetails {
+    companyDetails?: CompanyDetails;
+    emailAddress: string;
+    firstName: string;
+    lastName: string;
+    phoneNumber?: string;
+    upn?: string;
+}
+
+// @public
+export type VmType = string;
+
+// @public
+export interface VnetInjection {
+    subnetId: string;
+    vnetId: string;
+}
+
+// @public
+export type VolumeContainerType = string;
+
+// @public
+export interface VolumeLimits {
+    provisionedSize: RangeLimits;
+}
+
+// @public
+export interface VolumeProperties {
+    readonly avs?: AvsDiskDetails;
+    readonly createdTimestamp?: string;
+    readonly displayName?: string;
+    readonly provisionedSize?: number;
+    readonly provisioningState?: ResourceProvisioningState;
+    softDeletion: SoftDeletion;
+    readonly space?: Space;
+    readonly storagePoolInternalId?: string;
+    readonly storagePoolResourceId?: string;
+    readonly volumeInternalId?: string;
+    readonly volumeType?: VolumeType;
+}
+
+// @public
+export type VolumeType = string;
+
+// (No @packageDocumentation comment for this package)
+
+```