你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

FileShare interface

文件共享的属性,包括 ID、资源名称、资源类型、Etag。

扩展

属性

accessTier

特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized(默认)、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。

accessTierChangeTime

指示共享访问层的上次修改时间。 注意:此属性不会序列化。 它只能由服务器填充。

accessTierStatus

指示访问层是否存在挂起的转换。 注意:此属性不会序列化。 它只能由服务器填充。

deleted

指示是否已删除共享。 注意:此属性不会序列化。 它只能由服务器填充。

deletedTime

删除共享的已删除时间。 注意:此属性不会序列化。 它只能由服务器填充。

enabledProtocols

用于文件共享的身份验证协议。 只能在创建共享时指定。

fileSharePaidBursting

文件共享付费突发属性。

includedBurstIops

共享的计算突发 IOPS。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

lastModifiedTime

返回上次修改共享的日期和时间。 注意:此属性不会序列化。 它只能由服务器填充。

leaseDuration

指定共享上的租约是无限持续时间还是固定持续时间,仅当共享被租用时。 注意:此属性不会序列化。 它只能由服务器填充。

leaseState

共享的租约状态。 注意:此属性不会序列化。 它只能由服务器填充。

leaseStatus

共享的租约状态。 注意:此属性不会序列化。 它只能由服务器填充。

maxBurstCreditsForIops

共享的计算最大突发信用额度。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

metadata

要作为元数据与共享关联的名称/值对。

nextAllowedProvisionedBandwidthDowngradeTime

返回共享的下一个允许的预配带宽降级时间。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

nextAllowedProvisionedIopsDowngradeTime

返回共享的下一个允许预配的 IOPS 降级时间。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

nextAllowedQuotaDowngradeTime

返回共享的下一个允许的预配存储大小降级时间。 此属性仅适用于在文件预配 v1 SSD 和文件预配 v2 帐户类型下创建的文件共享:此属性不会序列化。 它只能由服务器填充。

provisionedBandwidthMibps

共享的预配带宽(以每秒兆字节为单位)。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 有关预配带宽的最小和允许的最大值,请参阅 GetFileServiceUsage API 响应。

provisionedIops

共享的预配 IOPS。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 请参阅 GetFileServiceUsage API 响应,了解预配的 IOPS 的最小和允许的最大值。

remainingRetentionDays

软删除的共享的剩余保留天数。 注意:此属性不会序列化。 它只能由服务器填充。

rootSquash

该属性仅适用于 NFS 共享。 默认值为 NoRootSquash。

shareQuota

共享的预配大小(以 gibibytes 为单位)。 必须大于 0,并且小于或等于 5TB (5120)。 对于大型文件共享,最大大小为 102400。 有关在文件预配 v2 帐户类型下创建的文件共享,请参阅 GetFileServiceUsage API 响应,了解允许的最小和最大预配存储大小。

shareUsageBytes

存储在共享上的数据的大致大小。 请注意,此值可能不包括最近创建或最近调整大小的文件。 注意:此属性不会序列化。 它只能由服务器填充。

signedIdentifiers

共享上指定的存储访问策略列表。

snapshotTime

在列表共享响应中返回的共享快照的创建时间,其展开参数为“快照”。 注意:此属性不会序列化。 它只能由服务器填充。

version

共享的版本。 注意:此属性不会序列化。 它只能由服务器填充。

继承属性

etag

资源 Etag。 注意:此属性不会序列化。 它只能由服务器填充。

id

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会序列化。 它只能由服务器填充。

name

资源说明的名称:此属性不会序列化。 它只能由服务器填充。

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意:此属性不会序列化。 它只能由服务器填充。

属性详细信息

accessTier

特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized(默认)、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。

accessTier?: string

属性值

string

accessTierChangeTime

指示共享访问层的上次修改时间。 注意:此属性不会序列化。 它只能由服务器填充。

accessTierChangeTime?: Date

属性值

Date

accessTierStatus

指示访问层是否存在挂起的转换。 注意:此属性不会序列化。 它只能由服务器填充。

accessTierStatus?: string

属性值

string

deleted

指示是否已删除共享。 注意:此属性不会序列化。 它只能由服务器填充。

deleted?: boolean

属性值

boolean

deletedTime

删除共享的已删除时间。 注意:此属性不会序列化。 它只能由服务器填充。

