Microsoft.FileStorage (stable:2025-05-05)

2025/03/19 • 50 updated methods

Service_SetProperties (updated)
Description :  Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_SetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /?restype=service&comp=properties
{
StorageServiceProperties:
{
Description: The StorageService properties. ,
Required: True ,
}
{
HourMetrics:
{
Description: A summary of request statistics grouped by API in hourly aggregates for files. ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the File service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: The retention policy. ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it. ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires. ,
Required: False ,
}
integer ,
}
,
}
,
MinuteMetrics:
{
Description: A summary of request statistics grouped by API in minute aggregates for files. ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the File service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: The retention policy. ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it. ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires. ,
Required: False ,
}
integer ,
}
,
}
,
Cors:
{
Description: The set of CORS rules. ,
Required: False ,
}
[
{
AllowedOrigins:
{
Description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. ,
Required: True ,
}
string ,
AllowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) ,
Required: True ,
}
string ,
AllowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: True ,
}
string ,
ExposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: True ,
}
string ,
MaxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Required: True ,
}
integer ,
}
,
]
,
Protocol:
{
Description: Protocol settings ,
Required: False ,
}
{
Smb:
{
Description: Settings for SMB protocol. ,
Required: False ,
}
{
Multichannel:
{
Description: Settings for SMB Multichannel. ,
Required: False ,
}
{
Enabled:
{
Description: If SMB multichannel is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Service_GetProperties (updated)
Description :  Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /?restype=service&comp=properties
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
}
,
$schema:
{
Description: Storage service properties. ,
}
{
HourMetrics:
{
Description: A summary of request statistics grouped by API in hourly aggregates for files. ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the File service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: The retention policy. ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it. ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires. ,
Required: False ,
}
integer ,
}
,
}
,
MinuteMetrics:
{
Description: A summary of request statistics grouped by API in minute aggregates for files. ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the File service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: The retention policy. ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it. ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires. ,
Required: False ,
}
integer ,
}
,
}
,
Cors:
{
Description: The set of CORS rules. ,
Required: False ,
}
[
{
AllowedOrigins:
{
Description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. ,
Required: True ,
}
string ,
AllowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) ,
Required: True ,
}
string ,
AllowedHeaders:
{
Description: The request headers that the origin domain may specify on the CORS request. ,
Required: True ,
}
string ,
ExposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. ,
Required: True ,
}
string ,
MaxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Required: True ,
}
integer ,
}
,
]
,
Protocol:
{
Description: Protocol settings ,
Required: False ,
}
{
Smb:
{
Description: Settings for SMB protocol. ,
Required: False ,
}
{
Multichannel:
{
Description: Settings for SMB Multichannel. ,
Required: False ,
}
{
Enabled:
{
Description: If SMB multichannel is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Service_ListSharesSegment (updated)
Description :  The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_ListSharesSegment",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /?comp=list
{
prefix:
{
Description: Filters the results to return only entries whose name begins with the specified prefix. ,
Required: False ,
}
string ,
marker:
{
Description: A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
maxresults:
{
Description: Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
}
,
$schema:
{
Description: An enumeration of shares. ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
Prefix:
{
Required: False ,
}
string ,
Marker:
{
Required: False ,
}
string ,
MaxResults:
{
Required: False ,
}
integer ,
ShareItems:
{
Required: False ,
}
[
{
Name:
{
Required: True ,
}
string ,
Snapshot:
{
Required: False ,
}
string ,
Deleted:
{
Required: False ,
}
boolean ,
Version:
{
Required: False ,
}
string ,
Properties:
{
Description: Properties of a share. ,
Required: True ,
}
{
Last-Modified:
{
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
Etag:
{
Required: True ,
}
string ,
Quota:
{
Required: True ,
}
integer ,
ProvisionedIops:
{
Required: False ,
}
integer ,
ProvisionedIngressMBps:
{
Required: False ,
}
integer ,
ProvisionedEgressMBps:
{
Required: False ,
}
integer ,
ProvisionedBandwidthMiBps:
{
Required: False ,
}
integer ,
NextAllowedQuotaDowngradeTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
DeletedTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
RemainingRetentionDays:
{
Required: False ,
}
integer ,
AccessTier:
{
Required: False ,
}
string ,
AccessTierChangeTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
AccessTierTransitionState:
{
Required: False ,
}
string ,
LeaseStatus:
{
Description: The current lease status of the share. ,
Enum:
{
locked: No description available. ,
unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseState:
{
Description: Lease state of the share. ,
Enum:
{
available: No description available. ,
leased: No description available. ,
expired: No description available. ,
breaking: No description available. ,
broken: No description available. ,
}
,
Required: False ,
}
enum ,
LeaseDuration:
{
Description: When a share is leased, specifies whether the lease is of infinite or fixed duration. ,
Enum:
{
infinite: No description available. ,
fixed: No description available. ,
}
,
Required: False ,
}
enum ,
EnabledProtocols:
{
Required: False ,
}
string ,
RootSquash:
{
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
EnableSnapshotVirtualDirectoryAccess:
{
Required: False ,
}
boolean ,
PaidBurstingEnabled:
{
Required: False ,
}
boolean ,
PaidBurstingMaxIops:
{
Format: int64 ,
Required: False ,
}
integer ,
PaidBurstingMaxBandwidthMibps:
{
Format: int64 ,
Required: False ,
}
integer ,
IncludedBurstIops:
{
Format: int64 ,
Required: False ,
}
integer ,
MaxBurstCreditsForIops:
{
Format: int64 ,
Required: False ,
}
integer ,
NextAllowedProvisionedIopsDowngradeTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
NextAllowedProvisionedBandwidthDowngradeTime:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
}
,
Metadata:
{
Required: False ,
}
object ,
}
,
]
,
NextMarker:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_Create (updated)
Description :  Creates a new share under the specified account. If the share with the same name already exists, the operation fails.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_Create",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-share-quota:
{
Description: Specifies the maximum size of the share, in gigabytes. ,
Required: False ,
}
integer ,
x-ms-access-tier:
{
Description: Specifies the access tier of the share. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-enabled-protocols:
{
Description: Protocols to enable on the share. ,
Required: False ,
}
string ,
x-ms-root-squash:
{
Description: Root squash to set on the share. Only valid for NFS shares. ,
Required: False ,
}
string ,
x-ms-enable-snapshot-virtual-directory-access:
{
Required: False ,
}
boolean ,
x-ms-share-paid-bursting-enabled:
{
Description: Optional. Boolean. Default if not specified is false. This property enables paid bursting. ,
Required: False ,
}
boolean ,
x-ms-share-paid-bursting-max-bandwidth-mibps:
{
Description: Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-share-paid-bursting-max-iops:
{
Description: Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-share-provisioned-iops:
{
Description: Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-share-provisioned-bandwidth-mibps:
{
Description: Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value which represents the version of the share, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-share-quota:
{
Description: Returns the current share quota in GB. ,
}
integer ,
x-ms-share-provisioned-iops:
{
Description: The provisioned IOPS of the share. ,
}
integer ,
x-ms-share-provisioned-bandwidth-mibps:
{
Description: The provisioned throughput of the share. ,
}
integer ,
x-ms-share-included-burst-iops:
{
Description: Returns the calculated burst IOPS of the share. ,
}
integer ,
x-ms-share-max-burst-credits-for-iops:
{
Description: Returned the calculated maximum burst credits. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_GetProperties (updated)
Description :  Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_GetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}?restype=share
{
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
x-ms-meta:
{
Description: A set of name-value pairs that contain the user-defined metadata of the share. ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-share-quota:
{
Description: Returns the current share quota in GB. ,
}
integer ,
x-ms-share-provisioned-iops:
{
Description: Returns the current share provisioned ipos. ,
}
integer ,
x-ms-share-provisioned-ingress-mbps:
{
Description: Returns the current share provisioned ingress in megabytes per second. ,
}
integer ,
x-ms-share-provisioned-egress-mbps:
{
Description: Returns the current share provisioned egress in megabytes per second. ,
}
integer ,
x-ms-share-next-allowed-quota-downgrade-time:
{
Description: Returns the current share next allowed quota downgrade time. ,
}
string ,
x-ms-share-provisioned-bandwidth-mibps:
{
Description: Returns the current share provisioned bandwidth in mebibytes per second. ,
}
integer ,
x-ms-lease-duration:
{
Description: When a share is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the share. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status of the share. ,
}
string ,
x-ms-access-tier:
{
Description: Returns the access tier set on the share. ,
}
string ,
x-ms-access-tier-change-time:
{
Description: Returns the last modified time (in UTC) of the access tier of the share. ,
}
string ,
x-ms-access-tier-transition-state:
{
Description: Returns the transition state between access tiers, when present. ,
}
string ,
x-ms-enabled-protocols:
{
Description: The protocols that have been enabled on the share. ,
}
string ,
x-ms-root-squash:
{
Description: Valid for NFS shares only. ,
}
string ,
x-ms-enable-snapshot-virtual-directory-access:
{
Description: Version 2023-08-03 and newer. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. This header is only returned for shares, not for snapshots. ,
}
boolean ,
x-ms-share-paid-bursting-enabled:
{
Description: Optional. Boolean. Default if not specified is false. This property enables paid bursting. ,
}
boolean ,
x-ms-share-paid-bursting-max-iops:
{
Description: Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. ,
}
integer ,
x-ms-share-paid-bursting-max-bandwidth-mibps:
{
Description: Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. ,
}
integer ,
x-ms-share-included-burst-iops:
{
Description: Return the calculated burst IOPS of the share. ,
}
integer ,
x-ms-share-max-burst-credits-for-iops:
{
Description: Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have. ,
}
integer ,
x-ms-share-next-allowed-provisioned-iops-downgrade-time:
{
Description: Returns the current share next allowed provisioned iops downgrade time. ,
}
string ,
x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time:
{
Description: Returns the current share next allowed provisioned bandwidth downgrade time. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_Delete (updated)
Description :  Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_Delete",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

DELETE:  /{shareName}?restype=share
{
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-delete-snapshots:
{
Description: Specifies the option include to delete the base share and all of its snapshots. ,
Required: False ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-file-share-usage-bytes:
{
Description: Returned only for provisioned v2 file shares. Returns an approximate used storage size of the share, in bytes. ,
}
integer ,
x-ms-file-share-snapshot-usage-bytes:
{
Description: Returned only for provisioned v2 file shares. Returns an approximate used snapshot storage size of the share, in bytes. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_AcquireLease (updated)
Description :  The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_AcquireLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=lease&acquire
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-duration:
{
Description: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. ,
Required: False ,
}
integer ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-lease-id:
{
Description: Uniquely identifies a share's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_ReleaseLease (updated)
Description :  The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_ReleaseLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=lease&release
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: Specifies the current lease ID on the resource. ,
Required: True ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_ChangeLease (updated)
Description :  The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_ChangeLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=lease&change
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: Specifies the current lease ID on the resource. ,
Required: True ,
}
string ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-lease-id:
{
Description: Uniquely identifies a share's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_RenewLease (updated)
Description :  The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_RenewLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=lease&renew
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: Specifies the current lease ID on the resource. ,
Required: True ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-lease-id:
{
Description: Uniquely identifies a share's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: Returns the current share next allowed quota downgrade time. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_BreakLease (updated)
Description :  The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_BreakLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=lease&break
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-break-period:
{
Description: For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-lease-time:
{
Description: Approximate time remaining in the lease period, in seconds. ,
}
integer ,
x-ms-lease-id:
{
Description: Uniquely identifies a share's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_CreateSnapshot (updated)
Description :  Creates a read-only snapshot of a share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_CreateSnapshot",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=snapshot
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
x-ms-snapshot:
{
Description: This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque. ,
}
string ,
etag:
{
Description: The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_CreatePermission (updated)
Description :  Create a permission (a security descriptor).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_CreatePermission",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=filepermission
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
sharePermission:
{
Description: A permission (a security descriptor) at the share level. ,
Required: True ,
}
{
permission:
{
Description: The permission in the Security Descriptor Definition Language (SDDL). ,
Required: True ,
}
string ,
format:
{
Enum:
{
Sddl: No description available. ,
Binary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the directory/file. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_GetPermission (updated)
Description :  Returns the permission (security descriptor) for a given key
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_GetPermission",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}?restype=share&comp=filepermission
{
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. ,
Required: True ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: A permission (a security descriptor) at the share level. ,
}
{
permission:
{
Description: The permission in the Security Descriptor Definition Language (SDDL). ,
Required: True ,
}
string ,
format:
{
Enum:
{
Sddl: No description available. ,
Binary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_SetProperties (updated)
Description :  Sets properties for the specified share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_SetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=properties
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-share-quota:
{
Description: Specifies the maximum size of the share, in gigabytes. ,
Required: False ,
}
integer ,
x-ms-access-tier:
{
Description: Specifies the access tier of the share. ,
Required: False ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-root-squash:
{
Description: Root squash to set on the share. Only valid for NFS shares. ,
Required: False ,
}
string ,
x-ms-enable-snapshot-virtual-directory-access:
{
Required: False ,
}
boolean ,
x-ms-share-paid-bursting-enabled:
{
Description: Optional. Boolean. Default if not specified is false. This property enables paid bursting. ,
Required: False ,
}
boolean ,
x-ms-share-paid-bursting-max-bandwidth-mibps:
{
Description: Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-share-paid-bursting-max-iops:
{
Description: Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-share-provisioned-iops:
{
Description: Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-share-provisioned-bandwidth-mibps:
{
Description: Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-share-quota:
{
Description: Returns the current share quota in GB. ,
}
integer ,
x-ms-share-provisioned-iops:
{
Description: Returns the current share provisioned ipos. ,
}
integer ,
x-ms-share-provisioned-bandwidth-mibps:
{
Description: Returns the current share provisioned bandwidth in mebibytes per second. ,
}
integer ,
x-ms-share-included-burst-iops:
{
Description: Return the calculated burst IOPS of the share. ,
}
integer ,
x-ms-share-max-burst-credits-for-iops:
{
Description: Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have. ,
}
integer ,
x-ms-share-next-allowed-quota-downgrade-time:
{
Description: Returns the current share next allowed quota downgrade time. ,
}
string ,
x-ms-share-next-allowed-provisioned-iops-downgrade-time:
{
Description: Returns the current share next allowed provisioned iops downgrade time. ,
}
string ,
x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time:
{
Description: Returns the current share next allowed provisioned bandwidth downgrade time. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_SetMetadata (updated)
Description :  Sets one or more user-defined name-value pairs for the specified share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_SetMetadata",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=metadata
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_GetAccessPolicy (updated)
Description :  Returns information about stored access policies specified on the share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_GetAccessPolicy",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}?restype=share&comp=acl
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: A collection of signed identifiers. ,
}
{
Id:
{
Description: A unique id. ,
Required: True ,
}
string ,
AccessPolicy:
{
Description: The access policy. ,
Required: False ,
}
{
Start:
{
Description: The date-time the policy is active. ,
Format: date-time ,
Required: False ,
}
string ,
Expiry:
{
Description: The date-time the policy expires. ,
Format: date-time ,
Required: False ,
}
string ,
Permission:
{
Description: The permissions for the ACL policy. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_SetAccessPolicy (updated)
Description :  Sets a stored access policy for use with shared access signatures.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_SetAccessPolicy",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=acl
{
shareAcl:
{
Description: The ACL for the share. ,
Required: False ,
}
{
Id:
{
Description: A unique id. ,
Required: True ,
}
string ,
AccessPolicy:
{
Description: The access policy. ,
Required: False ,
}
{
Start:
{
Description: The date-time the policy is active. ,
Format: date-time ,
Required: False ,
}
string ,
Expiry:
{
Description: The date-time the policy expires. ,
Format: date-time ,
Required: False ,
}
string ,
Permission:
{
Description: The permissions for the ACL policy. ,
Required: False ,
}
string ,
}
,
}
,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_GetStatistics (updated)
Description :  Retrieves statistics related to the share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_GetStatistics",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}?restype=share&comp=stats
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: Stats for the share. ,
}
{
ShareUsageBytes:
{
Description: The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files. ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Share_Restore (updated)
Description :  Restores a previously deleted Share.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Share_Restore",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}?restype=share&comp=undelete
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-deleted-share-name:
{
Description: Specifies the name of the previously-deleted share. ,
Required: False ,
}
string ,
x-ms-deleted-share-version:
{
Description: Specifies the version of the previously-deleted share. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-share-quota:
{
Description: Returns the current share quota in GB. ,
}
integer ,
x-ms-share-provisioned-iops:
{
Description: Returns the current share provisioned ipos. ,
}
integer ,
x-ms-share-provisioned-bandwidth-mibps:
{
Description: Returns the current share provisioned bandwidth in mebibytes per second. ,
}
integer ,
x-ms-share-included-burst-iops:
{
Description: Return the calculated burst IOPS of the share. ,
}
integer ,
x-ms-share-max-burst-credits-for-iops:
{
Description: Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_Create (updated)
Description :  Creates a new directory under the specified share or parent directory.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_Create",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}?restype=directory
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-attributes:
{
Description: If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional, NFS only. The owner of the file or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional, NFS only. The owning group of the file or directory. ,
Required: False ,
}
string ,
x-ms-mode:
{
Description: Optional, NFS only. The file mode of the file or directory ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value which represents the version of the directory, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the directory. ,
}
string ,
x-ms-file-attributes:
{
Description: Attributes set for the directory. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the directory. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the directory. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the directory. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the directory. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the directory. ,
}
string ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-file-file-type:
{
Description: NFS only. Type of the file or directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_GetProperties (updated)
Description :  Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_GetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}/{directory}?restype=directory
{
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
x-ms-meta:
{
Description: A set of name-value pairs that contain metadata for the directory. ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-server-encrypted:
{
Description: The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false. ,
}
boolean ,
x-ms-file-attributes:
{
Description: Attributes set for the directory. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the directory. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the directory. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the directory. ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the directory. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the directory. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the directory. ,
}
string ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-file-file-type:
{
Description: NFS only. Type of the file or directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_Delete (updated)
Description :  Removes the specified empty directory. Note that the directory must be empty before it can be deleted.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_Delete",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

DELETE:  /{shareName}/{directory}?restype=directory
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_SetProperties (updated)
Description :  Sets properties on the directory.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_SetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}?restype=directory&comp=properties
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-attributes:
{
Description: If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional, NFS only. The owner of the file or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional, NFS only. The owning group of the file or directory. ,
Required: False ,
}
string ,
x-ms-mode:
{
Description: Optional, NFS only. The file mode of the file or directory ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
last-modified:
{
Description: Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the directory. ,
}
string ,
x-ms-file-attributes:
{
Description: Attributes set for the directory. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the directory. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the directory. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the directory. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the directory. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the directory. ,
}
string ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_SetMetadata (updated)
Description :  Updates user defined metadata for the specified directory.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_SetMetadata",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}?restype=directory&comp=metadata
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value which represents the version of the directory, in quotes. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_ListFilesAndDirectoriesSegment (updated)
Description :  Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_ListFilesAndDirectoriesSegment",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}/{directory}?restype=directory&comp=list
{
prefix:
{
Description: Filters the results to return only entries whose name begins with the specified prefix. ,
Required: False ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
marker:
{
Description: A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
maxresults:
{
Description: Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. ,
Required: False ,
}
integer ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
include:
{
Description: Include this parameter to specify one or more datasets to include in the response. ,
Required: False ,
}
array ,
x-ms-file-extended-info:
{
Description: Include extended information. ,
Required: False ,
}
boolean ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: Specifies the format in which the results are returned. Currently this value is 'application/xml'. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: An enumeration of directories and files. ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
ShareName:
{
Required: True ,
}
string ,
ShareSnapshot:
{
Required: False ,
}
string ,
Encoded:
{
Required: False ,
}
boolean ,
DirectoryPath:
{
Required: True ,
}
string ,
Prefix:
{
Required: True ,
}
{
Encoded:
{
Required: False ,
}
boolean ,
content:
{
Required: False ,
}
string ,
}
,
Marker:
{
Required: False ,
}
string ,
MaxResults:
{
Required: False ,
}
integer ,
Segment:
{
Description: Abstract for entries that can be listed from Directory. ,
Required: True ,
}
{
DirectoryItems:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
{
Encoded:
{
Required: False ,
}
boolean ,
content:
{
Required: False ,
}
string ,
}
,
FileId:
{
Required: False ,
}
string ,
Properties:
{
Description: File properties. ,
Required: False ,
}
{
Content-Length:
{
Description: Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties. ,
Format: int64 ,
Required: True ,
}
integer ,
CreationTime:
{
Format: date-time ,
Required: False ,
}
string ,
LastAccessTime:
{
Format: date-time ,
Required: False ,
}
string ,
LastWriteTime:
{
Format: date-time ,
Required: False ,
}
string ,
ChangeTime:
{
Format: date-time ,
Required: False ,
}
string ,
Last-Modified:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
Etag:
{
Required: False ,
}
string ,
}
,
Attributes:
{
Required: False ,
}
string ,
PermissionKey:
{
Required: False ,
}
string ,
}
,
]
,
FileItems:
{
Required: True ,
}
[
{
Name:
{
Required: True ,
}
{
Encoded:
{
Required: False ,
}
boolean ,
content:
{
Required: False ,
}
string ,
}
,
FileId:
{
Required: False ,
}
string ,
Properties:
{
Description: File properties. ,
Required: True ,
}
{
Content-Length:
{
Description: Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties. ,
Format: int64 ,
Required: True ,
}
integer ,
CreationTime:
{
Format: date-time ,
Required: False ,
}
string ,
LastAccessTime:
{
Format: date-time ,
Required: False ,
}
string ,
LastWriteTime:
{
Format: date-time ,
Required: False ,
}
string ,
ChangeTime:
{
Format: date-time ,
Required: False ,
}
string ,
Last-Modified:
{
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
Etag:
{
Required: False ,
}
string ,
}
,
Attributes:
{
Required: False ,
}
string ,
PermissionKey:
{
Required: False ,
}
string ,
}
,
]
,
}
,
NextMarker:
{
Required: True ,
}
string ,
DirectoryId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_ListHandles (updated)
Description :  Lists handles for directory.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_ListHandles",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}/{directory}?comp=listhandles
{
marker:
{
Description: A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
maxresults:
{
Description: Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. ,
Required: False ,
}
integer ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-recursive:
{
Description: Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. ,
Required: False ,
}
boolean ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: Specifies the format in which the results are returned. Currently this value is 'application/xml'. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: An enumeration of handles. ,
}
{
HandleList:
{
Required: False ,
}
[
{
HandleId:
{
Description: XSMB service handle ID ,
Required: True ,
}
string ,
Path:
{
Required: True ,
}
{
Encoded:
{
Required: False ,
}
boolean ,
content:
{
Required: False ,
}
string ,
}
,
FileId:
{
Description: FileId uniquely identifies the file or directory. ,
Required: True ,
}
string ,
ParentId:
{
Description: ParentId uniquely identifies the parent directory of the object. ,
Required: False ,
}
string ,
SessionId:
{
Description: SMB session ID in context of which the file handle was opened ,
Required: True ,
}
string ,
ClientIp:
{
Description: Client IP that opened the handle ,
Required: True ,
}
string ,
ClientName:
{
Description: Name of the client machine where the share is being mounted ,
Required: True ,
}
string ,
OpenTime:
{
Description: Time when the session that previously opened the handle has last been reconnected. (UTC) ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
LastReconnectTime:
{
Description: Time handle was last connected to (UTC) ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
AccessRightList:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
NextMarker:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_ForceCloseHandles (updated)
Description :  Closes all handles open for given directory.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_ForceCloseHandles",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}?comp=forceclosehandles
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
marker:
{
Description: A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-handle-id:
{
Description: Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles. ,
Required: True ,
}
string ,
x-ms-recursive:
{
Description: Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. ,
Required: False ,
}
boolean ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-marker:
{
Description: A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request. ,
}
string ,
x-ms-number-of-handles-closed:
{
Description: Contains count of number of handles closed. ,
}
integer ,
x-ms-number-of-handles-failed:
{
Description: Contains count of number of handles that failed to close. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
Directory_Rename (updated)
Description :  Renames a directory
Reference :  Link ¶

⚶ Changes

{
  "#id": "Directory_Rename",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}?restype=directory&comp=rename
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-rename-source:
{
Description: Required. Specifies the URI-style path of the source file, up to 2 KB in length. ,
Required: True ,
}
string ,
x-ms-file-rename-replace-if-exists:
{
Description: Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. ,
Required: False ,
}
boolean ,
x-ms-file-rename-ignore-readonly:
{
Description: Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. ,
Required: False ,
}
boolean ,
x-ms-source-lease-id:
{
Description: Required if the source file has an active infinite lease. ,
Required: False ,
}
string ,
x-ms-destination-lease-id:
{
Description: Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed). ,
Required: False ,
}
string ,
x-ms-file-attributes:
{
Description: Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file. ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. ,
Required: False ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-source-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the source URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the file. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_Create (updated)
Description :  Creates a new file or replaces a file. Note it only initializes the file with no content.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_Create",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-content-length:
{
Description: Specifies the maximum size for the file, up to 4 TB. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-type:
{
Description: Dummy constant parameter, file type can only be file. ,
Required: True ,
}
string ,
x-ms-content-type:
{
Description: Sets the MIME content type of the file. The default type is 'application/octet-stream'. ,
Required: False ,
}
string ,
x-ms-content-encoding:
{
Description: Specifies which content encodings have been applied to the file. ,
Required: False ,
}
string ,
x-ms-content-language:
{
Description: Specifies the natural languages used by this resource. ,
Required: False ,
}
string ,
x-ms-cache-control:
{
Description: Sets the file's cache control. The File service stores this value but does not use or modify it. ,
Required: False ,
}
string ,
x-ms-content-md5:
{
Description: Sets the file's MD5 hash. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-content-disposition:
{
Description: Sets the file's Content-Disposition header. ,
Required: False ,
}
string ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-attributes:
{
Description: If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional, NFS only. The owner of the file or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional, NFS only. The owning group of the file or directory. ,
Required: False ,
}
string ,
x-ms-mode:
{
Description: Optional, NFS only. The file mode of the file or directory ,
Required: False ,
}
string ,
x-ms-file-file-type:
{
Description: Optional, NFS only. Type of the file or directory. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the file. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the file. ,
}
string ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-file-file-type:
{
Description: NFS only. Type of the file or directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_Download (updated)
Description :  Reads or downloads a file from the system, including its metadata and properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_Download",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}/{directory}/{fileName}
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-range:
{
Description: Return file data only from the specified byte range. ,
Required: False ,
}
string ,
x-ms-range-get-content-md5:
{
Description: When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. ,
Required: False ,
}
boolean ,
x-ms-structured-body:
{
Description: Specifies the response content should be returned as a structured message and specifies the message schema version and properties. ,
Required: False ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
last-modified:
{
Description: Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time. ,
}
string ,
x-ms-meta:
{
Description: A set of name-value pairs associated with this file as user-defined metadata. ,
}
string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The content type specified for the file. The default content type is 'application/octet-stream' ,
}
string ,
content-range:
{
Description: Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header. ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
content-md5:
{
Description: If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header. ,
}
string ,
content-encoding:
{
Description: Returns the value that was specified for the Content-Encoding request header. ,
}
string ,
cache-control:
{
Description: Returned if it was previously specified for the file. ,
}
string ,
content-disposition:
{
Description: Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. ,
}
string ,
content-language:
{
Description: Returns the value that was specified for the Content-Language request header. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial file content. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-copy-completion-time:
{
Description: Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. ,
}
string ,
x-ms-copy-status-description:
{
Description: Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for the last attempted Copy File operation where this file was the destination file. ,
}
string ,
x-ms-copy-progress:
{
Description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. ,
}
string ,
x-ms-copy-source:
{
Description: URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by 'x-ms-copy-id'. ,
}
string ,
x-ms-content-md5:
{
Description: If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range. ,
}
string ,
x-ms-server-encrypted:
{
Description: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted). ,
}
boolean ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the file. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the file. ,
}
string ,
x-ms-lease-duration:
{
Description: When a file is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the file. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status of the file. ,
}
string ,
x-ms-structured-body:
{
Description: Indicates the response body contains a structured message and specifies the message schema version and properties. ,
}
string ,
x-ms-structured-content-length:
{
Description: The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length. ,
}
integer ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-link-count:
{
Description: NFS only. The link count of the file or directory. ,
}
integer ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (206)

{
$headers:
{
last-modified:
{
Description: Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time. ,
}
string ,
x-ms-meta:
{
Description: A set of name-value pairs associated with this file as user-defined metadata. ,
}
string ,
content-length:
{
Description: The number of bytes present in the response body. ,
}
integer ,
content-type:
{
Description: The content type specified for the file. The default content type is 'application/octet-stream' ,
}
string ,
content-range:
{
Description: Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header. ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
content-md5:
{
Description: If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header. ,
}
string ,
content-encoding:
{
Description: Returns the value that was specified for the Content-Encoding request header. ,
}
string ,
cache-control:
{
Description: Returned if it was previously specified for the file. ,
}
string ,
content-disposition:
{
Description: Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. ,
}
string ,
content-language:
{
Description: Returns the value that was specified for the Content-Language request header. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
accept-ranges:
{
Description: Indicates that the service supports requests for partial file content. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-copy-completion-time:
{
Description: Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. ,
}
string ,
x-ms-copy-status-description:
{
Description: Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for the last attempted Copy File operation where this file was the destination file. ,
}
string ,
x-ms-copy-progress:
{
Description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. ,
}
string ,
x-ms-copy-source:
{
Description: URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by 'x-ms-copy-id'. ,
}
string ,
x-ms-content-md5:
{
Description: If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range. ,
}
string ,
x-ms-server-encrypted:
{
Description: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted). ,
}
boolean ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the file. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the file. ,
}
string ,
x-ms-lease-duration:
{
Description: When a file is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the file. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status of the file. ,
}
string ,
x-ms-structured-body:
{
Description: Indicates the response body contains a structured message and specifies the message schema version and properties. ,
}
string ,
x-ms-structured-content-length:
{
Description: The length of the blob/file content inside the message body when the response body is returned as a structured message. Will always be smaller than Content-Length. ,
}
integer ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-link-count:
{
Description: NFS only. The link count of the file or directory. ,
}
integer ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_GetProperties (updated)
Description :  Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_GetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

HEAD:  /{shareName}/{directory}/{fileName}
{
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
last-modified:
{
Description: Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time. ,
}
string ,
x-ms-meta:
{
Description: A set of name-value pairs associated with this file as user-defined metadata. ,
}
string ,
x-ms-type:
{
Description: Returns the type File. Reserved for future use. ,
}
string ,
content-length:
{
Description: The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file. ,
}
integer ,
content-type:
{
Description: The content type specified for the file. The default content type is 'application/octet-stream' ,
}
string ,
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally, in quotes. ,
}
string ,
content-md5:
{
Description: If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity. ,
}
string ,
content-encoding:
{
Description: If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header. ,
}
string ,
cache-control:
{
Description: If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header. ,
}
string ,
content-disposition:
{
Description: Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. ,
}
string ,
content-language:
{
Description: Returns the value that was specified for the Content-Language request header. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-copy-completion-time:
{
Description: Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. ,
}
string ,
x-ms-copy-status-description:
{
Description: Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for the last attempted Copy File operation where this file was the destination file. ,
}
string ,
x-ms-copy-progress:
{
Description: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. ,
}
string ,
x-ms-copy-source:
{
Description: URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by 'x-ms-copy-id'. ,
}
string ,
x-ms-server-encrypted:
{
Description: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted). ,
}
boolean ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the file. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the file. ,
}
string ,
x-ms-lease-duration:
{
Description: When a file is leased, specifies whether the lease is of infinite or fixed duration. ,
}
string ,
x-ms-lease-state:
{
Description: Lease state of the file. ,
}
string ,
x-ms-lease-status:
{
Description: The current lease status of the file. ,
}
string ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-link-count:
{
Description: NFS only. The link count of the file or directory. ,
}
integer ,
x-ms-file-file-type:
{
Description: NFS only. Type of the file or directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_Delete (updated)
Description :  removes the file from the storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_Delete",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

DELETE:  /{shareName}/{directory}/{fileName}
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-link-count:
{
Description: NFS only. The link count of the file or directory. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_SetHTTPHeaders (updated)
Description :  Sets HTTP headers on the file.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_SetHTTPHeaders",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=properties
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-content-length:
{
Description: Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared. ,
Format: int64 ,
Required: False ,
}
integer ,
x-ms-content-type:
{
Description: Sets the MIME content type of the file. The default type is 'application/octet-stream'. ,
Required: False ,
}
string ,
x-ms-content-encoding:
{
Description: Specifies which content encodings have been applied to the file. ,
Required: False ,
}
string ,
x-ms-content-language:
{
Description: Specifies the natural languages used by this resource. ,
Required: False ,
}
string ,
x-ms-cache-control:
{
Description: Sets the file's cache control. The File service stores this value but does not use or modify it. ,
Required: False ,
}
string ,
x-ms-content-md5:
{
Description: Sets the file's MD5 hash. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-content-disposition:
{
Description: Sets the file's Content-Disposition header. ,
Required: False ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-attributes:
{
Description: If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file/directory. Default value: Now. ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional, NFS only. The owner of the file or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional, NFS only. The owning group of the file or directory. ,
Required: False ,
}
string ,
x-ms-mode:
{
Description: Optional, NFS only. The file mode of the file or directory ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the directory. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the directory. ,
}
string ,
x-ms-mode:
{
Description: NFS only. The mode of the file or directory. ,
}
string ,
x-ms-owner:
{
Description: NFS only. The owner of the file or directory. ,
}
string ,
x-ms-group:
{
Description: NFS only. The owning group of the file or directory. ,
}
string ,
x-ms-link-count:
{
Description: NFS only. The link count of the file or directory. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_SetMetadata (updated)
Description :  Updates user-defined metadata for the specified file.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_SetMetadata",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=metadata
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_AcquireLease (updated)
Description :  [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_AcquireLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=lease&acquire
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-duration:
{
Description: Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. ,
Required: False ,
}
integer ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. ,
}
string ,
x-ms-lease-id:
{
Description: Uniquely identifies a file's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_ReleaseLease (updated)
Description :  [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_ReleaseLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=lease&release
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: Specifies the current lease ID on the resource. ,
Required: True ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_ChangeLease (updated)
Description :  [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_ChangeLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=lease&change
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: Specifies the current lease ID on the resource. ,
Required: True ,
}
string ,
x-ms-proposed-lease-id:
{
Description: Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. ,
}
string ,
x-ms-lease-id:
{
Description: Uniquely identifies a file's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_BreakLease (updated)
Description :  [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_BreakLease",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=lease&break
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
etag:
{
Description: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. ,
}
string ,
x-ms-lease-id:
{
Description: Uniquely identifies a file's lease ,
}
string ,
x-ms-client-request-id:
{
Description: If a client request id header is sent in the request, this header will be present in the response with the same value. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_UploadRange (updated)
Description :  Upload a range of bytes to a file.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_UploadRange",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=range
{
optionalbody:
{
Description: Initial data. ,
Required: False ,
}
object ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-range:
{
Description: Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte. ,
Required: True ,
}
string ,
x-ms-write:
{
Description: Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size. ,
Required: True ,
}
string ,
Content-Length:
{
Description: Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero. ,
Format: int64 ,
Required: True ,
}
integer ,
Content-MD5:
{
Description: An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). ,
Format: byte ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: If the file last write time should be preserved or overwritten ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-structured-body:
{
Description: Required if the request body is a structured message. Specifies the message schema version and properties. ,
Required: False ,
}
string ,
x-ms-structured-content-length:
{
Description: Required if the request body is a structured message. Specifies the length of the blob/file content inside the message body. Will always be smaller than Content-Length. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
content-md5:
{
Description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-structured-body:
{
Description: Indicates the structured message body was accepted and mirrors back the message schema version and properties. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_UploadRangeFromURL (updated)
Description :  Upload a range of bytes to a file where the contents are read from a URL.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_UploadRangeFromURL",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=range&fromURL
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-range:
{
Description: Writes data to the specified byte range in the file. ,
Required: True ,
}
string ,
x-ms-copy-source:
{
Description: Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source. ,
Required: True ,
}
string ,
x-ms-source-range:
{
Description: Bytes of source data in the specified range. ,
Required: False ,
}
string ,
x-ms-write:
{
Description: Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range. ,
Required: True ,
}
string ,
Content-Length:
{
Description: Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero. ,
Format: int64 ,
Required: True ,
}
integer ,
x-ms-source-content-crc64:
{
Description: Specify the crc64 calculated for the range of bytes that must be read from the copy source. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-source-if-match-crc64:
{
Description: Specify the crc64 value to operate only on range with a matching crc64 checksum. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-source-if-none-match-crc64:
{
Description: Specify the crc64 value to operate only on range without a matching crc64 checksum. ,
Format: byte ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-copy-source-authorization:
{
Description: Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: If the file last write time should be preserved or overwritten ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-source-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the source URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share. ,
}
string ,
x-ms-content-crc64:
{
Description: This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_GetRangeList (updated)
Description :  Returns the list of valid ranges for a file.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_GetRangeList",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}/{directory}/{fileName}?comp=rangelist
{
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
prevsharesnapshot:
{
Description: The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-range:
{
Description: Specifies the range of bytes over which to list ranges, inclusively. ,
Required: False ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-file-support-rename:
{
Description: This header is allowed only when PrevShareSnapshot query parameter is set. Determines whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed. If the value is true, the valid changed ranges for the file will be returned. If the value is false, the operation will result in a failure with 409 (Conflict) response. The default value is false. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$headers:
{
last-modified:
{
Description: The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time. ,
}
string ,
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
x-ms-content-length:
{
Description: The size of the file in bytes. ,
}
integer ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: The list of file ranges ,
}
{
Ranges:
{
Required: False ,
}
[
{
Start:
{
Description: Start of the range. ,
Format: int64 ,
Required: True ,
}
integer ,
End:
{
Description: End of the range. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
ClearRanges:
{
Required: False ,
}
[
{
Start:
{
Format: int64 ,
Required: True ,
}
integer ,
End:
{
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_StartCopy (updated)
Description :  Copies a blob or file to a destination file within the storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_StartCopy",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=copy
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-copy-source:
{
Description: Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source. ,
Required: True ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-copy-mode:
{
Description: Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. ,
Required: False ,
}
string ,
x-ms-file-copy-ignore-readonly:
{
Description: Specifies the option to overwrite the target file if it already exists and has read-only attribute set. ,
Required: False ,
}
boolean ,
x-ms-file-attributes:
{
Description: Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file. ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. ,
Required: False ,
}
string ,
x-ms-file-copy-set-archive:
{
Description: Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state. ,
Required: False ,
}
boolean ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-source-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the source URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
x-ms-owner:
{
Description: Optional, NFS only. The owner of the file or directory. ,
Required: False ,
}
string ,
x-ms-group:
{
Description: Optional, NFS only. The owning group of the file or directory. ,
Required: False ,
}
string ,
x-ms-mode:
{
Description: Optional, NFS only. The file mode of the file or directory ,
Required: False ,
}
string ,
x-ms-file-mode-copy-mode:
{
Description: NFS only. Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file. source: The mode on the destination file is copied from the source file. override: The mode on the destination file is determined via the x-ms-mode header. ,
Required: False ,
}
string ,
x-ms-file-owner-copy-mode:
{
Description: NFS only. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file. source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file. override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
etag:
{
Description: If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy. ,
}
string ,
last-modified:
{
Description: Returns the date/time that the copy operation to the destination file completed. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-copy-id:
{
Description: String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy. ,
}
string ,
x-ms-copy-status:
{
Description: State of the copy operation identified by x-ms-copy-id. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_AbortCopy (updated)
Description :  Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_AbortCopy",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=copy©id
{
copyid:
{
Description: The copy identifier provided in the x-ms-copy-id header of the original Copy File operation. ,
Required: True ,
}
string ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-copy-action:
{
Description: Abort. ,
Required: True ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-lease-id:
{
Description: If specified, the operation only succeeds if the resource's lease is active and matches this ID. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_ListHandles (updated)
Description :  Lists handles for file
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_ListHandles",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{shareName}/{directory}/{fileName}?comp=listhandles
{
marker:
{
Description: A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
maxresults:
{
Description: Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. ,
Required: False ,
}
integer ,
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: Specifies the format in which the results are returned. Currently this value is 'application/xml'. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
}
,
$schema:
{
Description: An enumeration of handles. ,
}
{
HandleList:
{
Required: False ,
}
[
{
HandleId:
{
Description: XSMB service handle ID ,
Required: True ,
}
string ,
Path:
{
Required: True ,
}
{
Encoded:
{
Required: False ,
}
boolean ,
content:
{
Required: False ,
}
string ,
}
,
FileId:
{
Description: FileId uniquely identifies the file or directory. ,
Required: True ,
}
string ,
ParentId:
{
Description: ParentId uniquely identifies the parent directory of the object. ,
Required: False ,
}
string ,
SessionId:
{
Description: SMB session ID in context of which the file handle was opened ,
Required: True ,
}
string ,
ClientIp:
{
Description: Client IP that opened the handle ,
Required: True ,
}
string ,
ClientName:
{
Description: Name of the client machine where the share is being mounted ,
Required: True ,
}
string ,
OpenTime:
{
Description: Time when the session that previously opened the handle has last been reconnected. (UTC) ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
LastReconnectTime:
{
Description: Time handle was last connected to (UTC) ,
Format: date-time-rfc1123 ,
Required: False ,
}
string ,
AccessRightList:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
NextMarker:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_ForceCloseHandles (updated)
Description :  Closes all handles open for given file
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_ForceCloseHandles",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=forceclosehandles
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
marker:
{
Description: A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
sharesnapshot:
{
Description: The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. ,
Required: False ,
}
string ,
x-ms-handle-id:
{
Description: Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles. ,
Required: True ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-marker:
{
Description: A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request. ,
}
string ,
x-ms-number-of-handles-closed:
{
Description: Contains count of number of handles closed. ,
}
integer ,
x-ms-number-of-handles-failed:
{
Description: Contains count of number of handles that failed to close. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}
File_Rename (updated)
Description :  Renames a file
Reference :  Link ¶

⚶ Changes

{
  "#id": "File_Rename",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.",
        "old": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{shareName}/{directory}/{fileName}?comp=rename
{
timeout:
{
Description: The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-file-rename-source:
{
Description: Required. Specifies the URI-style path of the source file, up to 2 KB in length. ,
Required: True ,
}
string ,
x-ms-file-rename-replace-if-exists:
{
Description: Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. ,
Required: False ,
}
boolean ,
x-ms-file-rename-ignore-readonly:
{
Description: Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. ,
Required: False ,
}
boolean ,
x-ms-source-lease-id:
{
Description: Required if the source file has an active infinite lease. ,
Required: False ,
}
string ,
x-ms-destination-lease-id:
{
Description: Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed). ,
Required: False ,
}
string ,
x-ms-file-attributes:
{
Description: Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file. ,
Required: False ,
}
string ,
x-ms-file-creation-time:
{
Description: Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file. ,
Required: False ,
}
string ,
x-ms-file-last-write-time:
{
Description: Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. ,
Required: False ,
}
string ,
x-ms-file-change-time:
{
Description: Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. ,
Required: False ,
}
string ,
x-ms-file-permission:
{
Description: If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-file-permission-format:
{
Description: Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission ,
Required: False ,
}
string ,
x-ms-file-permission-key:
{
Description: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. ,
Required: False ,
}
string ,
x-ms-meta:
{
Description: A name-value pair to associate with a file storage object. ,
Required: False ,
}
string ,
x-ms-content-type:
{
Description: Sets the MIME content type of the file. The default type is 'application/octet-stream'. ,
Required: False ,
}
string ,
x-ms-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the target URI. ,
Required: False ,
}
boolean ,
x-ms-source-allow-trailing-dot:
{
Description: If true, the trailing dot will not be trimmed from the source URI. ,
Required: False ,
}
boolean ,
x-ms-file-request-intent:
{
Description: Valid value is backup ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The ETag contains a value which represents the version of the file, in quotes. ,
}
string ,
last-modified:
{
Description: Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. ,
}
string ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the File service used to execute the request. ,
}
string ,
date:
{
Description: A UTC date/time value generated by the service that indicates the time at which the response was initiated. ,
}
string ,
x-ms-request-server-encrypted:
{
Description: The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. ,
}
boolean ,
x-ms-file-permission-key:
{
Description: Key of the permission set for the file. ,
}
string ,
x-ms-file-attributes:
{
Description: Attributes set for the file. ,
}
string ,
x-ms-file-creation-time:
{
Description: Creation time for the file. ,
}
string ,
x-ms-file-last-write-time:
{
Description: Last write time for the file. ,
}
string ,
x-ms-file-change-time:
{
Description: Change time for the file. ,
}
string ,
x-ms-file-id:
{
Description: The fileId of the file. ,
}
string ,
x-ms-file-parent-id:
{
Description: The parent fileId of the directory. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
AuthenticationErrorDetail:
{
Required: False ,
}
string ,
}
,
}