New-AzStorageContext

Module:

Az.Storage Module

Creates an Azure Storage context.

New-AzStorageContext
 [-StorageAccountName] <String>
 [-UseConnectedAccount]
 [-Protocol <String>]
 [-Endpoint <String>]
 [-EnableFileBackupRequestIntent]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 [-StorageAccountKey] <String>
 [-Protocol <String>]
 [-Endpoint <String>]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 [-StorageAccountKey] <String>
 -Environment <String>
 [-Protocol <String>]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 [-Anonymous]
 [-Protocol <String>]
 [-Endpoint <String>]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 -Environment <String>
 [-Anonymous]
 [-Protocol <String>]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 -SasToken <String>
 [-Protocol <String>]
 [-Endpoint <String>]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 -SasToken <String>
 -Environment <String>
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 -Environment <String>
 [-UseConnectedAccount]
 [-Protocol <String>]
 [-EnableFileBackupRequestIntent]
 [<CommonParameters>]

New-AzStorageContext
 [-StorageAccountName] <String>
 [-StorageAccountKey] <String>
 -BlobEndpoint <String>
 [-FileEndpoint <String>]
 [-QueueEndpoint <String>]
 [-TableEndpoint <String>]
 [<CommonParameters>]

New-AzStorageContext
 [[-StorageAccountName] <String>]
 [-UseConnectedAccount]
 [-BlobEndpoint <String>]
 [-FileEndpoint <String>]
 [-QueueEndpoint <String>]
 [-TableEndpoint <String>]
 [-EnableFileBackupRequestIntent]
 [<CommonParameters>]

New-AzStorageContext
 -SasToken <String>
 [-BlobEndpoint <String>]
 [-FileEndpoint <String>]
 [-QueueEndpoint <String>]
 [-TableEndpoint <String>]
 [<CommonParameters>]

New-AzStorageContext
 -ConnectionString <String>
 [<CommonParameters>]

New-AzStorageContext
 [-Local]
 [<CommonParameters>]

New-AzStorageContext
 [-Anonymous]
 [-BlobEndpoint <String>]
 [-FileEndpoint <String>]
 [-QueueEndpoint <String>]
 [-TableEndpoint <String>]
 [<CommonParameters>]

The New-AzStorageContext cmdlet creates an Azure Storage context. The default Authentication of a Storage Context is OAuth (Microsoft Entra ID), if only input Storage account name. See details of authentication of the Storage Service in https://learn.microsoft.com/rest/api/storageservices/authorization-for-the-azure-storage-services.

New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >"

This command creates a context for the account named ContosoGeneral that uses the specified key.

New-AzStorageContext -ConnectionString "DefaultEndpointsProtocol=https;AccountName=ContosoGeneral;AccountKey=< Storage Key for ContosoGeneral ends with == >;"

This command creates a context based on the specified connection string for the account ContosoGeneral.

New-AzStorageContext -StorageAccountName "ContosoGeneral" -Anonymous -Protocol "http"

This command creates a context for anonymous use for the account named ContosoGeneral. The command specifies HTTP as a connection protocol.

New-AzStorageContext -Local

This command creates a context by using the local development storage account. The command specifies the Local parameter.

New-AzStorageContext -Local | Get-AzStorageContainer

This command creates a context by using the local development storage account, and then passes the new context to the Get-AzStorageContainer cmdlet by using the pipeline operator. The command gets the Azure Storage container for the local developer storage account.

$Context01 = New-AzStorageContext -Local
$Context02 = New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >"
($Context01, $Context02) | Get-AzStorageContainer

The first command creates a context by using the local development storage account, and then stores that context in the $Context01 variable. The second command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that context in the $Context02 variable. The final command gets the containers for the contexts stored in $Context01 and $Context02 by using Get-AzStorageContainer.

New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Endpoint "contosoaccount.core.windows.net"

This command creates an Azure Storage context that has the specified storage endpoint. The command creates the context for the account named ContosoGeneral that uses the specified key.

New-AzStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Environment "AzureChinaCloud"

This command creates an Azure storage context that has the specified Azure environment. The command creates the context for the account named ContosoGeneral that uses the specified key.

$SasToken = New-AzStorageContainerSASToken -Name "ContosoMain" -Permission "rad"
$Context = New-AzStorageContext -StorageAccountName "ContosoGeneral" -SasToken $SasToken
$Context | Get-AzStorageBlob -Container "ContosoMain"

The first command generates an SAS token by using the New-AzStorageContainerSASToken cmdlet for the container named ContosoMain, and then stores that token in the $SasToken variable. That token is for read, add, update, and delete permissions. The second command creates a context for the account named ContosoGeneral that uses the SAS token stored in $SasToken, and then stores that context in the $Context variable. The final command lists all the blobs associated with the container named ContosoMain by using the context stored in $Context.

Connect-AzAccount
$Context = New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount

This command creates a context by using the OAuth (Microsoft Entra ID) Authentication.

New-AzStorageContext -StorageAccountName "myaccountname" -StorageAccountKey "< Storage Key for myaccountname ends with == >" -BlobEndpoint "https://myaccountname.blob.core.windows.net/"

This command creates a context for the account named myaccountname with a key for the account, and specified blob endpoint.

New-AzStorageContext -Anonymous -BlobEndpoint "https://myaccountname.blob.core.windows.net/"

This command creates a context for anonymous use for the account named myaccountname, with specified blob endpoint.

$SasToken = New-AzStorageContainerSASToken -Name "MyContainer" -Permission "rad"
New-AzStorageContext -SasToken $SasToken -BlobEndpoint "https://myaccountname.blob.core.windows.net/" -TableEndpoint "https://myaccountname.table.core.windows.net/" -FileEndpoint "https://myaccountname.file.core.windows.net/" -QueueEndpoint "https://myaccountname.queue.core.windows.net/"

The first command generates an SAS token by using the New-AzStorageContainerSASToken cmdlet for the container named MyContainer, and then stores that token in the $SasToken variable. The second command creates a context that uses the SAS token and a specified blob endpoint, table endpoint, file endpoint, and queue endpoint.

New-AzStorageContext -UseConnectedAccount -BlobEndpoint "https://myaccountname.blob.core.windows.net/"

This command creates a context by using the OAuth authentication with a specified blob endpoint.

New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount -EnableFileBackupRequestIntent

This command creates a context to use the OAuth (Microsoft Entra ID) authentication on File service. Parameter '-EnableFileBackupRequestIntent' is required to use OAuth (Microsoft Entra ID) Authentication for File service. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.