@azure/arm-connectedcache package

Classes

ConnectedCacheClient

Interfaces

AdditionalCacheNodeProperties	Model representing cache node for connected cache resource
AdditionalCustomerProperties	Model representing customer for connected cache resource
BgpCidrsConfiguration	Mcc cache node Bgp Cidr details.
BgpConfiguration	Bgp configuration of cache node
CacheNodeDriveConfiguration	Drive configuration for cache node
CacheNodeEntity	Model representing Cache Node for ConnectedCache resource
CacheNodeInstallProperties	Mcc cache node resource install script properties.
CacheNodeOldResponse	Model representing Cache Node for ConnectedCache resource
CacheNodePreviewResource	Concrete tracked resource types can be created by aliasing this type using a specific property type.
CacheNodeProperty	Model representing an Mcc cache node connectedCache resource
CacheNodesOperationsCreateorUpdateOptionalParams	Optional parameters.
CacheNodesOperationsDeleteOptionalParams	Optional parameters.
CacheNodesOperationsGetOptionalParams	Optional parameters.
CacheNodesOperationsListByResourceGroupOptionalParams	Optional parameters.
CacheNodesOperationsListBySubscriptionOptionalParams	Optional parameters.
CacheNodesOperationsOperations	Interface representing a CacheNodesOperations operations.
CacheNodesOperationsUpdateOptionalParams	Optional parameters.
ConnectedCacheClientOptionalParams	Optional parameters for the client.
ConnectedCachePatchResource	Mcc PATCH operation properties.
CustomerEntity	Model representing Customer resource for ConnectedCache resource
CustomerProperty	Model representing customer for connectedCache resource
EnterpriseCustomerOperationsCreateOrUpdateOptionalParams	Optional parameters.
EnterpriseCustomerOperationsDeleteOptionalParams	Optional parameters.
EnterpriseCustomerOperationsGetOptionalParams	Optional parameters.
EnterpriseCustomerOperationsListByResourceGroupOptionalParams	Optional parameters.
EnterpriseCustomerOperationsListBySubscriptionOptionalParams	Optional parameters.
EnterpriseCustomerOperationsOperations	Interface representing a EnterpriseCustomerOperations operations.
EnterpriseCustomerOperationsUpdateOptionalParams	Optional parameters.
EnterpriseMccCacheNodeResource	Represents the high level Nodes needed to provision cache node resources
EnterpriseMccCacheNodesOperationsCreateOrUpdateOptionalParams	Optional parameters.
EnterpriseMccCacheNodesOperationsDeleteOptionalParams	Optional parameters.
EnterpriseMccCacheNodesOperationsGetCacheNodeInstallDetailsOptionalParams	Optional parameters.
EnterpriseMccCacheNodesOperationsGetOptionalParams	Optional parameters.
EnterpriseMccCacheNodesOperationsListByEnterpriseMccCustomerResourceOptionalParams	Optional parameters.
EnterpriseMccCacheNodesOperationsOperations	Interface representing a EnterpriseMccCacheNodesOperations operations.
EnterpriseMccCacheNodesOperationsUpdateOptionalParams	Optional parameters.
EnterpriseMccCustomerResource	Represents the high level Nodes needed to provision customer resources
EnterpriseMccCustomersCreateOrUpdateOptionalParams	Optional parameters.
EnterpriseMccCustomersDeleteOptionalParams	Optional parameters.
EnterpriseMccCustomersGetOptionalParams	Optional parameters.
EnterpriseMccCustomersListByResourceGroupOptionalParams	Optional parameters.
EnterpriseMccCustomersListBySubscriptionOptionalParams	Optional parameters.
EnterpriseMccCustomersOperations	Interface representing a EnterpriseMccCustomers operations.
EnterpriseMccCustomersUpdateOptionalParams	Optional parameters.
EnterprisePreviewResource	ConnectedCache Resource. Represents the high level Nodes needed to provision CacheNode and customer resources used in private preview
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
IspCacheNodeResource	Represents the high level Nodes needed to provision cache node resources
IspCacheNodesOperationsCreateOrUpdateOptionalParams	Optional parameters.
IspCacheNodesOperationsDeleteOptionalParams	Optional parameters.
IspCacheNodesOperationsGetBgpCidrsOptionalParams	Optional parameters.
IspCacheNodesOperationsGetCacheNodeInstallDetailsOptionalParams	Optional parameters.
IspCacheNodesOperationsGetOptionalParams	Optional parameters.
IspCacheNodesOperationsListByIspCustomerResourceOptionalParams	Optional parameters.
IspCacheNodesOperationsOperations	Interface representing a IspCacheNodesOperations operations.
IspCacheNodesOperationsUpdateOptionalParams	Optional parameters.
IspCustomerResource	Represents the high level Nodes needed to provision isp customer resources
IspCustomersCreateOrUpdateOptionalParams	Optional parameters.
IspCustomersDeleteOptionalParams	Optional parameters.
IspCustomersGetOptionalParams	Optional parameters.
IspCustomersListByResourceGroupOptionalParams	Optional parameters.
IspCustomersListBySubscriptionOptionalParams	Optional parameters.
IspCustomersOperations	Interface representing a IspCustomers operations.
IspCustomersUpdateOptionalParams	Optional parameters.
MccCacheNodeBgpCidrDetails	Represents all Cidr details of the Bgp request for a specific cache node resource
MccCacheNodeInstallDetails	Mcc cache node resource all install details.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for and operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyUrlConfiguration	ProxyUrl configuration of cache node
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AutoUpdateRingType	Auto update Ring type <xref:KnownautoUpdateRingType> can be used interchangeably with autoUpdateRingType, this enum contains the known values that the service supports. Known values supported by the service Preview: customer selection of preview update install mcc on their physical vm Slow: customer selection of slow update to install mcc on their physical vm Fast: customer selection of fast / auto update to install mcc on their physical vm
BgpReviewStateEnum	Cache node resource Bgp review state as integer KnownBgpReviewStateEnum can be used interchangeably with BgpReviewStateEnum, this enum contains the known values that the service supports. Known values supported by the service NotConfigured: bgp not configured InReview: bgp is in review state Approved: bgp is in Approved state AttentionRequired: bgp is setup need an attention for more troubleshoot
ConfigurationState	Cache node configuration setup state KnownConfigurationState can be used interchangeably with ConfigurationState, this enum contains the known values that the service supports. Known values supported by the service Configured: connected cache setup configured NotConfigured_Ip: connected cache setup not configured
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
CustomerTransitState	Customer resource transit states KnownCustomerTransitState can be used interchangeably with CustomerTransitState, this enum contains the known values that the service supports. Known values supported by the service NoTransit: do not have transit CombinedTransit: transit provider and have own subscribers TransitOnly: pure transit provider or network service provider
CycleType	Update Cycle type KnownCycleType can be used interchangeably with CycleType, this enum contains the known values that the service supports. Known values supported by the service Preview: customer selection of preview update install mcc on their physical vm Slow: customer selection of slow update to install mcc on their physical vm Fast: customer selection of fast / auto update to install mcc on their physical vm
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
OsType	Operating System of the cache node KnownOsType can be used interchangeably with OsType, this enum contains the known values that the service supports. Known values supported by the service Windows: cache node installs on windows operating system Linux: cache node installs on Linux Operating system Eflow: cache node installs on Azure Eflow
ProvisioningState	provisioning state of the resource KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Unknown: unknown state of the provisioning state Accepted: Accepted state of the provisioning state during the Async Operations Upgrading: Upgrading state of the provisioning state Deleting: Deleting state of the provisioning state
ProxyRequired	Proxy details enum KnownProxyRequired can be used interchangeably with ProxyRequired, this enum contains the known values that the service supports. Known values supported by the service None: Proxy is not required in setup Required: proxy is required in setup

Enums

KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAutoUpdateRingType	Auto update Ring type
KnownBgpReviewStateEnum	Cache node resource Bgp review state as integer
KnownConfigurationState	Cache node configuration setup state
KnownCreatedByType	The kind of entity that created the resource.
KnownCustomerTransitState	Customer resource transit states
KnownCycleType	Update Cycle type
KnownOrigin	Known values of Origin that the service accepts.
KnownOsType	Operating System of the cache node
KnownProvisioningState	provisioning state of the resource
KnownProxyRequired	Proxy details enum
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(ConnectedCacheClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(ConnectedCacheClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ConnectedCacheClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ConnectedCacheClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>