Azure.Storage.Common Provides the client configuration options for connecting to Azure Blob using clientside encryption. The version of clientside encryption to use. Required for upload operations. The key used to wrap the generated content encryption key. For more information, see https://docs.microsoft.com/en-us/azure/storage/common/storage-client-side-encryption. Required for download operations. Fetches the correct key encryption key to unwrap the downloaded content encryption key. For more information, see https://docs.microsoft.com/en-us/azure/storage/common/storage-client-side-encryption. Required for upload operations. The algorithm identifier to use when wrapping the content encryption key. This is passed into and its async counterpart. Initializes a new instance of the class. The version of clientside encryption to use. The version of clientside encryption to use. 1.0 is used to generate an account level Shared Access Signature (SAS) for Azure Storage services. For more information, see Create an account SAS. The storage service version to use to authenticate requests made with this shared access signature, and the service version to use when handling requests made with this shared access signature. The optional signed protocol field specifies the protocol permitted for a request made with the SAS. Possible values are , , and . Optionally specify the time at which the shared access signature becomes valid. If omitted when DateTimeOffset.MinValue is used, start time for this call is assumed to be the time when the storage service receives the request. The time at which the shared access signature becomes invalid. This field must be omitted if it has been specified in an associated stored access policy. The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. The type can be used to create the permissions string. Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. When specifying a range of IP addresses, note that the range is inclusive. The services associated with the shared access signature. The user is restricted to operations with the specified services. The resource types associated with the shared access signature. The user is restricted to operations on the specified resources. Initializes a new instance of the class. This constructor has been deprecated. Please consider using to create a Service SAS. This change does not have any impact on how your application generates or makes use of SAS tokens. Initializes a new instance of the class to create a Blob Container Service Sas. The time at which the shared access signature becomes invalid. This field must be omitted if it has been specified in an associated stored access policy. The time at which the shared access signature becomes invalid. This field must be omitted if it has been specified in an associated stored access policy. Specifies the services accessible from an account level shared access signature. Specifies the resource types accessible from an account level shared access signature. Sets the permissions for an account SAS. containing the allowed permissions. Sets the permissions for the SAS using a raw permissions string. Raw permissions string for the SAS. Use an account's to sign this shared access signature values to produce the proper SAS query parameters for authenticating requests. The storage account's . The used for authenticating requests. Returns a string that represents the current object. A string that represents the current object. Check if two instances are equal. The instance to compare to. True if they're equal, false otherwise. Get a hash code for the . Hash code for the . contains the list of permissions that can be set for a blob's access policy. Use to set the permissions on the . Indicates that Read is permitted. Indicates that Write is permitted. Indicates that Delete is permitted. Indicates that List is permitted. Indicates that Add is permitted. Indicates that Create is permitted. Indicates that Update is permitted. Indicates that Delete is permitted. Indicates that reading and writing Tags is permitted. Blob service only. Indicates that filtering by tag is permitted. Blob service only. Indicates that deleting a BlobVersion is permitted. Blob Service only. Indicates that all permissions are set. Specifies the resource types accessible from an account level shared access signature. Indicates whether service-level APIs are accessible from this shared access signature (e.g., Get/Set Service Properties, Get Service Stats, List Containers/Queues/Tables/ Shares). Indicates whether blob container-level APIs are accessible from this shared access signature (e.g., Create/Delete Container, Create/Delete Queue, Create/Delete Table, Create/Delete Share, List Blobs/Files and Directories). Indicates whether object-level APIs for blobs, queue messages, and files are accessible from this shared access signature (e.g. Put Blob, Query Entity, Get Messages, Create File, etc.). Indicates all service-level APIs are accessible from this shared access signature. Specifies the services accessible from an account level shared access signature. Indicates whether Azure Blob Storage resources are accessible from the shared access signature. Indicates whether Azure Queue Storage resources are accessible from the shared access signature. Indicates whether Azure File Storage resources are accessible from the shared access signature. Indicates whether Azure Table Storage resources are accessible from the shared access signature. Indicates all services are accessible from the shared access signature. Represents a range of allowed IP addresses for constructing a Shared Access Signature. Gets the start of the IP range. Not specified if equal to null or . Gets the optional end of the IP range. Not specified if equal to null or . Creates a new . The range's start . The range's optional end . Creates a string representation of an . A string representation of an . Parse an IP range string into a new . IP range string to parse. The parsed . Check if two instances are equal. The instance to compare to. True if they're equal, false otherwise. Get a hash code for the . Hash code for the . Check if two instances are equal. The first instance to compare. The second instance to compare. True if they're equal, false otherwise. Check if two instances are not equal. The first instance to compare. The second instance to compare. True if they're not equal, false otherwise. Check if two instances are equal. The instance to compare to. True if they're equal, false otherwise. Defines the protocols permitted for Storage requests made with a shared access signature. No protocol has been specified. If no value is specified, the service will default to HttpsAndHttp. Only requests issued over HTTPS or HTTP will be permitted. Only requests issued over HTTPS will be permitted. A object represents the components that make up an Azure Storage Shared Access Signature's query parameters. It includes components used by all Azure Storage resources (Blob Containers, Blobs, Files, and Queues). You can construct a new instance using the service specific SAS builder types. For more information, Create a service SAS. The default service version to use for Shared Access Signatures. Gets the storage service version to use to authenticate requests made with this shared access signature, and the service version to use when handling requests made with this shared access signature. Gets the signed services accessible with an account level shared access signature. Gets which resources are accessible via the shared access signature. Optional. Specifies the protocol permitted for a request made with the shared access signature. Gets the optional time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. means not set. Gets the time at which the shared access signature becomes invalid. means not set. Gets the optional IP address or a range of IP addresses from which to accept requests. When specifying a range, note that the range is inclusive. Gets the optional unique value up to 64 characters in length that correlates to an access policy specified for the blob container, queue, or share. Gets the resources are accessible via the shared access signature. Gets the permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. This field must be omitted if it has been specified in an associated stored access policy. Gets the Cache-Control response header, which allows for specifying the client-side caching to be used for blob and file downloads. Gets the Content-Disposition response header, which allows for specifying the way that the blob or file content can be displayed in the browser. Gets the Content-Encoding response header, which allows for specifying the type of encoding used for blob and file downloads. Gets the Content-Language response header, which allows for specifying the language of the downloaded blob or file content. Gets the Content-Type response header, which allows for specifying the type of the downloaded blob or file content. Gets the Authorized AAD Object Id associated with the shared access signature. The AAD Object ID of a user authorized by the owner of the User Delegation Key to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the user specified in this value will be performed. This cannot be used in conjuction with . Only valid in an HNS enabled account. If this value is set in an non-HNS enabled account, an authorization failure will be thrown. Gets the Unauthorized AAD Object Id associated with the shared access signature. The AAD Object Id of a user that is assumed to be unauthorized by the owner of the User Delegation Key. The Azure Storage Service will perform an additional POSIX ACL check to determine if the user is authorized to perform the requested operation. This cannot be used in conjuction with . Only valid in an HNS enabled account. If this value is set in an non-HNS enabled account, an authorization failure will be thrown. Gets the Correlation Id associated with the shared access signature. This is used to correlate the storage audit logs with the audit logs used by the principal generating and distributing SAS. Gets the Directory Depth specificed in the canonicalizedresource field of the string-to-sign. The depth of the directory is the number of directories beneath the root folder. Required when resource (sr) = d to indicate the depth of the directory. The value must be a non-negative integer. Gets the string-to-sign, a unique string constructed from the fields that must be verified in order to authenticate the request. The signature is an HMAC computed over the string-to-sign and key using the SHA256 algorithm, and then encoded using Base64 encoding. Gets empty shared access signature query parameters. Initializes a new instance of the class. Creates a new instance of the type based on the supplied query parameters . All SAS-related query parameters will be removed from . URI query parameters Creates a new SasQueryParameters instance. Creates a new SasQueryParameters instance. Creates a new instance of the type based on the supplied query parameters . All SAS-related query parameters will be removed from . URI query parameters Creates a new SasQueryParameters instance. Creates a new SasQueryParameters instance. Convert the SAS query parameters into a URL encoded query string. A URL encoded query string representing the SAS. Builds the query parameter string for the SasQueryParameters instance. StringBuilder instance to add the query params to Extension methods for Sas. Creates a string representing which resource types are allowed for . A string representing which resource types are allowed. The order here matches the order used by the portal when generating SAS signatures. Parse a string representing which resource types are accessible from a shared access signature. A string representing which resource types are accessible. An instance. The order here matches the order used by the portal when generating SAS signatures. Gets a string representation of the protocol. A string representation of the protocol. Parse a string representation of a protocol. A string representation of a protocol. A . Creates a string representing which services can be used for . A string representing which services are allowed. The order here matches the order used by the portal when generating SAS signatures. Parse a string representing which services are accessible from a shared access signature. A string representing which services are accessible. An instance. FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a SASField's StartTime or ExpiryTime fields. Returns "" if value.IsZero(). Helper method to add query param key value pairs to StringBuilder StringBuilder instance query key query value Helper to access protected static members of SasQueryParameters. Blob enum extensions. Create a permissions string to provide . A permissions string. A is a credential backed by a Storage Account's name and one of its access keys. Gets the name of the Storage Account. Initializes a new instance of the class. The name of the Storage Account. A Storage Account access key. Update the Storage Account's access key. This intended to be used when you've regenerated your Storage Account's access keys and want to update long lived clients. A Storage Account access key. Generates a base-64 hash signature string for an HTTP request or for a SAS. The message to sign. The signed message. Generates a base-64 hash signature string for an HTTP request or for a SAS. The credential. The message to sign. The signed message. is used to provide options for parallel transfers. The maximum length of an transfer in bytes. This property is a backwards-compatible facade for , which supports long values. Use for full access of supported values. The maximum length of an transfer in bytes. The maximum number of workers that may be used in a parallel transfer. The size of the first range request in bytes. Blobs smaller than this limit will be downloaded in a single request. Blobs larger than this limit will continue being downloaded in chunks of size . This property is a backwards-compatible facade for , which supports long values. Use for full access of supported values. The size of the first range request in bytes. Blobs smaller than this limit will be downloaded in a single request. Blobs larger than this limit will continue being downloaded in chunks of size . Check if two ParallelTransferOptions instances are equal. The instance to compare to. True if they're equal, false otherwise. Get a hash code for the ParallelTransferOptions. Hash code for the ParallelTransferOptions. Check if two ParallelTransferOptions instances are equal. The first instance to compare. The second instance to compare. True if they're equal, false otherwise. Check if two ParallelTransferOptions instances are equal. The first instance to compare. The second instance to compare. True if they're not equal, false otherwise. Check if two ParallelTransferOptions instances are equal. The instance to compare to. True if they're equal, false otherwise. The maximum allowed time between read or write calls to the stream for IdleCancellingStream. Gets the default service version to use when building shared access signatures. The default size of staged blocks when uploading small blobs. The size of staged blocks when uploading large blobs. The threshold where we switch from staging buffers to staging buffers. The minimum number of bytes to download in Open Read. Different .NET implementations have different default sizes for and it's overloads. This is the default for .NET Core to be applied everywhere for test consistency. The size of the buffer to use when copying streams during a download operation. The default format we use for block names. There are 50,000 maximum blocks so we pad the size with up to 4 leading zeros. Storage Connection String constant values. The default port numbers for development storage credentials Header Name constant values. Blob constant values. The Azure Storage name used to identify a storage account's root container. The Azure Storage name used to identify a storage account's logs container. The Azure Storage name used to identify a storage account's web content container. Lease Duration is set as infinite when passed -1. File constant values. Lease Duration is set as infinite when passed -1. Data Lake constant values. The blob URI suffix. The DFS URI suffix. The key of the object json object returned for errors. The key of the error code returned for errors. The key of the error message returned for errors. The Azure Storage error codes for Datalake Client. Default concurrent transfers count. Max upload bytes for less than Service Version 2019-12-12. Max upload bytes. Metadata key for isFolder property. Queue constant values. QueueMaxMessagesDequeue indicates the maximum number of messages you can retrieve with each call to Dequeue. QueueMessageMaxBytes indicates the maximum number of bytes allowed for a message's UTF-8 text. ChangeFeed constant values. Quick Query constant values. Sas constant values. List of ports used for path style addressing. Copied from Microsoft.Azure.Storage.Core.Util XML Element Name constant values. Create exceptions for common error cases. This policy is used if the SecondaryUri property is passed in on the clientOptions. It allows for storage accounts configured with RA-GRS to retry GET or HEAD requests against the secondary storage Uri. Gets the SAS token used to authenticate requests to the Storage service. Initializes a new instance of the class. The SAS token used to authenticate requests to the Storage service. Provide helpful information about errors calling Azure Storage endpoints. Attempt to get the error code from a response if it's not provided. The response. An optional error code. The response's error code. Check if a Response will throw an exception if you try to access its Value property. Type of the Response Value. The response to check. True if the response will throw. Create a response that will throw an exception if you try to access its Value property. Type of the Response Value. The raw response. A response that will throw if accessed. Gets or sets a value indicating whether the FISMA MD5 setting will be used. false to use the FISMA MD5 setting; true to use the .NET default implementation. Initializes a new instance of the class using the specified account credentials and service endpoints. A StorageCredentials object. A specifying the Blob service endpoint or endpoints. A specifying the Queue service endpoint or endpoints. A specifying the Table service endpoint or endpoints. A specifying the File service endpoint or endpoints. Gets a object that references the well-known development storage account. A object representing the development storage account. Indicates whether this account is a development storage account. The storage service hostname suffix set by the user, if any. The connection string parsed into settings. True if the user used a constructor that auto-generates endpoints. Gets the primary endpoint for the Blob service, as configured for the storage account. A containing the primary Blob service endpoint. Gets the primary endpoint for the Queue service, as configured for the storage account. A containing the primary Queue service endpoint. Gets the primary endpoint for the Table service, as configured for the storage account. A containing the primary Table service endpoint. Gets the primary endpoint for the File service, as configured for the storage account. A containing the primary File service endpoint. Gets the endpoints for the Blob service at the primary and secondary location, as configured for the storage account. A containing the Blob service endpoints. Gets the endpoints for the Queue service at the primary and secondary location, as configured for the storage account. A containing the Queue service endpoints. Gets the endpoints for the Table service at the primary and secondary location, as configured for the storage account. A containing the Table service endpoints. Gets the endpoints for the File service at the primary and secondary location, as configured for the storage account. A containing the File service endpoints. Gets the credentials used to create this object. A StorageCredentials object. Private record of the account name for use in ToString(bool). Parses a connection string and returns a created from the connection string. A valid connection string. Thrown if is null or empty. Thrown if is not a valid connection string. Thrown if cannot be parsed. A object constructed from the values provided in the connection string. Indicates whether a connection string can be parsed to return a object. The connection string to parse. A object to hold the instance returned if the connection string can be parsed. true if the connection string was successfully parsed; otherwise, false. Internal implementation of Parse/TryParse. The string to parse. The to return. A callback for reporting errors. If true, the parse was successful. Otherwise, false. Gets the default blob endpoint using the specified protocol and account name. The protocol to use. The name of the storage account. The Endpoint DNS suffix; use null for default. The sas token; use null for default. The default blob endpoint. Gets the default file endpoint using the specified protocol and account name. The protocol to use. The name of the storage account. The Endpoint DNS suffix; use null for default. The sas token; use null for default. The default file endpoint. Gets the default queue endpoint using the specified protocol and account name. The protocol to use. The name of the storage account. The Endpoint DNS suffix; use null for default. The sas token; use null for default. The default queue endpoint. Gets the default queue endpoint using the specified protocol and account name. The protocol to use. The name of the storage account. The Endpoint DNS suffix; use null for default. The sas token; use null for default. The default table endpoint. The secondary URI to be used for retries on failed read requests Overridden version of IsRetriableResponse that allows for Storage specific retry logic. The message containing both Response and Request This class is added to access protected static methods off of the base class that should not be exposed directly to customers. HttpPipelinePolicy to sign requests using an Azure Storage shared key. Create a new SharedKeyPipelinePolicy SharedKeyCredentials to authenticate requests. Sign the request using the shared key credentials. The message with the request to sign. Extension methods used to manipulate URIs. Append a segment to a URIs path. The URI. The relative segment to append. The combined URI. Get the (already encoded) query parameters on a URI. The URI. Dictionary mapping query parameters to values. Get the account name from the domain portion of a Uri. The Uri. The service subdomain used to validate that the domain is in the expected format. This should be "blob" for blobs, "file" for files, "queue" for queues, "blob" and "dfs" for datalake. Account name or null if not able to be parsed. Get the account name from the host. Host. The service subdomain used to validate that the domain is in the expected format. This should be "blob" for blobs, "file" for files, "queue" for queues, "blob" and "dfs" for datalake. Account name or null if not able to be parsed. If path starts with a slash, remove it The Uri. Sanitized Uri. Check to see if Uri is using IP Endpoint style. The Uri. True if using IP Endpoint style. Appends a query parameter to the string builder. string builder instance. query parameter key. query parameter value. Takes encoded query params string, output decoded params map Both and are defined as public structs so that foreach can use duck typing to call and avoid heap memory allocation. Please don't delete this method and don't make these types private. Returns an enumerator that iterates through the collection.An enumerator that can be used to iterate through the collection. Returns an enumerator that iterates through a collection.An object that can be used to iterate through the collection. Gets the element in the collection at the current position of the enumerator.The element in the collection at the current position of the enumerator.