Azure OSS for PHP API Reference

Application

Table of Contents

Interfaces

TokenCredential
Defines how an Azure credential obtains access tokens.

Classes

AccessToken
Represents an OAuth access token and its expiry information.
AggregateException
Collects multiple failures produced while trying a credential chain.
AuthenticationFailedException
Indicates that an available credential failed to authenticate.
AzureAuthorityHosts
Provides Microsoft Entra authority host names for Azure cloud environments.
ChainedTokenCredential
Tries token credentials in order until one can provide a token.
ClientCertificateCredential
Authenticates a Microsoft Entra service principal with a client certificate.
ClientCertificateCredentialOptions
Configures client certificate credential options.
ClientSecretCredential
Authenticates a Microsoft Entra service principal with a client secret.
ClientSecretCredentialOptions
Configures client secret credential options.
CredentialUnavailableException
Indicates that a credential cannot attempt authentication in the current environment.
DefaultAzureCredential
Tries a configurable chain of common Azure credentials.
DefaultAzureCredentialOptions
Configures which credential sources participate in {@see DefaultAzureCredential}.
EnvironmentCredential
Authenticates from service-principal values in the standard AZURE_* environment variables.
EnvironmentCredentialOptions
Configures environment credential options.
ManagedIdentityCredential
ManagedIdentityCredentialOptions
Configures token credential options.
TokenCredentialOptions
Configures token credential options.
TokenRequestContext
Describes the OAuth scopes requested from a token credential.
WorkloadIdentityCredential
Exchanges a federated workload identity token for a Microsoft Entra access token.
WorkloadIdentityCredentialOptions
Configures workload identity credential options.
BlobClient
Provides operations for an Azure Storage blob.
BlobContainerClient
Provides operations for an Azure Blob Storage container and the blobs within it.
BlobServiceClient
Provides service-level operations for an Azure Blob Storage account.
BlobStorageException
Represents an error response returned by Azure Blob Storage.
DeserializationException
Indicates that an Azure Blob Storage response could not be deserialized.
InvalidBlobUriException
Indicates that a URI does not identify the required blob or container resource.
InvalidConnectionStringException
Indicates that a connection string cannot create a Blob service client.
UnableToGenerateSasException
Indicates that a SAS cannot be signed because no shared-key credential is available.
DeprecationHelper
Provides reusable deprecation helper operations.
AbortCopyFromUriOptions
Configures abort copy from URI options.
AcquireBlobLeaseOptions
Configures acquire blob lease options.
Blob
Represents Azure Storage blob data.
BlobClientOptions
Configures blob client options.
BlobContainer
Represents Azure Storage blob container data.
BlobContainerClientOptions
Configures blob container client options.
BlobContainerProperties
Represents Azure Storage blob container properties data.
BlobCopyResult
Represents Azure Storage blob copy result data.
BlobDownloadStreamingResult
Represents Azure Storage blob download streaming result data.
BlobHttpHeaders
Represents Azure Storage blob http headers data.
BlobLease
Represents Azure Storage blob lease data.
BlobLeaseClientOptions
Configures blob lease client options.
BlobProperties
Represents Azure Storage blob properties data.
BlobRequestConditions
Represents Azure Storage blob request conditions data.
BlobServiceClientOptions
Configures blob service client options.
BlockBlobClientOptions
Configures block blob client options.
BreakBlobLeaseOptions
Configures break blob lease options.
ChangeBlobLeaseOptions
Configures change blob lease options.
CommitBlockListOptions
Configures commit block list options.
CreateContainerOptions
Configures create container options.
DeleteBlobOptions
Configures delete blob options.
DeleteContainerOptions
Configures delete container options.
DownloadBlobOptions
Configures download blob options.
GetBlobPropertiesOptions
Configures get blob properties options.
GetBlobsOptions
Configures get blobs options.
GetBlobTagsOptions
Configures get blob tags options.
GetContainerPropertiesOptions
Configures get container properties options.
ReleaseBlobLeaseOptions
Configures release blob lease options.
ReleasedObjectInfo
Represents Azure Storage released object info data.
RenewBlobLeaseOptions
Configures renew blob lease options.
SetBlobHttpHeadersOptions
Configures set blob http headers options.
SetBlobMetadataOptions
Configures set blob metadata options.
SetBlobTagsOptions
Configures set blob tags options.
SetContainerMetadataOptions
Configures set container metadata options.
StageBlockOptions
Configures stage block options.
StartCopyFromUriOptions
Configures start copy from URI options.
SyncCopyFromUriOptions
Configures sync copy from URI options.
TaggedBlob
Represents Azure Storage tagged blob data.
UploadBlobOptions
Configures upload blob options.
BlobContainerSasPermissions
Selects the operations granted by a container service SAS.
BlobSasBuilder
Builds an Azure Blob Storage service shared access signature (SAS).
BlobSasPermissions
Selects the operations granted by a blob service SAS.
BlobLeaseClient
Manages a lease on an Azure Storage blob or container.
BlockBlobClient
Provides staged upload operations for an Azure Storage block blob.
AzureBlobStorageAdapter
Exposes an Azure Blob Storage container as a Flysystem filesystem adapter.
StorageSharedKeyCredential
InvalidAccountKeyException
Indicates that a Storage account key is not valid base64-encoded key material.
HttpClientOptions
Configures http client options.
ETag
Represents an HTTP entity tag used by Azure Storage request conditions.
AccountSasBuilder
Builds an Azure Storage account shared access signature (SAS).
AccountSasPermissions
Selects the operations granted by an account SAS.
AccountSasResourceTypes
Selects the service, container, and object resource types granted by an account SAS.
AccountSasServices
Selects the Azure Storage services accessible through an account SAS.
SasIpRange
Restricts a SAS to a source IPv4 address or inclusive address range.
DeserializationException
Indicates that an Azure Queue Storage response could not be deserialized.
InvalidConnectionStringException
Indicates that a connection string cannot create a Queue service client.
QueueStorageException
Represents an error response returned by Azure Queue Storage.
QueueClientOptions
Configures queue client options.
QueueMessage
Represents Azure Storage queue message data.
QueueProperties
Represents Azure Storage queue properties data.
QueueServiceClientOptions
Configures queue service client options.
SendReceipt
Represents Azure Storage send receipt data.
UpdateReceipt
Represents Azure Storage update receipt data.
QueueClient
Provides operations for an Azure Storage queue and its messages.
QueueServiceClient
Provides service-level access to queues in an Azure Storage account.

Enums

BlobErrorCode
Defines the supported blob error code values.
CopyStatus
Defines the supported copy status values.
PublicAccessType
Defines the supported public access type values.
ApiVersion
Defines the supported API version values.
SasProtocol
Defines the supported SAS protocol values.
QueueErrorCode
Defines the supported queue error code values.
On this page

Search results