deletedTime?: Date

属性值

Date

enabledProtocols

用于文件共享的身份验证协议。 只能在创建共享时指定。

enabledProtocols?: string

属性值

string

fileSharePaidBursting

文件共享付费突发属性。

fileSharePaidBursting?: FileSharePropertiesFileSharePaidBursting

属性值

includedBurstIops

共享的计算突发 IOPS。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

includedBurstIops?: number

属性值

number

lastModifiedTime

返回上次修改共享的日期和时间。 注意:此属性不会序列化。 它只能由服务器填充。

lastModifiedTime?: Date

属性值

Date

leaseDuration

指定共享上的租约是无限持续时间还是固定持续时间,仅当共享被租用时。 注意:此属性不会序列化。 它只能由服务器填充。

leaseDuration?: string

属性值

string

leaseState

共享的租约状态。 注意:此属性不会序列化。 它只能由服务器填充。

leaseState?: string

属性值

string

leaseStatus

共享的租约状态。 注意:此属性不会序列化。 它只能由服务器填充。

leaseStatus?: string

属性值

string

maxBurstCreditsForIops

共享的计算最大突发信用额度。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

maxBurstCreditsForIops?: number

属性值

number

metadata

要作为元数据与共享关联的名称/值对。

metadata?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

nextAllowedProvisionedBandwidthDowngradeTime

返回共享的下一个允许的预配带宽降级时间。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

nextAllowedProvisionedBandwidthDowngradeTime?: Date

属性值

Date

nextAllowedProvisionedIopsDowngradeTime

返回共享的下一个允许预配的 IOPS 降级时间。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 注意:此属性不会序列化。 它只能由服务器填充。

nextAllowedProvisionedIopsDowngradeTime?: Date

属性值

Date

nextAllowedQuotaDowngradeTime

返回共享的下一个允许的预配存储大小降级时间。 此属性仅适用于在文件预配 v1 SSD 和文件预配 v2 帐户类型下创建的文件共享:此属性不会序列化。 它只能由服务器填充。

nextAllowedQuotaDowngradeTime?: Date

属性值

Date

provisionedBandwidthMibps

共享的预配带宽(以每秒兆字节为单位)。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 有关预配带宽的最小和允许的最大值,请参阅 GetFileServiceUsage API 响应。

provisionedBandwidthMibps?: number

属性值

number

provisionedIops

共享的预配 IOPS。 此属性仅适用于在文件预配 v2 帐户类型下创建的文件共享。 请参阅 GetFileServiceUsage API 响应,了解预配的 IOPS 的最小和允许的最大值。

provisionedIops?: number

属性值

number

remainingRetentionDays

软删除的共享的剩余保留天数。 注意:此属性不会序列化。 它只能由服务器填充。

remainingRetentionDays?: number

属性值

number

rootSquash

该属性仅适用于 NFS 共享。 默认值为 NoRootSquash。

rootSquash?: string

属性值

string

shareQuota

共享的预配大小(以 gibibytes 为单位)。 必须大于 0,并且小于或等于 5TB (5120)。 对于大型文件共享,最大大小为 102400。 有关在文件预配 v2 帐户类型下创建的文件共享,请参阅 GetFileServiceUsage API 响应,了解允许的最小和最大预配存储大小。

shareQuota?: number

属性值

number

shareUsageBytes

存储在共享上的数据的大致大小。 请注意,此值可能不包括最近创建或最近调整大小的文件。 注意:此属性不会序列化。 它只能由服务器填充。

shareUsageBytes?: number

属性值

number

signedIdentifiers

共享上指定的存储访问策略列表。

signedIdentifiers?: SignedIdentifier[]

属性值

snapshotTime

在列表共享响应中返回的共享快照的创建时间,其展开参数为“快照”。 注意:此属性不会序列化。 它只能由服务器填充。

snapshotTime?: Date

属性值

Date

version

共享的版本。 注意:此属性不会序列化。 它只能由服务器填充。

version?: string

属性值

string

继承属性详细信息

etag

资源 Etag。 注意:此属性不会序列化。 它只能由服务器填充。

etag?: string

属性值

string

继承自AzureEntityResource.etag

id

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 AzureEntityResource.id

name

资源说明的名称:此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 AzureEntityResource.name

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意:此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自AzureEntityResource.type