FileShareProperties interface

Package:

@azure/arm-fileshares

File share properties

Properties

hostName	The host name of the file share.
includedBurstIOPerSec	Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share.
maxBurstIOPerSecCredits	Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level.
mediaTier	The storage media tier of the file share.
mountName	The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system.
nfsProtocolProperties	Protocol settings specific NFS.
privateEndpointConnections	The list of associated private endpoint connections.
protocol	The file sharing protocol for this file share.
provisionedIOPerSec	The provisioned IO / sec of the share.
provisionedIOPerSecNextAllowedDowngrade	A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced.
provisionedStorageGiB	The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage.
provisionedStorageNextAllowedDowngrade	A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced.
provisionedThroughputMiBPerSec	The provisioned throughput / sec of the share.
provisionedThroughputNextAllowedDowngrade	A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced.
provisioningState	The status of the last operation.
publicAccessProperties	The set of properties for control public access.
publicNetworkAccess	Gets or sets allow or disallow public network access to azure managed file share
redundancy	The chosen redundancy level of the file share.

Property Details

hostName

The host name of the file share.

hostName?: string

Property Value

string

includedBurstIOPerSec

Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share.

includedBurstIOPerSec?: number

Property Value

number

maxBurstIOPerSecCredits

Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level.

maxBurstIOPerSecCredits?: number

Property Value

number

mediaTier

The storage media tier of the file share.

mediaTier?: string

Property Value

string

mountName

The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system.

mountName?: string

Property Value

string

nfsProtocolProperties

Protocol settings specific NFS.

nfsProtocolProperties?: NfsProtocolProperties

Property Value

NfsProtocolProperties

privateEndpointConnections

The list of associated private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

protocol

The file sharing protocol for this file share.

protocol?: string

Property Value

string

provisionedIOPerSec

The provisioned IO / sec of the share.

provisionedIOPerSec?: number

Property Value

number

provisionedIOPerSecNextAllowedDowngrade

A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced.

provisionedIOPerSecNextAllowedDowngrade?: Date

Property Value

Date

provisionedStorageGiB

The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage.

provisionedStorageGiB?: number

Property Value

number

provisionedStorageNextAllowedDowngrade

A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced.

provisionedStorageNextAllowedDowngrade?: Date

Property Value

Date

provisionedThroughputMiBPerSec

The provisioned throughput / sec of the share.

provisionedThroughputMiBPerSec?: number

Property Value

number

provisionedThroughputNextAllowedDowngrade

A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced.

provisionedThroughputNextAllowedDowngrade?: Date

Property Value

Date

provisioningState

The status of the last operation.

provisioningState?: string

Property Value

string

publicAccessProperties

The set of properties for control public access.

publicAccessProperties?: PublicAccessProperties

Property Value

PublicAccessProperties

publicNetworkAccess

Gets or sets allow or disallow public network access to azure managed file share

publicNetworkAccess?: string

Property Value

string

redundancy

The chosen redundancy level of the file share.

redundancy?: string

Property Value

string