# Functions
FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a SASField's StartTime or ExpiryTime fields.
NewAnonymousCredential creates an anonymous credential for use with HTTP(S) requests that read public resource or for use with Shared Access Signatures (SAS).
NewMessageIDURL creates a MessageIDURL object using the specified URL and request policy pipeline.
NewMessageURL creates a MessagesURL object using the specified URL and request policy pipeline.
NewPipeline creates a Pipeline using the specified credentials and options.
NewQueueURL creates a QueueURL object using the specified URL and request policy pipeline.
NewQueueURLParts parses a URL initializing QueueURLParts' fields including any SAS-related query parameters.
NewRequestLogPolicyFactory creates a RequestLogPolicyFactory object configured using the specified options.
NewResponseError creates an error object that implements the error interface.
NewRetryPolicyFactory creates a RetryPolicyFactory object configured using the specified options.
NewServiceURL creates a ServiceURL object using the specified URL and request policy pipeline.
NewSharedKeyCredential creates an immutable SharedKeyCredential containing the storage account's name and either its primary or secondary key.
NewTelemetryPolicyFactory creates a factory that can create telemetry policy objects which add telemetry information to outgoing HTTP requests.
NewTokenCredential creates a token credential for use with role-based access control (RBAC) access to Azure Storage resources.
NewUniqueRequestIDPolicyFactory creates a UniqueRequestIDPolicyFactory object that sets the request's x-ms-client-request-id header if it doesn't already exist.
PossibleGeoReplicationStatusTypeValues returns an array of possible values for the GeoReplicationStatusType const type.
PossibleListQueuesIncludeTypeValues returns an array of possible values for the ListQueuesIncludeType const type.
PossibleStorageErrorCodeTypeValues returns an array of possible values for the StorageErrorCodeType const type.
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
# Constants
GeoReplicationStatusBootstrap ...
GeoReplicationStatusLive ...
GeoReplicationStatusNone represents an empty GeoReplicationStatusType.
GeoReplicationStatusUnavailable ...
ListQueuesIncludeMetadata ...
ListQueuesIncludeNone represents an empty ListQueuesIncludeType.
QueueMaxMessagesDequeue indicates the maximum number of messages you can retrieve with each call to Dequeue (32).
QueueMaxMessagesPeek indicates the maximum number of messages you can retrieve with each call to Peek (32).
64KB.
RetryPolicyExponential tells the pipeline to use an exponential back-off retry policy.
RetryPolicyFixed tells the pipeline to use a fixed back-off retry policy.
SASProtocolHTTPS can be specified for a SAS protocol.
SASProtocolHTTPSandHTTP can be specified for a SAS protocol.
"2017-07-27T00:00:00Z" // ISO 8601.
SASVersion indicates the SAS version.
ServiceCodeAccountAlreadyExists means the specified account already exists.
ServiceCodeAccountBeingCreated means the specified account is in the process of being created (403).
ServiceCodeAccountIsDisabled means the specified account is disabled (403).
ServiceCodeAuthenticationFailed means the server failed to authenticate the request.
ServiceCodeConditionHeadersNotSupported means the condition headers are not supported (400).
ServiceCodeConditionNotMet means the condition specified in the conditional header(s) was not met for a read/write operation (304/412).
ServiceCodeEmptyMetadataKey means the key for one of the metadata key-value pairs is empty (400).
ServiceCodeInsufficientAccountPermissions means read operations are currently disabled or Write operations are not allowed or The account being accessed does not have sufficient permissions to execute this operation (403).
ServiceCodeInternalError means the server encountered an internal error.
ServiceCodeInvalidAuthenticationInfo means the authentication information was not provided in the correct format.
ServiceCodeInvalidHeaderValue means the value provided for one of the HTTP headers was not in the correct format (400).
ServiceCodeInvalidHTTPVerb means the HTTP verb specified was not recognized by the server (400).
ServiceCodeInvalidInput means one of the request inputs is not valid (400).
The specified marker is invalid (400).
ServiceCodeInvalidMd5 means the MD5 value specified in the request is invalid.
ServiceCodeInvalidMetadata means the specified metadata is invalid.
ServiceCodeInvalidQueryParameterValue means an invalid value was specified for one of the query parameters in the request URI (400).
ServiceCodeInvalidRange means the range specified is invalid for the current size of the resource (416).
ServiceCodeInvalidResourceName means the specified resource name contains invalid characters (400).
ServiceCodeInvalidURI means the requested URI does not represent any resource on the server (400).
ServiceCodeInvalidXMLDocument means the specified XML is not syntactically valid (400).
ServiceCodeInvalidXMLNodeValue means the value provided for one of the XML nodes in the request body was not in the correct format (400).
ServiceCodeMd5Mismatch means the MD5 value specified in the request did not match the MD5 value calculated by the server (400).
The specified message does not exist (404).
The message exceeds the maximum allowed size (400).
ServiceCodeMetadataTooLarge means the size of the specified metadata exceeds the maximum size permitted (400).
ServiceCodeMissingContentLengthHeader means the Content-Length header was not specified (411).
ServiceCodeMissingRequiredHeader means a required HTTP header was not specified (400).
ServiceCodeMissingRequiredQueryParameter means a required query parameter was not specified for this request (400).
ServiceCodeMissingRequiredXMLNode means a required XML node was not specified in the request body (400).
ServiceCodeMultipleConditionHeadersNotSupported means multiple condition headers are not supported (400).
ServiceCodeNone is the default value.
ServiceCodeOperationTimedOut means the operation could not be completed within the permitted time (500).
ServiceCodeOutOfRangeInput means one of the request inputs is out of range (400).
ServiceCodeOutOfRangeQueryParameterValue means a query parameter specified in the request URI is outside the permissible range (400).
The specified pop receipt did not match the pop receipt for a dequeued message (400).
The specified queue already exists (409).
The specified queue is being deleted (409).
The specified queue has been disabled by the administrator (409).
The specified queue is not empty (409).
The specified queue does not exist (404).
ServiceCodeRequestBodyTooLarge means the size of the request body exceeds the maximum size permitted (413).
ServiceCodeRequestURLFailedToParse means the url in the request could not be parsed (400).
ServiceCodeResourceAlreadyExists means the specified resource already exists (409).
ServiceCodeResourceNotFound means the specified resource does not exist (404).
ServiceCodeResourceTypeMismatch means the specified resource type does not match the type of the existing resource (409).
ServiceCodeServerBusy means the server is currently unable to receive requests.
ServiceCodeUnsupportedHeader means one of the HTTP headers specified in the request is not supported (400).
ServiceCodeUnsupportedHTTPVerb means the resource doesn't support the specified HTTP verb (405).
ServiceCodeUnsupportedQueryParameter means one of the query parameters specified in the request URI is not supported (400).
ServiceCodeUnsupportedXMLNode means one of the XML nodes specified in the request body is not supported (400).
ServiceVersion specifies the version of the operations used in this package.
StorageErrorCodeAccountAlreadyExists ...
StorageErrorCodeAccountBeingCreated ...
StorageErrorCodeAccountIsDisabled ...
StorageErrorCodeAuthenticationFailed ...
StorageErrorCodeConditionHeadersNotSupported ...
StorageErrorCodeConditionNotMet ...
StorageErrorCodeEmptyMetadataKey ...
StorageErrorCodeInsufficientAccountPermissions ...
StorageErrorCodeInternalError ...
StorageErrorCodeInvalidAuthenticationInfo ...
StorageErrorCodeInvalidHeaderValue ...
StorageErrorCodeInvalidHTTPVerb ...
StorageErrorCodeInvalidInput ...
StorageErrorCodeInvalidMarker ...
StorageErrorCodeInvalidMd5 ...
StorageErrorCodeInvalidMetadata ...
StorageErrorCodeInvalidQueryParameterValue ...
StorageErrorCodeInvalidRange ...
StorageErrorCodeInvalidResourceName ...
StorageErrorCodeInvalidURI ...
StorageErrorCodeInvalidXMLDocument ...
StorageErrorCodeInvalidXMLNodeValue ...
StorageErrorCodeMd5Mismatch ...
StorageErrorCodeMessageNotFound ...
StorageErrorCodeMessageTooLarge ...
StorageErrorCodeMetadataTooLarge ...
StorageErrorCodeMissingContentLengthHeader ...
StorageErrorCodeMissingRequiredHeader ...
StorageErrorCodeMissingRequiredQueryParameter ...
StorageErrorCodeMissingRequiredXMLNode ...
StorageErrorCodeMultipleConditionHeadersNotSupported ...
StorageErrorCodeNone represents an empty StorageErrorCodeType.
StorageErrorCodeOperationTimedOut ...
StorageErrorCodeOutOfRangeInput ...
StorageErrorCodeOutOfRangeQueryParameterValue ...
StorageErrorCodePopReceiptMismatch ...
StorageErrorCodeQueueAlreadyExists ...
StorageErrorCodeQueueBeingDeleted ...
StorageErrorCodeQueueDisabled ...
StorageErrorCodeQueueNotEmpty ...
StorageErrorCodeQueueNotFound ...
StorageErrorCodeRequestBodyTooLarge ...
StorageErrorCodeRequestURLFailedToParse ...
StorageErrorCodeResourceAlreadyExists ...
StorageErrorCodeResourceNotFound ...
StorageErrorCodeResourceTypeMismatch ...
StorageErrorCodeServerBusy ...
StorageErrorCodeUnsupportedHeader ...
StorageErrorCodeUnsupportedHTTPVerb ...
StorageErrorCodeUnsupportedQueryParameter ...
StorageErrorCodeUnsupportedXMLNode ...
# Structs
AccessPolicy - An Access policy.
The AccessPolicyPermission type simplifies creating the permissions string for a queue's access policy.
The AccountSASPermissions type simplifies creating the permissions string for an Azure Storage Account SAS.
The AccountSASResourceTypes type simplifies creating the resource types string for an Azure Storage Account SAS.
The AccountSASServices type simplifies creating the services string for an Azure Storage Account SAS.
AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account.
CorsRule - CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain.
DequeuedMessage holds the properties of a single dequeued message.
DequeuedMessageItem - The object returned in the QueueMessageList array when calling Get Messages on a Queue.
DequeueMessagesResponse holds the results of a successful call to Dequeue.
EnqueuedMessage - The object returned in the QueueMessageList array when calling Put Message on a Queue.
EnqueueMessageResponse holds the results of a successfully-enqueued message.
EnqueueResponse - Wraps the response from the messagesClient.Enqueue method.
GeoReplication ...
IPRange represents a SAS IP range's start IP and (optionally) end IP.
ListQueuesSegmentDetails indicates what additional information the service should return with each queue.
ListQueuesSegmentOptions defines options available when calling ListQueuesSegment.
ListQueuesSegmentResponse - The object returned when calling List Queues on a Queue Service.
Logging - Azure Analytics Logging settings.
Marker represents an opaque value used in paged responses.
MessageIDDeleteResponse ...
MessageIDUpdateResponse ...
A MessageIDURL represents a URL to a specific Azure Storage Queue message allowing you to manipulate the message.
MessagesClearResponse ...
A MessagesURL represents a URL to an Azure Storage Queue's messages allowing you to manipulate its messages.
Metrics ...
PeekedMessage holds the properties of a peeked message.
PeekedMessageItem - The object returned in the QueueMessageList array when calling Peek Messages on a Queue.
PeekedMessagesResponse holds the results of a successful call to Peek.
PeekResponse - Wraps the response from the messagesClient.Peek method.
PipelineOptions is used to configure a request policy pipeline's retry policy and logging.
QueueCreateResponse ...
QueueDeleteResponse ...
QueueGetPropertiesResponse ...
QueueItem - An Azure Storage Queue.
QueueMessage - A Message object which can be stored in a Queue.
QueueMessagesList - Wraps the response from the messagesClient.Dequeue method.
The QueueSASPermissions type simplifies creating the permissions string for an Azure Storage queue SAS.
QueueSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage queue.
QueueSetAccessPolicyResponse ...
QueueSetMetadataResponse ...
A QueueURL represents a URL to the Azure Storage queue.
A QueueURLParts object represents the components that make up an Azure Storage Queue URL.
RequestLogOptions configures the retry policy's behavior.
RetentionPolicy - the retention policy.
RetryOptions configures the retry policy's behavior.
A SASQueryParameters object represents the components that make up an Azure Storage SAS' query parameters.
ServiceSetPropertiesResponse ...
A ServiceURL represents a URL to the Azure Storage Queue service allowing you to manipulate queues.
SharedKeyCredential contains an account's name and its primary or secondary key.
SignedIdentifier - signed identifier.
SignedIdentifiers - Wraps the response from the queueClient.GetAccessPolicy method.
StorageServiceProperties - Storage Service Properties.
StorageServiceStats - Stats for the storage service.
TelemetryOptions configures the telemetry policy's behavior.
No description provided by the author
# Interfaces
Credential represent any credential type; it is used to create a credential policy Factory.
ResponseError identifies a responder-generated network or response parsing error.
StorageError identifies a responder-generated network or response parsing error.
TokenCredential represents a token credential (which is also a pipeline.Factory).
# Type aliases
GeoReplicationStatusType enumerates the values for geo replication status type.
ListQueuesIncludeType enumerates the values for list queues include type.
MessageID represents a Message ID as a string.
Metadata contains metadata key/value pairs.
PopReceipt represents a Message's opaque pop receipt.
RetryPolicy tells the pipeline what kind of retry policy to use.
No description provided by the author
ServiceCodeType is a string identifying a storage service error.
StorageErrorCodeType enumerates the values for storage error code type.
TokenRefresher represents a callback method that you write; this method is called periodically so you can refresh the token credential's value.