swagger: '2.0' info: title: Microsoft Azure Azure File Storage version: '2024-05-04' x-ms-code-generation-settings: header: MIT strictSpecAdherence: false x-ms-parameterized-host: hostTemplate: '{url}' useSchemePrefix: false positionInOperation: first parameters: - $ref: '#/parameters/Url' securityDefinitions: File_shared_key: type: apiKey name: Authorization in: header schemes: - https consumes: - application/xml produces: - application/xml paths: {} x-ms-paths: /?restype=service&comp=properties: put: tags: - service operationId: Service_SetProperties description: >- Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules. parameters: - $ref: '#/parameters/StorageServiceProperties' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: Success (Accepted) headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' get: tags: - service operationId: Service_GetProperties description: >- Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success. headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. schema: $ref: '#/definitions/StorageServiceProperties' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - name: restype description: restype in: query required: true type: string enum: - service - name: comp description: comp in: query required: true type: string enum: - properties /?comp=list: get: tags: - service operationId: Service_ListSharesSegment description: >- The List Shares Segment operation returns a list of the shares and share snapshots under the specified account. parameters: - $ref: '#/parameters/Prefix' - $ref: '#/parameters/Marker' - $ref: '#/parameters/MaxResults' - $ref: '#/parameters/ListSharesInclude' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success. headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. schema: $ref: '#/definitions/ListSharesResponse' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' x-ms-pageable: nextLinkName: NextMarker parameters: - name: comp description: comp in: query required: true type: string enum: - list /{shareName}?restype=share: put: tags: - share operationId: Share_Create description: >- Creates a new share under the specified account. If the share with the same name already exists, the operation fails. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/ShareQuota' - $ref: '#/parameters/AccessTierOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ShareEnabledProtocols' - $ref: '#/parameters/ShareRootSquash' responses: '201': description: Success, Share created. headers: ETag: type: string description: >- The ETag contains a value which represents the version of the share, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' get: tags: - share operationId: Share_GetProperties 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. parameters: - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' responses: '200': description: Success headers: x-ms-meta: type: string description: >- A set of name-value pairs that contain the user-defined metadata of the share. x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-share-quota: x-ms-client-name: Quota type: integer description: Returns the current share quota in GB. x-ms-share-provisioned-iops: x-ms-client-name: ProvisionedIops type: integer description: Returns the current share provisioned ipos. x-ms-share-provisioned-ingress-mbps: x-ms-client-name: ProvisionedIngressMBps type: integer description: >- Returns the current share provisioned ingress in megabytes per second. x-ms-share-provisioned-egress-mbps: x-ms-client-name: ProvisionedEgressMBps type: integer description: >- Returns the current share provisioned egress in megabytes per second. x-ms-share-next-allowed-quota-downgrade-time: x-ms-client-name: NextAllowedQuotaDowngradeTime type: string format: date-time-rfc1123 description: Returns the current share next allowed quota downgrade time. x-ms-share-provisioned-bandwidth-mibps: x-ms-client-name: ProvisionedBandwidthMibps type: integer description: >- Returns the current share provisioned bandwidth in megabits per second. x-ms-lease-duration: x-ms-client-name: LeaseDuration description: >- When a share is leased, specifies whether the lease is of infinite or fixed duration. type: string enum: - infinite - fixed x-ms-enum: name: LeaseDurationType modelAsString: false x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the share. type: string enum: - available - leased - expired - breaking - broken x-ms-enum: name: LeaseStateType modelAsString: false x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the share. type: string enum: - locked - unlocked x-ms-enum: name: LeaseStatusType modelAsString: false x-ms-access-tier: x-ms-client-name: AccessTier type: string description: Returns the access tier set on the share. x-ms-access-tier-change-time: x-ms-client-name: AccessTierChangeTime type: string format: date-time-rfc1123 description: >- Returns the last modified time (in UTC) of the access tier of the share. x-ms-access-tier-transition-state: x-ms-client-name: AccessTierTransitionState type: string description: Returns the transition state between access tiers, when present. x-ms-enabled-protocols: x-ms-client-name: EnabledProtocols description: The protocols that have been enabled on the share. type: string x-ms-root-squash: x-ms-client-name: RootSquash description: Valid for NFS shares only. type: string enum: - NoRootSquash - RootSquash - AllSquash x-ms-enum: name: ShareRootSquash modelAsString: false default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' delete: tags: - share operationId: Share_Delete 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. parameters: - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/DeleteSnapshots' - $ref: '#/parameters/LeaseIdOptional' responses: '202': description: Accepted headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share /{shareName}?restype=share&comp=lease&acquire: put: tags: - share operationId: Share_AcquireLease description: >- The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseDuration' - $ref: '#/parameters/ProposedLeaseIdOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/ClientRequestId' responses: '201': description: The Acquire operation completed successfully. headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a share's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - acquire x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. - name: restype description: restype in: query required: true type: string enum: - share /{shareName}?restype=share&comp=lease&release: put: tags: - share operationId: Share_ReleaseLease description: >- The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseIdRequired' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/ClientRequestId' responses: '200': description: The Release operation completed successfully. headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - release x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. - name: restype description: restype in: query required: true type: string enum: - share /{shareName}?restype=share&comp=lease&change: put: tags: - share operationId: Share_ChangeLease description: >- The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseIdRequired' - $ref: '#/parameters/ProposedLeaseIdOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/ClientRequestId' responses: '200': description: The Change operation completed successfully. headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a share's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - change x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. - name: restype description: restype in: query required: true type: string enum: - share /{shareName}?restype=share&comp=lease&renew: put: tags: - share operationId: Share_RenewLease description: >- The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseIdRequired' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/ClientRequestId' responses: '200': description: The Renew operation completed successfully. headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a share's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: Returns the current share next allowed quota downgrade time. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - renew x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. - name: restype description: restype in: query required: true type: string enum: - share /{shareName}?restype=share&comp=lease&break: put: tags: - share operationId: Share_BreakLease description: >- The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseBreakPeriod' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/ShareSnapshot' responses: '202': description: The Break operation completed successfully. headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-time: x-ms-client-name: LeaseTime type: integer description: Approximate time remaining in the lease period, in seconds. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a share's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - break x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. - name: restype description: restype in: query required: true type: string enum: - share /{shareName}?restype=share&comp=snapshot: put: tags: - share operationId: Share_CreateSnapshot description: Creates a read-only snapshot of a share. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/ApiVersionParameter' responses: '201': description: Success, Share snapshot created. headers: x-ms-snapshot: x-ms-client-name: Snapshot type: string 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. ETag: type: string 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. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - snapshot /{shareName}?restype=share&comp=filepermission: put: tags: - share operationId: Share_CreatePermission description: Create a permission (a security descriptor). consumes: - application/json parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SharePermission' - $ref: '#/parameters/FileRequestIntent' responses: '201': description: Success, Share level permission created. headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the directory/file. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' get: tags: - share operationId: Share_GetPermission description: Returns the permission (security descriptor) for a given key produces: - application/json parameters: - $ref: '#/parameters/FilePermissionKeyRequired' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/SharePermission' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - filepermission /{shareName}?restype=share&comp=properties: put: tags: - share operationId: Share_SetProperties description: Sets properties for the specified share. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ShareQuota' - $ref: '#/parameters/AccessTierOptional' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/ShareRootSquash' responses: '200': description: Success headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - properties /{shareName}?restype=share&comp=metadata: put: tags: - share operationId: Share_SetMetadata description: Sets one or more user-defined name-value pairs for the specified share. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' responses: '200': description: Success headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - metadata /{shareName}?restype=share&comp=acl: get: tags: - share operationId: Share_GetAccessPolicy description: Returns information about stored access policies specified on the share. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' responses: '200': description: Success headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/SignedIdentifiers' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' put: tags: - share operationId: Share_SetAccessPolicy description: Sets a stored access policy for use with shared access signatures. parameters: - $ref: '#/parameters/ShareAcl' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' responses: '200': description: Success. headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - acl /{shareName}?restype=share&comp=stats: get: tags: - share operationId: Share_GetStatistics description: Retrieves statistics related to the share. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' responses: '200': description: Success headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/ShareStats' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - stats /{shareName}?restype=share&comp=undelete: put: tags: - share operationId: Share_Restore description: Restores a previously deleted Share. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/DeletedShareName' - $ref: '#/parameters/DeletedShareVersion' responses: '201': description: Created headers: ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - name: restype description: restype in: query required: true type: string enum: - share - name: comp description: comp in: query required: true type: string enum: - undelete /{shareName}/{directory}?restype=directory: put: tags: - directory operationId: Directory_Create description: Creates a new directory under the specified share or parent directory. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/FileAttributes' - $ref: '#/parameters/FileCreationTime' - $ref: '#/parameters/FileLastWriteTime' - $ref: '#/parameters/FileChangeTime' - $ref: '#/parameters/FileRequestIntent' responses: '201': description: Success, Directory created. headers: ETag: type: string description: >- The ETag contains a value which represents the version of the directory, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the directory. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the directory. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the directory. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the directory. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the directory. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the directory. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the directory. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' get: tags: - directory operationId: Directory_GetProperties 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. parameters: - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: x-ms-meta: type: string description: >- A set of name-value pairs that contain metadata for the directory. x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the directory. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the directory. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the directory. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the directory. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the directory. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the directory. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the directory. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' delete: tags: - directory operationId: Directory_Delete description: >- Removes the specified empty directory. Note that the directory must be empty before it can be deleted. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/FileRequestIntent' responses: '202': description: Success (Accepted). headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: restype description: restype in: query required: true type: string enum: - directory - $ref: '#/parameters/AllowTrailingDot' /{shareName}/{directory}?restype=directory&comp=properties: put: tags: - directory operationId: Directory_SetProperties description: Sets properties on the directory. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/FileAttributes' - $ref: '#/parameters/FileCreationTime' - $ref: '#/parameters/FileLastWriteTime' - $ref: '#/parameters/FileChangeTime' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the directory. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the directory. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the directory. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the directory. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the directory. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the directory. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the directory. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: restype description: restype in: query required: true type: string enum: - directory - name: comp description: comp in: query required: true type: string enum: - properties /{shareName}/{directory}?restype=directory&comp=metadata: put: tags: - directory operationId: Directory_SetMetadata description: Updates user defined metadata for the specified directory. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success (OK). headers: ETag: type: string description: >- The ETag contains a value which represents the version of the directory, in quotes. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: restype description: restype in: query required: true type: string enum: - directory - name: comp description: comp in: query required: true type: string enum: - metadata /{shareName}/{directory}?restype=directory&comp=list: get: tags: - directory operationId: Directory_ListFilesAndDirectoriesSegment 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. parameters: - $ref: '#/parameters/Prefix' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/Marker' - $ref: '#/parameters/MaxResults' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ListFilesInclude' - $ref: '#/parameters/ListFilesExtendedInfo' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: Content-Type: type: string description: >- Specifies the format in which the results are returned. Currently this value is 'application/xml'. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/ListFilesAndDirectoriesSegmentResponse' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' x-ms-pageable: nextLinkName: NextMarker parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: restype description: restype in: query required: true type: string enum: - directory - name: comp description: comp in: query required: true type: string enum: - list /{shareName}/{directory}?comp=listhandles: get: tags: - directory operationId: Directory_ListHandles description: Lists handles for directory. parameters: - $ref: '#/parameters/Marker' - $ref: '#/parameters/MaxResults' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/Recursive' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: Content-Type: type: string description: >- Specifies the format in which the results are returned. Currently this value is 'application/xml'. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/ListHandlesResponse' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: comp description: comp in: query required: true type: string enum: - listhandles /{shareName}/{directory}?comp=forceclosehandles: put: tags: - directory operationId: Directory_ForceCloseHandles description: Closes all handles open for given directory. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Marker' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/HandleId' - $ref: '#/parameters/Recursive' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-marker: x-ms-client-name: marker type: string description: >- A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request. x-ms-number-of-handles-closed: x-ms-client-name: numberOfHandlesClosed type: integer description: Contains count of number of handles closed. x-ms-number-of-handles-failed: x-ms-client-name: numberOfHandlesFailedToClose type: integer description: Contains count of number of handles that failed to close. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: comp description: comp in: query required: true type: string enum: - forceclosehandles /{shareName}/{directory}?restype=directory&comp=rename: put: tags: - directory operationId: Directory_Rename description: Renames a directory parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/RenameSource' - $ref: '#/parameters/RenameReplaceIfExists' - $ref: '#/parameters/RenameIgnoreReadOnly' - $ref: '#/parameters/SourceLeaseId' - $ref: '#/parameters/DestinationLeaseId' - $ref: '#/parameters/FileCopyFileAttributes' - $ref: '#/parameters/FileCopyFileCreationTime' - $ref: '#/parameters/FileCopyFileLastWriteTime' - $ref: '#/parameters/FileCopyFileChangeTime' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/SourceAllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the file. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the directory. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - name: restype description: restype in: query required: true type: string enum: - directory - name: comp description: comp in: query required: true type: string enum: - rename /{shareName}/{directory}/{fileName}: put: tags: - file operationId: File_Create description: >- Creates a new file or replaces a file. Note it only initializes the file with no content. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - name: x-ms-content-length x-ms-client-name: fileContentLength in: header description: Specifies the maximum size for the file, up to 4 TB. required: true type: integer format: int64 - $ref: '#/parameters/FileType' - $ref: '#/parameters/FileContentType' - $ref: '#/parameters/FileContentEncoding' - $ref: '#/parameters/FileContentLanguage' - $ref: '#/parameters/FileCacheControl' - $ref: '#/parameters/FileContentMD5' - $ref: '#/parameters/FileContentDisposition' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/FileAttributes' - $ref: '#/parameters/FileCreationTime' - $ref: '#/parameters/FileLastWriteTime' - $ref: '#/parameters/FileChangeTime' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/FileRequestIntent' responses: '201': description: Success, File created. headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the file. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the file. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' get: tags: - file operationId: File_Download description: >- Reads or downloads a file from the system, including its metadata and properties. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/Range' - $ref: '#/parameters/GetRangeContentMD5' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Succeeded to read the entire file. headers: Last-Modified: type: string format: date-time-rfc1123 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. x-ms-meta: type: string description: >- A set of name-value pairs associated with this file as user-defined metadata. x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- Content-Length: type: integer format: int64 description: The number of bytes present in the response body. Content-Type: type: string description: >- The content type specified for the file. The default content type is 'application/octet-stream' Content-Range: type: string description: >- Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header. ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Content-MD5: type: string format: byte 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. Content-Encoding: type: string description: >- Returns the value that was specified for the Content-Encoding request header. Cache-Control: type: string description: Returned if it was previously specified for the file. Content-Disposition: type: string description: >- Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. Content-Language: type: string description: >- Returns the value that was specified for the Content-Language request header. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Accept-Ranges: type: string description: >- Indicates that the service supports requests for partial file content. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime type: string format: date-time-rfc1123 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. x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription type: string description: >- Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. x-ms-copy-id: x-ms-client-name: CopyId type: string description: >- String identifier for the last attempted Copy File operation where this file was the destination file. x-ms-copy-progress: x-ms-client-name: CopyProgress type: string 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. x-ms-copy-source: x-ms-client-name: CopySource type: string 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. x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by 'x-ms-copy-id'. type: string enum: - pending - success - aborted - failed x-ms-enum: name: CopyStatusType modelAsString: false x-ms-content-md5: x-ms-client-name: FileContentMD5 type: string format: byte 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. x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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). x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the file. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the file. x-ms-lease-duration: x-ms-client-name: LeaseDuration description: >- When a file is leased, specifies whether the lease is of infinite or fixed duration. type: string enum: - infinite - fixed x-ms-enum: name: LeaseDurationType modelAsString: false x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the file. type: string enum: - available - leased - expired - breaking - broken x-ms-enum: name: LeaseStateType modelAsString: false x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the file. type: string enum: - locked - unlocked x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: object format: file '206': description: Succeeded to read a specified range of the file. headers: Last-Modified: type: string format: date-time-rfc1123 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. x-ms-meta: type: string description: >- A set of name-value pairs associated with this file as user-defined metadata. x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- Content-Length: type: integer format: int64 description: The number of bytes present in the response body. Content-Type: type: string description: >- The content type specified for the file. The default content type is 'application/octet-stream' Content-Range: type: string description: >- Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header. ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Content-MD5: type: string format: byte 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. Content-Encoding: type: string description: >- Returns the value that was specified for the Content-Encoding request header. Cache-Control: type: string description: Returned if it was previously specified for the file. Content-Disposition: type: string description: >- Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. Content-Language: type: string description: >- Returns the value that was specified for the Content-Language request header. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Accept-Ranges: type: string description: >- Indicates that the service supports requests for partial file content. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime type: string format: date-time-rfc1123 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. x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription type: string description: >- Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. x-ms-copy-id: x-ms-client-name: CopyId type: string description: >- String identifier for the last attempted Copy File operation where this file was the destination file. x-ms-copy-progress: x-ms-client-name: CopyProgress type: string 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. x-ms-copy-source: x-ms-client-name: CopySource type: string 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. x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by 'x-ms-copy-id'. type: string enum: - pending - success - aborted - failed x-ms-enum: name: CopyStatusType modelAsString: false x-ms-content-md5: x-ms-client-name: FileContentMD5 type: string format: byte 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. x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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). x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the file. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the file. x-ms-lease-duration: x-ms-client-name: LeaseDuration description: >- When a file is leased, specifies whether the lease is of infinite or fixed duration. type: string enum: - infinite - fixed x-ms-enum: name: LeaseDurationType modelAsString: false x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the file. type: string enum: - available - leased - expired - breaking - broken x-ms-enum: name: LeaseStateType modelAsString: false x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the file. type: string enum: - locked - unlocked x-ms-enum: name: LeaseStatusType modelAsString: false schema: type: object format: file default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' head: tags: - file operationId: File_GetProperties description: >- Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file. parameters: - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: Last-Modified: type: string format: date-time-rfc1123 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. x-ms-meta: type: string description: >- A set of name-value pairs associated with this file as user-defined metadata. x-ms-client-name: Metadata x-ms-header-collection-prefix: x-ms-meta- x-ms-type: x-ms-client-name: FileType description: Returns the type File. Reserved for future use. type: string enum: - File Content-Length: type: integer format: int64 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. Content-Type: type: string description: >- The content type specified for the file. The default content type is 'application/octet-stream' ETag: type: string description: >- The ETag contains a value that you can use to perform operations conditionally, in quotes. Content-MD5: type: string format: byte 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. Content-Encoding: type: string description: >- If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header. Cache-Control: type: string description: >- If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header. Content-Disposition: type: string description: >- Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. Content-Language: type: string description: >- Returns the value that was specified for the Content-Language request header. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-copy-completion-time: x-ms-client-name: CopyCompletionTime type: string format: date-time-rfc1123 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. x-ms-copy-status-description: x-ms-client-name: CopyStatusDescription type: string description: >- Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. x-ms-copy-id: x-ms-client-name: CopyId type: string description: >- String identifier for the last attempted Copy File operation where this file was the destination file. x-ms-copy-progress: x-ms-client-name: CopyProgress type: string 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. x-ms-copy-source: x-ms-client-name: CopySource type: string 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. x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by 'x-ms-copy-id'. type: string enum: - pending - success - aborted - failed x-ms-enum: name: CopyStatusType modelAsString: false x-ms-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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). x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the file. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the file. x-ms-lease-duration: x-ms-client-name: LeaseDuration description: >- When a file is leased, specifies whether the lease is of infinite or fixed duration. type: string enum: - infinite - fixed x-ms-enum: name: LeaseDurationType modelAsString: false x-ms-lease-state: x-ms-client-name: LeaseState description: Lease state of the file. type: string enum: - available - leased - expired - breaking - broken x-ms-enum: name: LeaseStateType modelAsString: false x-ms-lease-status: x-ms-client-name: LeaseStatus description: The current lease status of the file. type: string enum: - locked - unlocked x-ms-enum: name: LeaseStatusType modelAsString: false default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' delete: tags: - file operationId: File_Delete description: removes the file from the storage account. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/FileRequestIntent' responses: '202': description: Success (Accepted). headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - $ref: '#/parameters/AllowTrailingDot' /{shareName}/{directory}/{fileName}?comp=properties: put: tags: - file operationId: File_SetHTTPHeaders description: Sets HTTP headers on the file. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - name: x-ms-content-length x-ms-client-name: fileContentLength in: header 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. required: false type: integer format: int64 - $ref: '#/parameters/FileContentType' - $ref: '#/parameters/FileContentEncoding' - $ref: '#/parameters/FileContentLanguage' - $ref: '#/parameters/FileCacheControl' - $ref: '#/parameters/FileContentMD5' - $ref: '#/parameters/FileContentDisposition' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/FileAttributes' - $ref: '#/parameters/FileCreationTime' - $ref: '#/parameters/FileLastWriteTime' - $ref: '#/parameters/FileChangeTime' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the directory. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the directory. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - properties /{shareName}/{directory}/{fileName}?comp=metadata: put: tags: - file operationId: File_SetMetadata description: Updates user-defined metadata for the specified file. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success (OK). headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - metadata /{shareName}/{directory}/{fileName}?comp=lease&acquire: put: tags: - file operationId: File_AcquireLease description: >- [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseDuration' - $ref: '#/parameters/ProposedLeaseIdOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '201': description: The Acquire operation completed successfully. headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a file's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - acquire x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. /{shareName}/{directory}/{fileName}?comp=lease&release: put: tags: - file operationId: File_ReleaseLease description: >- [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseIdRequired' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: The Release operation completed successfully. headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - release x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. /{shareName}/{directory}/{fileName}?comp=lease&change: put: tags: - file operationId: File_ChangeLease description: >- [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseIdRequired' - $ref: '#/parameters/ProposedLeaseIdOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: The Change operation completed successfully. headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a file's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - change x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. /{shareName}/{directory}/{fileName}?comp=lease&break: put: tags: - file operationId: File_BreakLease description: >- [Update] The Lease File operation establishes and manages a lock on a file for write and delete operations parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/ClientRequestId' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '202': description: The Break operation completed successfully. headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-lease-id: x-ms-client-name: LeaseId type: string description: Uniquely identifies a file's lease x-ms-client-request-id: x-ms-client-name: ClientRequestId type: string description: >- If a client request id header is sent in the request, this header will be present in the response with the same value. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- UTC date/time value generated by the service that indicates the time at which the response was initiated default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - lease - name: x-ms-lease-action x-ms-client-name: action in: header required: true type: string enum: - break x-ms-enum: name: LeaseAction modelAsString: false x-ms-parameter-location: method description: Describes what lease action to take. /{shareName}/{directory}/{fileName}?comp=range: put: tags: - file operationId: File_UploadRange description: Upload a range of bytes to a file. consumes: - application/octet-stream parameters: - $ref: '#/parameters/OptionalBody' - $ref: '#/parameters/Timeout' - name: x-ms-range x-ms-client-name: range in: header 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 type: string - name: x-ms-write x-ms-client-name: FileRangeWrite in: header 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 type: string enum: - update - clear default: update x-ms-enum: name: FileRangeWriteType modelAsString: false - $ref: '#/parameters/ContentLength' - $ref: '#/parameters/ContentMD5' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/FileLastWriteTimeMode' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '201': description: Success (Created). headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. Content-MD5: type: string format: byte 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - range /{shareName}/{directory}/{fileName}?comp=range&fromURL: put: tags: - file operationId: File_UploadRangeFromURL description: >- Upload a range of bytes to a file where the contents are read from a URL. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/TargetRange' - $ref: '#/parameters/CopySource' - $ref: '#/parameters/SourceRange' - $ref: '#/parameters/FileRangeWriteFromUrl' - $ref: '#/parameters/ContentLength' - $ref: '#/parameters/SourceContentCrc64' - $ref: '#/parameters/SourceIfMatchCrc64' - $ref: '#/parameters/SourceIfNoneMatchCrc64' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/CopySourceAuthorization' - $ref: '#/parameters/FileLastWriteTimeMode' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/SourceAllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '201': description: Success (Created). headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-content-crc64: type: string format: byte 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - range /{shareName}/{directory}/{fileName}?comp=rangelist: get: tags: - file operationId: File_GetRangeList description: Returns the list of valid ranges for a file. parameters: - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/PrevShareSnapshot' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - name: x-ms-range x-ms-client-name: range in: header description: Specifies the range of bytes over which to list ranges, inclusively. required: false type: string - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' - $ref: '#/parameters/SupportRename' responses: '200': description: Success. headers: Last-Modified: type: string format: date-time-rfc1123 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. ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. x-ms-content-length: x-ms-client-name: FileContentLength type: integer format: int64 description: The size of the file in bytes. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/ShareFileRangeList' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - rangelist /{shareName}/{directory}/{fileName}?comp=copy: put: tags: - file operationId: File_StartCopy description: Copies a blob or file to a destination file within the storage account. parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/CopySource' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/FileCopyPermissionCopyMode' - $ref: '#/parameters/FileCopyIgnoreReadOnly' - $ref: '#/parameters/FileCopyFileAttributes' - $ref: '#/parameters/FileCopyFileCreationTime' - $ref: '#/parameters/FileCopyFileLastWriteTime' - $ref: '#/parameters/FileCopyFileChangeTime' - $ref: '#/parameters/FileCopySetArchiveAttribute' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/SourceAllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '202': description: The copy file has been accepted with the specified copy status. headers: ETag: type: string 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. Last-Modified: type: string format: date-time-rfc1123 description: >- Returns the date/time that the copy operation to the destination file completed. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-copy-id: x-ms-client-name: CopyId type: string 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. x-ms-copy-status: x-ms-client-name: CopyStatus description: State of the copy operation identified by x-ms-copy-id. type: string enum: - pending - success - aborted - failed x-ms-enum: name: CopyStatusType modelAsString: false default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' /{shareName}/{directory}/{fileName}?comp=copy©id: put: tags: - file operationId: File_AbortCopy description: >- Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata. parameters: - $ref: '#/parameters/CopyId' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/CopyActionAbort' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/LeaseIdOptional' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '204': description: The delete request was accepted and the file will be deleted. headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - copy /{shareName}/{directory}/{fileName}?comp=listhandles: get: tags: - file operationId: File_ListHandles description: Lists handles for file parameters: - $ref: '#/parameters/Marker' - $ref: '#/parameters/MaxResults' - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: Content-Type: type: string description: >- Specifies the format in which the results are returned. Currently this value is 'application/xml'. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. schema: $ref: '#/definitions/ListHandlesResponse' default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - listhandles /{shareName}/{directory}/{fileName}?comp=forceclosehandles: put: tags: - file operationId: File_ForceCloseHandles description: Closes all handles open for given file parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/Marker' - $ref: '#/parameters/ShareSnapshot' - $ref: '#/parameters/HandleId' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-marker: x-ms-client-name: marker type: string description: >- A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request. x-ms-number-of-handles-closed: x-ms-client-name: numberOfHandlesClosed type: integer description: Contains count of number of handles closed. x-ms-number-of-handles-failed: x-ms-client-name: numberOfHandlesFailedToClose type: integer description: Contains count of number of handles that failed to close. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - forceclosehandles /{shareName}/{directory}/{fileName}?comp=rename: put: tags: - file operationId: File_Rename description: Renames a file parameters: - $ref: '#/parameters/Timeout' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/RenameSource' - $ref: '#/parameters/RenameReplaceIfExists' - $ref: '#/parameters/RenameIgnoreReadOnly' - $ref: '#/parameters/SourceLeaseId' - $ref: '#/parameters/DestinationLeaseId' - $ref: '#/parameters/FileCopyFileAttributes' - $ref: '#/parameters/FileCopyFileCreationTime' - $ref: '#/parameters/FileCopyFileLastWriteTime' - $ref: '#/parameters/FileCopyFileChangeTime' - $ref: '#/parameters/FilePermission' - $ref: '#/parameters/FilePermissionKey' - $ref: '#/parameters/Metadata' - $ref: '#/parameters/FileContentType' - $ref: '#/parameters/AllowTrailingDot' - $ref: '#/parameters/SourceAllowTrailingDot' - $ref: '#/parameters/FileRequestIntent' responses: '200': description: Success. headers: ETag: type: string description: >- The ETag contains a value which represents the version of the file, in quotes. Last-Modified: type: string format: date-time-rfc1123 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. x-ms-request-id: x-ms-client-name: RequestId type: string description: >- This header uniquely identifies the request that was made and can be used for troubleshooting the request. x-ms-version: x-ms-client-name: Version type: string description: >- Indicates the version of the File service used to execute the request. Date: type: string format: date-time-rfc1123 description: >- A UTC date/time value generated by the service that indicates the time at which the response was initiated. x-ms-request-server-encrypted: x-ms-client-name: IsServerEncrypted type: boolean 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. x-ms-file-permission-key: x-ms-client-name: FilePermissionKey type: string description: Key of the permission set for the file. x-ms-file-attributes: x-ms-client-name: FileAttributes type: string description: Attributes set for the file. x-ms-file-creation-time: x-ms-client-name: FileCreationTime type: string format: date-time-rfc1123 description: Creation time for the file. x-ms-file-last-write-time: x-ms-client-name: FileLastWriteTime type: string format: date-time-rfc1123 description: Last write time for the file. x-ms-file-change-time: x-ms-client-name: FileChangeTime type: string format: date-time-rfc1123 description: Change time for the file. x-ms-file-id: x-ms-client-name: FileId type: string description: The fileId of the file. x-ms-file-parent-id: x-ms-client-name: FileParentId type: string description: The parent fileId of the directory. default: description: Failure headers: x-ms-error-code: x-ms-client-name: ErrorCode type: string schema: $ref: '#/definitions/StorageError' parameters: - $ref: '#/parameters/ShareName' - $ref: '#/parameters/DirectoryPath' - $ref: '#/parameters/FilePath' - name: comp description: comp in: query required: true type: string enum: - rename definitions: AccessRight: description: Access rights of the access policy. type: string enum: - Read - Write - Delete x-ms-enum: name: AccessRight modelAsString: false AccessPolicy: description: An Access policy. type: object properties: Start: description: The date-time the policy is active. type: string format: date-time Expiry: description: The date-time the policy expires. type: string format: date-time Permission: description: The permissions for the ACL policy. type: string CorsRule: description: >- CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain. type: object required: - AllowedOrigins - AllowedMethods - AllowedHeaders - ExposedHeaders - MaxAgeInSeconds properties: 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. type: string AllowedMethods: description: >- The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) type: string AllowedHeaders: description: >- The request headers that the origin domain may specify on the CORS request. type: 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. type: string MaxAgeInSeconds: description: >- The maximum amount time that a browser should cache the preflight OPTIONS request. type: integer minimum: 0 ErrorCode: description: Error codes returned by the service type: string enum: - AccountAlreadyExists - AccountBeingCreated - AccountIsDisabled - AuthenticationFailed - AuthorizationFailure - ConditionHeadersNotSupported - ConditionNotMet - EmptyMetadataKey - InsufficientAccountPermissions - InternalError - InvalidAuthenticationInfo - InvalidHeaderValue - InvalidHttpVerb - InvalidInput - InvalidMd5 - InvalidMetadata - InvalidQueryParameterValue - InvalidRange - InvalidResourceName - InvalidUri - InvalidXmlDocument - InvalidXmlNodeValue - Md5Mismatch - MetadataTooLarge - MissingContentLengthHeader - MissingRequiredQueryParameter - MissingRequiredHeader - MissingRequiredXmlNode - MultipleConditionHeadersNotSupported - OperationTimedOut - OutOfRangeInput - OutOfRangeQueryParameterValue - RequestBodyTooLarge - ResourceTypeMismatch - RequestUrlFailedToParse - ResourceAlreadyExists - ResourceNotFound - ServerBusy - UnsupportedHeader - UnsupportedXmlNode - UnsupportedQueryParameter - UnsupportedHttpVerb - CannotDeleteFileOrDirectory - ClientCacheFlushDelay - DeletePending - DirectoryNotEmpty - FileLockConflict - InvalidFileOrDirectoryPathName - ParentNotFound - ReadOnlyAttribute - ShareAlreadyExists - ShareBeingDeleted - ShareDisabled - ShareNotFound - SharingViolation - ShareSnapshotInProgress - ShareSnapshotCountExceeded - ShareSnapshotOperationNotSupported - ShareHasSnapshots - PreviousSnapshotNotFound - ContainerQuotaDowngradeNotAllowed - AuthorizationSourceIPMismatch - AuthorizationProtocolMismatch - AuthorizationPermissionMismatch - AuthorizationServiceMismatch - AuthorizationResourceTypeMismatch - FeatureVersionMismatch x-ms-enum: name: StorageErrorCode modelAsString: true FilesAndDirectoriesListSegment: description: Abstract for entries that can be listed from Directory. type: object required: - DirectoryItems - FileItems properties: DirectoryItems: type: array items: $ref: '#/definitions/DirectoryItem' FileItems: type: array items: $ref: '#/definitions/FileItem' xml: name: Entries DirectoryItem: xml: name: Directory description: A listed directory item. type: object required: - Name properties: Name: $ref: '#/definitions/StringEncoded' FileId: type: string Properties: $ref: '#/definitions/FileProperty' Attributes: type: string PermissionKey: type: string FileItem: xml: name: File description: A listed file item. type: object required: - Name - Properties properties: Name: $ref: '#/definitions/StringEncoded' FileId: type: string Properties: $ref: '#/definitions/FileProperty' Attributes: type: string PermissionKey: type: string StringEncoded: type: object properties: Encoded: xml: name: Encoded attribute: true type: boolean content: xml: x-ms-text: true type: string FileProperty: description: File properties. type: object required: - Content-Length properties: 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. type: integer format: int64 CreationTime: type: string format: date-time LastAccessTime: type: string format: date-time LastWriteTime: type: string format: date-time ChangeTime: type: string format: date-time Last-Modified: type: string format: date-time-rfc1123 Etag: type: string HandleItem: xml: name: Handle description: A listed Azure Storage handle item. type: object required: - HandleId - Path - FileId - SessionId - ClientIp - ClientName - OpenTime properties: HandleId: type: string description: XSMB service handle ID Path: $ref: '#/definitions/StringEncoded' FileId: type: string description: FileId uniquely identifies the file or directory. ParentId: type: string description: ParentId uniquely identifies the parent directory of the object. SessionId: type: string description: SMB session ID in context of which the file handle was opened ClientIp: type: string description: Client IP that opened the handle ClientName: type: string description: Name of the client machine where the share is being mounted OpenTime: type: string format: date-time-rfc1123 description: >- Time when the session that previously opened the handle has last been reconnected. (UTC) LastReconnectTime: type: string format: date-time-rfc1123 description: Time handle was last connected to (UTC) AccessRightList: type: array items: $ref: '#/definitions/AccessRight' xml: wrapped: true LeaseDuration: xml: name: LeaseDuration description: >- When a share is leased, specifies whether the lease is of infinite or fixed duration. type: string enum: - infinite - fixed x-ms-enum: name: LeaseDurationType modelAsString: false LeaseState: xml: name: LeaseState description: Lease state of the share. type: string enum: - available - leased - expired - breaking - broken x-ms-enum: name: LeaseStateType modelAsString: false LeaseStatus: xml: name: LeaseStatus description: The current lease status of the share. type: string enum: - locked - unlocked x-ms-enum: name: LeaseStatusType modelAsString: false ListFilesAndDirectoriesSegmentResponse: xml: name: EnumerationResults description: An enumeration of directories and files. type: object required: - ServiceEndpoint - ShareName - DirectoryPath - Prefix - NextMarker - Segment properties: ServiceEndpoint: type: string xml: attribute: true ShareName: type: string xml: attribute: true ShareSnapshot: type: string xml: attribute: true Encoded: type: boolean xml: attribute: true DirectoryPath: type: string xml: attribute: true Prefix: $ref: '#/definitions/StringEncoded' Marker: type: string MaxResults: type: integer Segment: $ref: '#/definitions/FilesAndDirectoriesListSegment' NextMarker: type: string DirectoryId: type: string ListHandlesResponse: xml: name: EnumerationResults description: An enumeration of handles. type: object required: - NextMarker properties: HandleList: type: array items: $ref: '#/definitions/HandleItem' xml: name: Entries wrapped: true NextMarker: type: string ListSharesResponse: xml: name: EnumerationResults description: An enumeration of shares. type: object required: - ServiceEndpoint - NextMarker properties: ServiceEndpoint: type: string xml: attribute: true Prefix: type: string Marker: type: string MaxResults: type: integer ShareItems: type: array items: $ref: '#/definitions/ShareItemInternal' xml: name: Shares wrapped: true NextMarker: type: string Metadata: type: object additionalProperties: type: string Metrics: description: Storage Analytics metrics for file service. required: - Version - Enabled properties: Version: description: The version of Storage Analytics to configure. type: string Enabled: description: Indicates whether metrics are enabled for the File service. type: boolean IncludeAPIs: description: >- Indicates whether metrics should generate summary statistics for called API operations. type: boolean RetentionPolicy: $ref: '#/definitions/RetentionPolicy' SmbMultichannel: description: Settings for SMB multichannel type: object properties: Enabled: type: boolean description: If SMB multichannel is enabled. xml: name: Multichannel FileRange: description: An Azure Storage file range. type: object required: - Start - End properties: Start: type: integer format: int64 description: Start of the range. End: type: integer format: int64 description: End of the range. xml: name: Range ClearRange: type: object required: - Start - End properties: Start: type: integer format: int64 xml: name: Start End: type: integer format: int64 xml: name: End xml: name: ClearRange ShareProtocolSettings: description: Protocol settings type: object xml: name: ProtocolSettings properties: Smb: description: Settings for SMB protocol. $ref: '#/definitions/ShareSmbSettings' ShareFileRangeList: description: The list of file ranges type: object properties: Ranges: type: array items: $ref: '#/definitions/FileRange' ClearRanges: type: array items: $ref: '#/definitions/ClearRange' StorageError: type: object properties: Message: type: string RetentionPolicy: description: The retention policy. type: object required: - Enabled properties: 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. type: 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. type: integer minimum: 1 maximum: 365 ShareItemInternal: xml: name: Share description: A listed Azure Storage share item. type: object required: - Name - Properties properties: Name: type: string Snapshot: type: string Deleted: type: boolean Version: type: string Properties: $ref: '#/definitions/SharePropertiesInternal' Metadata: $ref: '#/definitions/Metadata' SharePropertiesInternal: description: Properties of a share. type: object required: - Last-Modified - Etag - Quota properties: Last-Modified: type: string format: date-time-rfc1123 Etag: type: string Quota: type: integer ProvisionedIops: type: integer ProvisionedIngressMBps: type: integer ProvisionedEgressMBps: type: integer ProvisionedBandwidthMiBps: type: integer NextAllowedQuotaDowngradeTime: type: string format: date-time-rfc1123 DeletedTime: type: string format: date-time-rfc1123 RemainingRetentionDays: type: integer AccessTier: type: string AccessTierChangeTime: type: string format: date-time-rfc1123 AccessTierTransitionState: type: string LeaseStatus: $ref: '#/definitions/LeaseStatus' LeaseState: $ref: '#/definitions/LeaseState' LeaseDuration: $ref: '#/definitions/LeaseDuration' EnabledProtocols: $ref: '#/definitions/ShareEnabledProtocols' RootSquash: $ref: '#/definitions/ShareRootSquash' ShareStats: description: Stats for the share. type: object required: - ShareUsageBytes properties: 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. type: integer SignedIdentifier: description: Signed identifier. type: object required: - Id properties: Id: type: string description: A unique id. AccessPolicy: description: The access policy. $ref: '#/definitions/AccessPolicy' SignedIdentifiers: description: A collection of signed identifiers. type: array items: $ref: '#/definitions/SignedIdentifier' xml: name: SignedIdentifier xml: wrapped: true name: SignedIdentifiers ShareSmbSettings: description: Settings for SMB protocol. type: object xml: name: SMB properties: Multichannel: description: Settings for SMB Multichannel. $ref: '#/definitions/SmbMultichannel' StorageServiceProperties: description: Storage service properties. type: object properties: HourMetrics: description: >- A summary of request statistics grouped by API in hourly aggregates for files. $ref: '#/definitions/Metrics' MinuteMetrics: description: >- A summary of request statistics grouped by API in minute aggregates for files. $ref: '#/definitions/Metrics' Cors: description: The set of CORS rules. type: array items: $ref: '#/definitions/CorsRule' xml: wrapped: true Protocol: description: Protocol settings $ref: '#/definitions/ShareProtocolSettings' SharePermission: description: A permission (a security descriptor) at the share level. type: object required: - permission properties: permission: type: string description: The permission in the Security Descriptor Definition Language (SDDL). ShareEnabledProtocols: type: string ShareRootSquash: type: string enum: - NoRootSquash - RootSquash - AllSquash x-ms-enum: name: ShareRootSquash modelAsString: false parameters: AccessTierOptional: name: x-ms-access-tier x-ms-client-name: accessTier in: header description: Specifies the access tier of the share. required: false type: string x-ms-parameter-location: method enum: - TransactionOptimized - Hot - Cool x-ms-enum: name: ShareAccessTier modelAsString: true ApiVersionParameter: name: x-ms-version x-ms-client-name: version x-ms-parameter-location: client in: header description: Specifies the version of the operation to use for this request. required: true type: string enum: - '2024-05-04' ClientRequestId: name: x-ms-client-request-id x-ms-client-name: requestId in: header required: false type: string x-ms-parameter-location: method 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. ContentLength: name: Content-Length x-ms-client-name: contentLength in: header 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. required: true type: integer format: int64 x-ms-parameter-location: method ContentMD5: name: Content-MD5 x-ms-client-name: contentMD5 in: header 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). required: false type: string format: byte x-ms-parameter-location: method CopyActionAbort: name: x-ms-copy-action x-ms-client-name: copyActionAbortConstant in: header required: true type: string enum: - abort x-ms-parameter-location: method description: Abort. CopyId: name: copyid x-ms-client-name: copyId in: query required: true type: string x-ms-parameter-location: method description: >- The copy identifier provided in the x-ms-copy-id header of the original Copy File operation. CopySource: name: x-ms-copy-source x-ms-client-name: copySource in: header required: true type: string x-ms-parameter-location: method 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. CopySourceAuthorization: name: x-ms-copy-source-authorization x-ms-client-name: copySourceAuthorization in: header required: false type: string x-ms-parameter-location: method description: >- Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. FileCopyPermissionCopyMode: name: x-ms-file-permission-copy-mode x-ms-client-name: filePermissionCopyMode in: header required: false type: string enum: - source - override x-ms-enum: name: PermissionCopyModeType modelAsString: false x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info 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. FileCopyIgnoreReadOnly: name: x-ms-file-copy-ignore-readonly x-ms-client-name: ignoreReadOnly in: header required: false type: boolean x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info description: >- Specifies the option to overwrite the target file if it already exists and has read-only attribute set. FileCopyFileAttributes: name: x-ms-file-attributes x-ms-client-name: fileAttributes in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info 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. FileCopyFileCreationTime: name: x-ms-file-creation-time x-ms-client-name: fileCreationTime in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info 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. FileCopyFileLastWriteTime: name: x-ms-file-last-write-time x-ms-client-name: fileLastWriteTime in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info 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. FileCopyFileChangeTime: name: x-ms-file-change-time x-ms-client-name: fileChangeTime in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info 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. FileCopySetArchiveAttribute: name: x-ms-file-copy-set-archive x-ms-client-name: setArchiveAttribute in: header required: false type: boolean x-ms-parameter-location: method x-ms-parameter-grouping: name: copy-file-smb-info 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. DeletedShareName: name: x-ms-deleted-share-name x-ms-client-name: DeletedShareName description: Specifies the name of the previously-deleted share. in: header required: false type: string x-ms-parameter-location: method DirectoryPath: name: directory in: path description: The path of the target directory. required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: false FilePath: name: fileName in: path description: The path of the target file. required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: false ShareName: name: shareName in: path description: The name of the target share. required: true type: string x-ms-parameter-location: method DeletedShareVersion: name: x-ms-deleted-share-version x-ms-client-name: DeletedShareVersion description: Specifies the version of the previously-deleted share. in: header required: false type: string x-ms-parameter-location: method DeleteSnapshots: name: x-ms-delete-snapshots x-ms-client-name: deleteSnapshots description: >- Specifies the option include to delete the base share and all of its snapshots. in: header required: false type: string enum: - include - include-leased x-ms-enum: name: DeleteSnapshotsOptionType modelAsString: false x-ms-parameter-location: method DestinationLeaseId: name: x-ms-destination-lease-id x-ms-client-name: destinationLeaseId in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: destination-lease-access-conditions 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). FileAttributes: name: x-ms-file-attributes x-ms-client-name: FileAttributes in: header 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: true type: string x-ms-parameter-location: method FileCacheControl: name: x-ms-cache-control x-ms-client-name: fileCacheControl description: >- Sets the file's cache control. The File service stores this value but does not use or modify it. in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: file-HTTP-headers FileContentDisposition: name: x-ms-content-disposition x-ms-client-name: fileContentDisposition description: Sets the file's Content-Disposition header. in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: file-HTTP-headers FileContentEncoding: name: x-ms-content-encoding x-ms-client-name: fileContentEncoding in: header description: Specifies which content encodings have been applied to the file. required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: file-HTTP-headers FileContentLanguage: name: x-ms-content-language x-ms-client-name: fileContentLanguage in: header description: Specifies the natural languages used by this resource. required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: file-HTTP-headers FileContentMD5: name: x-ms-content-md5 x-ms-client-name: fileContentMD5 in: header description: Sets the file's MD5 hash. required: false type: string format: byte x-ms-parameter-location: method x-ms-parameter-grouping: name: file-HTTP-headers FileContentType: name: x-ms-content-type x-ms-client-name: fileContentType in: header description: >- Sets the MIME content type of the file. The default type is 'application/octet-stream'. required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: file-HTTP-headers FileCreationTime: name: x-ms-file-creation-time x-ms-client-name: FileCreationTime in: header description: 'Creation time for the file/directory. Default value: Now.' required: false type: string format: date-time-rfc1123 x-ms-parameter-location: method FileLastWriteTime: name: x-ms-file-last-write-time x-ms-client-name: FileLastWriteTime in: header description: 'Last write time for the file/directory. Default value: Now.' required: false type: string format: date-time-rfc1123 x-ms-parameter-location: method FileChangeTime: name: x-ms-file-change-time x-ms-client-name: FileChangeTime in: header description: 'Change time for the file/directory. Default value: Now.' required: false type: string format: date-time-rfc1123 x-ms-parameter-location: method FileLastWriteTimeMode: name: x-ms-file-last-write-time x-ms-client-name: FileLastWrittenMode in: header description: If the file last write time should be preserved or overwritten required: false x-ms-parameter-location: method type: string enum: - Now - Preserve x-ms-enum: name: FileLastWrittenMode modelAsString: false FilePermission: name: x-ms-file-permission x-ms-client-name: FilePermission in: header 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 type: string x-ms-parameter-location: method FilePermissionKey: name: x-ms-file-permission-key x-ms-client-name: FilePermissionKey in: header 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 type: string x-ms-parameter-location: method FilePermissionKeyRequired: name: x-ms-file-permission-key x-ms-client-name: FilePermissionKey in: header description: Key of the permission to be set for the directory/file. required: true type: string x-ms-parameter-location: method FileRangeWriteFromUrl: name: x-ms-write x-ms-parameter-location: client x-ms-client-name: fileRangeWriteFromUrl in: header description: >- Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range. required: true type: string enum: - update default: update x-ms-enum: name: FileRangeWriteFromUrlType modelAsString: false FileRequestIntent: name: x-ms-file-request-intent x-ms-client-name: fileRequestIntent in: header description: Valid value is backup required: false type: string enum: - backup x-ms-enum: name: ShareTokenIntent modelAsString: true SupportRename: name: x-ms-file-support-rename x-ms-client-name: SupportRename in: header required: false type: boolean 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. x-ms-parameter-location: method FileType: name: x-ms-type x-ms-client-name: fileTypeConstant in: header required: true description: Dummy constant parameter, file type can only be file. type: string enum: - file x-ms-parameter-location: method GetRangeContentMD5: name: x-ms-range-get-content-md5 x-ms-client-name: rangeGetContentMD5 in: header required: false type: boolean x-ms-parameter-location: method 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. HandleId: name: x-ms-handle-id x-ms-client-name: handleId in: header description: >- Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles. required: true type: string x-ms-parameter-location: method LeaseBreakPeriod: name: x-ms-lease-break-period x-ms-client-name: breakPeriod in: header required: false type: integer x-ms-parameter-location: method 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. LeaseDuration: name: x-ms-lease-duration x-ms-client-name: duration in: header required: false type: integer x-ms-parameter-location: method 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. LeaseIdOptional: name: x-ms-lease-id x-ms-client-name: leaseId in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: lease-access-conditions description: >- If specified, the operation only succeeds if the resource's lease is active and matches this ID. LeaseIdRequired: name: x-ms-lease-id x-ms-client-name: leaseId in: header required: true type: string x-ms-parameter-location: method description: Specifies the current lease ID on the resource. ListFilesInclude: name: include in: query description: >- Include this parameter to specify one or more datasets to include in the response. required: false type: array collectionFormat: csv items: type: string enum: - Timestamps - Etag - Attributes - PermissionKey x-ms-enum: name: ListFilesIncludeType modelAsString: false x-ms-parameter-location: method ListFilesExtendedInfo: name: x-ms-file-extended-info x-ms-client-name: includeExtendedInfo x-ms-parameter-location: method in: header type: boolean required: false description: Include extended information. ListSharesInclude: name: include in: query description: >- Include this parameter to specify one or more datasets to include in the response. required: false type: array collectionFormat: csv items: type: string enum: - snapshots - metadata - deleted x-ms-enum: name: ListSharesIncludeType modelAsString: false x-ms-parameter-location: method Marker: name: marker in: query 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 type: string x-ms-parameter-location: method MaxResults: name: maxresults in: query 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 type: integer minimum: 1 x-ms-parameter-location: method Metadata: name: x-ms-meta x-ms-client-name: metadata in: header description: A name-value pair to associate with a file storage object. required: false type: string x-ms-parameter-location: method x-ms-header-collection-prefix: x-ms-meta- OptionalBody: name: optionalbody in: body description: Initial data. required: false schema: type: object format: file x-ms-parameter-location: method Prefix: name: prefix in: query description: >- Filters the results to return only entries whose name begins with the specified prefix. required: false type: string x-ms-parameter-location: method PrevShareSnapshot: name: prevsharesnapshot in: query description: >- The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. required: false type: string x-ms-parameter-location: method ProposedLeaseIdOptional: name: x-ms-proposed-lease-id x-ms-client-name: proposedLeaseId in: header required: false type: string x-ms-parameter-location: method 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. ProposedLeaseIdRequired: name: x-ms-proposed-lease-id x-ms-client-name: proposedLeaseId in: header required: true type: string x-ms-parameter-location: method 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. Range: name: x-ms-range x-ms-client-name: range in: header description: Return file data only from the specified byte range. required: false type: string x-ms-parameter-location: method Recursive: name: x-ms-recursive x-ms-client-name: recursive in: header description: >- Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. required: false type: boolean x-ms-parameter-location: method RenameIgnoreReadOnly: name: x-ms-file-rename-ignore-readonly x-ms-client-name: ignoreReadOnly in: header required: false type: boolean x-ms-parameter-location: method 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. RenameReplaceIfExists: name: x-ms-file-rename-replace-if-exists x-ms-client-name: replaceIfExists in: header required: false type: boolean x-ms-parameter-location: method 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. RenameSource: name: x-ms-file-rename-source x-ms-client-name: renameSource in: header required: true type: string x-ms-parameter-location: method description: >- Required. Specifies the URI-style path of the source file, up to 2 KB in length. Url: name: url x-ms-parameter-location: client in: path description: >- The URL of the service account, share, directory or file that is the target of the desired operation. required: true type: string x-ms-skip-url-encoding: true ShareAcl: name: shareAcl in: body description: The ACL for the share. schema: $ref: '#/definitions/SignedIdentifiers' x-ms-parameter-location: method ShareQuota: name: x-ms-share-quota x-ms-client-name: quota in: header description: Specifies the maximum size of the share, in gigabytes. required: false type: integer minimum: 1 x-ms-parameter-location: method ShareSnapshot: name: sharesnapshot in: query description: >- The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. required: false type: string x-ms-parameter-location: method SourceContentCrc64: name: x-ms-source-content-crc64 x-ms-client-name: sourceContentCrc64 in: header required: false type: string format: byte x-ms-parameter-location: method description: >- Specify the crc64 calculated for the range of bytes that must be read from the copy source. SourceIfMatchCrc64: name: x-ms-source-if-match-crc64 x-ms-client-name: sourceIfMatchCrc64 in: header required: false type: string format: byte x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: >- Specify the crc64 value to operate only on range with a matching crc64 checksum. SourceIfNoneMatchCrc64: name: x-ms-source-if-none-match-crc64 x-ms-client-name: sourceIfNoneMatchCrc64 in: header required: false type: string format: byte x-ms-parameter-location: method x-ms-parameter-grouping: name: source-modified-access-conditions description: >- Specify the crc64 value to operate only on range without a matching crc64 checksum. SourceLeaseId: name: x-ms-source-lease-id x-ms-client-name: sourceLeaseId in: header required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: name: source-lease-access-conditions description: Required if the source file has an active infinite lease. SourceRange: name: x-ms-source-range x-ms-client-name: sourceRange in: header required: false type: string x-ms-parameter-location: method description: Bytes of source data in the specified range. StorageServiceProperties: name: StorageServiceProperties in: body description: The StorageService properties. required: true schema: $ref: '#/definitions/StorageServiceProperties' x-ms-parameter-location: method TargetRange: name: x-ms-range x-ms-client-name: Range in: header required: true type: string x-ms-parameter-location: method description: Writes data to the specified byte range in the file. Timeout: name: timeout in: query description: >- The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. required: false type: integer minimum: 0 x-ms-parameter-location: method SharePermission: name: sharePermission in: body description: A permission (a security descriptor) at the share level. required: true schema: $ref: '#/definitions/SharePermission' x-ms-parameter-location: method ShareEnabledProtocols: name: x-ms-enabled-protocols description: Protocols to enable on the share. x-ms-client-name: enabledProtocols in: header required: false type: string x-ms-parameter-location: method ShareRootSquash: name: x-ms-root-squash description: Root squash to set on the share. Only valid for NFS shares. x-ms-client-name: rootSquash in: header required: false type: string enum: - NoRootSquash - RootSquash - AllSquash x-ms-enum: name: ShareRootSquash modelAsString: false x-ms-parameter-location: method AllowTrailingDot: name: x-ms-allow-trailing-dot description: If true, the trailing dot will not be trimmed from the target URI. x-ms-client-name: allowTrailingDot in: header required: false type: boolean SourceAllowTrailingDot: name: x-ms-source-allow-trailing-dot description: If true, the trailing dot will not be trimmed from the source URI. x-ms-client-name: allowSourceTrailingDot in: header required: false type: boolean