@azure/arm-fileshares package

Classes

Interfaces

CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FileShare	File share resource
FileShareLimits	File share-related limits in the specified subscription/location.
FileShareLimitsOutput	File share limits API result.
FileShareLimitsResponse	Response structure for file share limits API.
FileShareProperties	File share properties
FileShareProvisioningConstants	Constants used for calculating recommended values of file share provisioning properties.
FileShareProvisioningRecommendationInput	File share provisioning parameters recommendation API input structure.
FileShareProvisioningRecommendationOutput	File share provisioning parameters recommendation API result.
FileShareProvisioningRecommendationRequest	Request structure for file share provisioning parameters recommendation API.
FileShareProvisioningRecommendationResponse	Response structure for file share provisioning parameters recommendation API.
FileShareSnapshot	FileShareSnapshot resource
FileShareSnapshotProperties	FileShareSnapshot properties
FileShareSnapshotUpdate	The type used for update operations of the FileShareSnapshot.
FileShareSnapshotUpdateProperties	The updatable properties of the FileShareSnapshot.
FileShareSnapshotsCreateOrUpdateFileShareSnapshotOptionalParams	Optional parameters.
FileShareSnapshotsDeleteFileShareSnapshotOptionalParams	Optional parameters.
FileShareSnapshotsGetFileShareSnapshotOptionalParams	Optional parameters.
FileShareSnapshotsListByFileShareOptionalParams	Optional parameters.
FileShareSnapshotsOperations	Interface representing a FileShareSnapshots operations.
FileShareSnapshotsUpdateFileShareSnapshotOptionalParams	Optional parameters.
FileShareUpdate	The type used for update operations of the FileShare.
FileShareUpdateProperties	The updatable properties of the FileShare.
FileShareUsageDataOutput	File shares usage result.
FileShareUsageDataResponse	Response structure for file shares usage in the specified subscription/location.
FileSharesCheckNameAvailabilityOptionalParams	Optional parameters.
FileSharesClientOptionalParams	Optional parameters for the client.
FileSharesCreateOrUpdateOptionalParams	Optional parameters.
FileSharesDeleteOptionalParams	Optional parameters.
FileSharesGetOptionalParams	Optional parameters.
FileSharesListByParentOptionalParams	Optional parameters.
FileSharesListBySubscriptionOptionalParams	Optional parameters.
FileSharesOperations	Interface representing a FileShares operations.
FileSharesUpdateOptionalParams	Optional parameters.
InformationalOperationsGetLimitsOptionalParams	Optional parameters.
InformationalOperationsGetProvisioningRecommendationOptionalParams	Optional parameters.
InformationalOperationsGetUsageDataOptionalParams	Optional parameters.
InformationalOperationsOperations	Interface representing a InformationalOperations operations.
LiveSharesUsageData	Usage data for live shares.
NfsProtocolProperties	Properties specific to the NFS protocol.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an 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.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByFileShareOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A private link resource.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PublicAccessProperties	The set of properties for control public access.
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.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CheckNameAvailabilityReason	Possible reasons for a name not being available. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid: Name is invalid. AlreadyExists: Name already exists.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. 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.
EncryptionInTransitRequired	State of NFS encryption in transit. KnownEncryptionInTransitRequired can be used interchangeably with EncryptionInTransitRequired, this enum contains the known values that the service supports. Known values supported by the service Enabled: Encryption in Transit is enabled. Disabled: Encryption in Transit is disabled.
FileShareProvisioningState	The status of file share's ProvisioningState. KnownFileShareProvisioningState can be used interchangeably with FileShareProvisioningState, 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. Provisioning: The operation is provisioning. Updating: The operation is updating. Deleting: The operation is deleting. Accepted: The operation is accepted. Created: The resource has been created. TransientFailure: The operation is in a transient failure state. Creating: The resource is being created. Patching: The resource is being patched. Posting: The resource is being posted.
MediaTier	Media Tier enum. KnownMediaTier can be used interchangeably with MediaTier, this enum contains the known values that the service supports. Known values supported by the service SSD: SSD media tier.
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: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Connection has been provisioned Creating: Connection is being created Deleting: Connection is being deleted Failed: Connection provisioning has failed
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Connection waiting for approval or rejection Approved: Connection approved Rejected: Connection Rejected
Protocol	Protocol enum. KnownProtocol can be used interchangeably with Protocol, this enum contains the known values that the service supports. Known values supported by the service NFS: NFS protocol.
PublicNetworkAccess	State of the public network access. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled: The public network access is enabled Disabled: The public network access is disabled
Redundancy	Redundancy enum. KnownRedundancy can be used interchangeably with Redundancy, this enum contains the known values that the service supports. Known values supported by the service Local: Local redundancy. Zone: Zone redundancy.
ShareRootSquash	Share root squash enum. KnownShareRootSquash can be used interchangeably with ShareRootSquash, this enum contains the known values that the service supports. Known values supported by the service NoRootSquash: No root squash. RootSquash: Root squash. AllSquash: All squash.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCheckNameAvailabilityReason	Possible reasons for a name not being available.
KnownCreatedByType	The kind of entity that created the resource.
KnownEncryptionInTransitRequired	State of NFS encryption in transit.
KnownFileShareProvisioningState	The status of file share's ProvisioningState.
KnownMediaTier	Media Tier enum.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProtocol	Protocol enum.
KnownPublicNetworkAccess	State of the public network access.
KnownRedundancy	Redundancy enum.
KnownShareRootSquash	Share root squash enum.
KnownVersions	Service versions

Functions

restorePoller<TResponse, TResult>(FileSharesClient, 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.

restorePoller<TResponse, TResult>(FileSharesClient, 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: FileSharesClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: FileSharesClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

@azure/arm-fileshares package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns

Feedback