@azure/arm-connectedcache 1.0.0-alpha.20241127.1

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

@@ -0,0 +1,441 @@
+## API Report File for "@azure/arm-connectedcache"
+
+> 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 AdditionalCacheNodeProperties {
+    readonly aggregatedStatusCode?: number;
+    readonly aggregatedStatusDetails?: string;
+    readonly aggregatedStatusText?: string;
+    readonly autoUpdateAppliedVersion?: string;
+    readonly autoUpdateLastAppliedDateTime?: Date;
+    readonly autoUpdateLastAppliedDetails?: string;
+    readonly autoUpdateLastAppliedState?: string;
+    readonly autoUpdateLastTriggeredDateTime?: Date;
+    readonly autoUpdateNextAvailableDateTime?: Date;
+    readonly autoUpdateNextAvailableVersion?: string;
+    autoUpdateVersion?: string;
+    bgpConfiguration?: BgpConfiguration;
+    cacheNodePropertiesDetailsIssuesList?: string[];
+    readonly cacheNodeState?: number;
+    readonly cacheNodeStateDetailedText?: string;
+    readonly cacheNodeStateShortText?: string;
+    driveConfiguration?: CacheNodeDriveConfiguration[];
+    readonly isProvisioned?: boolean;
+    isProxyRequired?: ProxyRequired;
+    optionalProperty1?: string;
+    optionalProperty2?: string;
+    optionalProperty3?: string;
+    optionalProperty4?: string;
+    optionalProperty5?: string;
+    osType?: OsType;
+    readonly productVersion?: string;
+    proxyUrl?: string;
+    proxyUrlConfiguration?: ProxyUrlConfiguration;
+    updateCycleType?: CycleType;
+    updateInfoDetails?: string;
+    updateRequestedDateTime?: Date;
+}
+
+// @public
+export interface AdditionalCustomerProperties {
+    customerAsn?: string;
+    readonly customerAsnEstimatedEgressPeekGbps?: number;
+    customerEmail?: string;
+    customerEntitlementExpiration?: Date;
+    customerEntitlementSkuGuid?: string;
+    customerEntitlementSkuId?: string;
+    customerEntitlementSkuName?: string;
+    readonly customerOrgName?: string;
+    readonly customerPropertiesOverviewAverageEgressMbps?: number;
+    readonly customerPropertiesOverviewAverageMissMbps?: number;
+    readonly customerPropertiesOverviewCacheEfficiency?: number;
+    readonly customerPropertiesOverviewCacheNodesHealthyCount?: number;
+    readonly customerPropertiesOverviewCacheNodesUnhealthyCount?: number;
+    readonly customerPropertiesOverviewEgressMbpsMax?: number;
+    readonly customerPropertiesOverviewEgressMbpsMaxDateTime?: Date;
+    readonly customerPropertiesOverviewMissMbpsMax?: number;
+    readonly customerPropertiesOverviewMissMbpsMaxDateTime?: Date;
+    customerTransitAsn?: string;
+    customerTransitState?: CustomerTransitState;
+    optionalProperty1?: string;
+    optionalProperty2?: string;
+    optionalProperty3?: string;
+    optionalProperty4?: string;
+    optionalProperty5?: string;
+    readonly peeringDbLastUpdateDate?: Date;
+    readonly peeringDbLastUpdateTime?: Date;
+    readonly signupPhaseStatusCode?: number;
+    readonly signupPhaseStatusText?: string;
+    readonly signupStatus?: boolean;
+    readonly signupStatusCode?: number;
+    readonly signupStatusText?: string;
+}
+
+// @public
+export type AutoUpdateRingType = string;
+
+// @public
+export interface BgpCidrsConfiguration {
+    readonly bgpCidrs?: string[];
+}
+
+// @public
+export interface BgpConfiguration {
+    asnToIpAddressMapping?: string;
+}
+
+// @public
+export type BgpReviewStateEnum = string;
+
+// @public
+export interface CacheNodeDriveConfiguration {
+    cacheNumber?: number;
+    nginxMapping?: string;
+    physicalPath?: string;
+    sizeInGb?: number;
+}
+
+// @public
+export interface CacheNodeEntity {
+    readonly addressSpace?: number;
+    autoUpdateRequestedDay?: number;
+    autoUpdateRequestedTime?: string;
+    autoUpdateRequestedWeek?: number;
+    autoUpdateRingType?: AutoUpdateRingType;
+    readonly bgpAddressSpace?: number;
+    readonly bgpCidrBlocksCount?: number;
+    readonly bgpCidrCsvLastUpdateTime?: Date;
+    readonly bgpFileBytesTruncated?: number;
+    readonly bgpLastReportedTime?: Date;
+    readonly bgpNumberOfRecords?: number;
+    readonly bgpNumberOfTimesUpdated?: number;
+    readonly bgpReviewFeedback?: string;
+    readonly bgpReviewState?: BgpReviewStateEnum;
+    readonly bgpReviewStateText?: string;
+    cacheNodeId?: string;
+    cacheNodeName?: string;
+    readonly category?: string;
+    cidrCsv?: string[];
+    readonly cidrCsvLastUpdateTime?: Date;
+    cidrSelectionType?: number;
+    readonly clientTenantId?: string;
+    readonly configurationState?: ConfigurationState;
+    readonly configurationStateText?: string;
+    readonly containerConfigurations?: string;
+    readonly containerResyncTrigger?: number;
+    readonly createAsyncOperationId?: string;
+    customerAsn?: number;
+    readonly customerId?: string;
+    customerIndex?: string;
+    customerName?: string;
+    readonly deleteAsyncOperationId?: string;
+    fullyQualifiedDomainName?: string;
+    fullyQualifiedResourceId?: string;
+    readonly imageUri?: string;
+    ipAddress?: string;
+    isEnabled?: boolean;
+    isEnterpriseManaged?: boolean;
+    readonly isFrozen?: boolean;
+    readonly lastSyncWithAzureTimestamp?: Date;
+    readonly lastUpdatedTimestamp?: Date;
+    maxAllowableEgressInMbps?: number;
+    readonly maxAllowableProbability?: number;
+    readonly releaseVersion?: number;
+    readonly reviewFeedback?: string;
+    readonly reviewState?: number;
+    readonly reviewStateText?: string;
+    shouldMigrate?: boolean;
+    readonly synchWithAzureAttemptsCount?: number;
+    readonly workerConnections?: number;
+    readonly workerConnectionsLastUpdatedDateTime?: Date;
+    readonly xCid?: string;
+}
+
+// @public
+export interface CacheNodeInstallProperties {
+    cacheNodeId?: string;
+    customerId?: string;
+    readonly primaryAccountKey?: string;
+    readonly registrationKey?: string;
+    readonly secondaryAccountKey?: string;
+}
+
+// @public
+export interface CacheNodeOldResponse {
+    error?: ErrorDetail;
+    readonly provisioningState?: ProvisioningState;
+    readonly status?: string;
+    statusCode?: string;
+    statusDetails?: string;
+    statusText?: string;
+}
+
+// @public
+export interface CacheNodePreviewResource extends TrackedResource {
+    properties?: CacheNodeOldResponse;
+}
+
+// @public
+export interface CacheNodeProperty {
+    additionalCacheNodeProperties?: AdditionalCacheNodeProperties;
+    cacheNode?: CacheNodeEntity;
+    error?: ErrorDetail;
+    readonly provisioningState?: ProvisioningState;
+    readonly status?: string;
+    statusCode?: string;
+    statusDetails?: string;
+    statusText?: string;
+}
+
+// @public
+export type ConfigurationState = string;
+
+// @public
+export interface ConnectedCachePatchResource {
+    tags?: Record<string, string>;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface CustomerEntity {
+    clientTenantId?: string;
+    contactEmail?: string;
+    contactName?: string;
+    contactPhone?: string;
+    readonly createAsyncOperationId?: string;
+    readonly customerId?: string;
+    customerName?: string;
+    readonly deleteAsyncOperationId?: string;
+    fullyQualifiedResourceId?: string;
+    isEnterpriseManaged?: boolean;
+    isEntitled?: boolean;
+    readonly lastSyncWithAzureTimestamp?: Date;
+    releaseVersion?: number;
+    resendSignupCode?: boolean;
+    shouldMigrate?: boolean;
+    readonly synchWithAzureAttemptsCount?: number;
+    verifySignupCode?: boolean;
+    verifySignupPhrase?: string;
+}
+
+// @public
+export interface CustomerProperty {
+    additionalCustomerProperties?: AdditionalCustomerProperties;
+    customer?: CustomerEntity;
+    readonly error?: ErrorDetail;
+    readonly provisioningState?: ProvisioningState;
+    readonly status?: string;
+    readonly statusCode?: string;
+    readonly statusDetails?: string;
+    readonly statusText?: string;
+}
+
+// @public
+export type CustomerTransitState = string;
+
+// @public
+export type CycleType = string;
+
+// @public
+export interface EnterpriseMccCacheNodeResource extends TrackedResource {
+    properties?: CacheNodeProperty;
+}
+
+// @public
+export interface EnterpriseMccCustomerResource extends TrackedResource {
+    properties?: CustomerProperty;
+}
+
+// @public
+export interface EnterprisePreviewResource extends TrackedResource {
+    properties?: CacheNodeOldResponse;
+}
+
+// @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 IspCacheNodeResource extends TrackedResource {
+    properties?: CacheNodeProperty;
+}
+
+// @public
+export interface IspCustomerResource extends TrackedResource {
+    properties?: CustomerProperty;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAutoUpdateRingType {
+    Fast = "Fast",
+    Preview = "Preview",
+    Slow = "Slow"
+}
+
+// @public
+export enum KnownBgpReviewStateEnum {
+    Approved = "Approved",
+    AttentionRequired = "AttentionRequired",
+    InReview = "InReview",
+    NotConfigured = "NotConfigured"
+}
+
+// @public
+export enum KnownConfigurationState {
+    Configured = "Configured",
+    NotConfigured_Ip = "NotConfigured_Ip"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownCustomerTransitState {
+    CombinedTransit = "CombinedTransit",
+    NoTransit = "NoTransit",
+    TransitOnly = "TransitOnly"
+}
+
+// @public
+export enum KnownCycleType {
+    Fast = "Fast",
+    Preview = "Preview",
+    Slow = "Slow"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownOsType {
+    Eflow = "Eflow",
+    Linux = "Linux",
+    Windows = "Windows"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Unknown = "Unknown",
+    Upgrading = "Upgrading"
+}
+
+// @public
+export enum KnownProxyRequired {
+    None = "None",
+    Required = "Required"
+}
+
+// @public
+export enum KnownVersions {
+    v2023_05_01_preview = "2023-05-01-preview"
+}
+
+// @public
+export interface MccCacheNodeBgpCidrDetails extends TrackedResource {
+    properties?: BgpCidrsConfiguration;
+}
+
+// @public
+export interface MccCacheNodeInstallDetails extends TrackedResource {
+    properties?: CacheNodeInstallProperties;
+}
+
+// @public
+export interface Operation {
+    actionType?: ActionType;
+    readonly 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 type OsType = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export type ProxyRequired = string;
+
+// @public
+export interface ProxyUrlConfiguration {
+    proxyUrl?: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: 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)
+
+```