Share via


StorageCloudBlobCmdletBase Class

Definition

Base cmdlet for storage blob/container cmdlet

public class StorageCloudBlobCmdletBase : Microsoft.WindowsAzure.Commands.Storage.Common.StorageCloudCmdletBase<Microsoft.WindowsAzure.Commands.Storage.Model.Contract.IStorageBlobManagement>
type StorageCloudBlobCmdletBase = class
    inherit StorageCloudCmdletBase<IStorageBlobManagement>
Public Class StorageCloudBlobCmdletBase
Inherits StorageCloudCmdletBase(Of IStorageBlobManagement)
Inheritance
Derived

Constructors

StorageCloudBlobCmdletBase()

Initializes a new instance of the StorageCloudBlobCmdletBase class.

StorageCloudBlobCmdletBase(IStorageBlobManagement)

Initializes a new instance of the StorageCloudBlobCmdletBase class.

Fields

_adalListener (Inherited from AzurePSCmdlet)
_cancellationTokenSource

Cancellation Token Source

(Inherited from StorageCloudCmdletBase<T>)
_clientRequestId (Inherited from AzurePSCmdlet)
_enableMultiThread (Inherited from StorageCloudCmdletBase<T>)
_fileTimeStampSuffixFormat (Inherited from AzurePSCmdlet)
_metricHelper (Inherited from AzurePSCmdlet)
_qosEvent (Inherited from AzurePSCmdlet)
CmdletCancellationToken (Inherited from StorageCloudCmdletBase<T>)
concurrentTaskCount (Inherited from StorageCloudCmdletBase<T>)
summaryRecord

Summary progress record on multithread task

(Inherited from StorageCloudCmdletBase<T>)
validBlobProperties_Track2
validCloudBlobProperties
validDatalakeGen2FileProperties
validDatalakeGen2FolderProperties
WaitTimeout (Inherited from StorageCloudCmdletBase<T>)

Properties

_dataCollectionProfile (Inherited from AzurePSCmdlet)
_matchers (Inherited from AzurePSCmdlet)
AppendBlobRequestConditions
AsJobDynamicParameters (Inherited from AzurePSCmdlet)
BlobRequestConditions
Channel (Inherited from StorageCloudCmdletBase<T>)
ClientOptions
ClientTimeoutPerRequest (Inherited from StorageCloudCmdletBase<T>)
ConcurrentTaskCount

Amount of concurrent async tasks to run per available core.

(Inherited from StorageCloudCmdletBase<T>)
Context (Inherited from StorageCloudCmdletBase<T>)
DataCollectionWarning (Inherited from AzureDataCmdlet)
DataLakeClientOptions
DebugMessages (Inherited from AzurePSCmdlet)
DefaultContext (Inherited from AzureDataCmdlet)
DefaultProfile

Gets or sets the global profile for ARM cmdlets.

(Inherited from StorageCloudCmdletBase<T>)
EnableMultiThread

Enable or disable multithread If the storage cmdlet want to disable the multithread feature, it can disable when construct and beginProcessing

(Inherited from StorageCloudCmdletBase<T>)
ImplementationBackgroundJobDescription (Inherited from AzurePSCmdlet)
IsErrorMetricEnabled (Inherited from AzurePSCmdlet)
IsUsageMetricEnabled (Inherited from AzurePSCmdlet)
ModuleName (Inherited from AzurePSCmdlet)
ModuleVersion (Inherited from AzurePSCmdlet)
OperationContext

Cmdlet operation context.

(Inherited from StorageCloudCmdletBase<T>)
PageBlobRequestConditions
PSVersion
Obsolete.
(Inherited from AzurePSCmdlet)
RequestOptions

Blob request options

RMProfile (Inherited from AzureDataCmdlet)
ServerTimeoutPerRequest (Inherited from StorageCloudCmdletBase<T>)
SessionState (Inherited from AzurePSCmdlet)
ShareChannel

Gets or sets a flag indicating whether CreateChannel should share the command's current Channel when asking for a new one. This is only used for testing.

(Inherited from StorageCloudCmdletBase<T>)
ShouldForceQuit

whether stop processing

(Inherited from StorageCloudCmdletBase<T>)
SMProfile (Inherited from AzureDataCmdlet)
TableOperationContext

Cmdlet operation context.

(Inherited from StorageCloudCmdletBase<T>)
TagCondition

Methods

AddDebuggingFilter(Regex) (Inherited from AzurePSCmdlet)
BeginProcessing()

Cmdlet begin process

(Inherited from StorageCloudCmdletBase<T>)
CheckIfInteractive() (Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action, Func<Boolean>) (Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action) (Inherited from AzureDataCmdlet)
ConfirmAction(String, String, Action) (Inherited from AzurePSCmdlet)
ConstructPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
ContainerIsEmpty(CloudBlobContainer)
ContainerIsEmpty(CloudBlobContainer)
CreateBlobHttpHeaders(Hashtable)

CreateBlobPropertiesObject, which will be set to server

CreateChannel()

Create blob client and storage service management channel if need to.

CreateChannel(AzureStorageContext)
CreateChannel(AzureStorageContext)

Get a service channel object using specified storage account

CurrentPath() (Inherited from AzurePSCmdlet)
Dispose() (Inherited from AzurePSCmdlet)
Dispose(Boolean) (Inherited from AzurePSCmdlet)
DoInitChannelCurrentSubscription(Boolean) (Inherited from StorageCloudCmdletBase<T>)
EndProcessing()

End processing

(Inherited from StorageCloudCmdletBase<T>)
ExecuteCmdlet() (Inherited from AzurePSCmdlet)
FlushInitializationWarnings() (Inherited from AzurePSCmdlet)
GetBlobReferenceFromServerWithContainer(IStorageBlobManagement, CloudBlobContainer, String, AccessCondition, BlobRequestOptions, OperationContext, Nullable<DateTimeOffset>)
GetBlobReferenceFromServerWithContainer(IStorageBlobManagement, CloudBlobContainer, String, AccessCondition, BlobRequestOptions, OperationContext, Nullable<DateTimeOffset>)
GetBlobReferenceWrapper(Func<CloudBlob>, String, String)
GetBlobReferenceWrapper(Func<CloudBlob>, String, String)
GetBlobSnapshotReferenceFromServerWithContainer(IStorageBlobManagement, CloudBlobContainer, String, DateTime, AccessCondition, BlobRequestOptions, OperationContext)
GetBlobSnapshotReferenceFromServerWithContainer(IStorageBlobManagement, CloudBlobContainer, String, DateTime, AccessCondition, BlobRequestOptions, OperationContext)
GetCmdletConcurrency()

Get the concurrency value

(Inherited from StorageCloudCmdletBase<T>)
GetDataLakeItemUriWithoutSas(DataLakePathClient)

Get Item string without SAS for confirmation string.

GetExceptionErrorCategory(Exception)

Get the error category for specified exception

(Inherited from StorageCloudCmdletBase<T>)
GetExistDataLakeGen2Item(DataLakeFileSystemClient, String, DataLakeFileClient, DataLakeDirectoryClient)

Get an Exist DataLakeGen2Item, return true is the item is a folder, return false if it's File

GetRequestOptions(StorageServiceType)

Get a request options

(Inherited from StorageCloudCmdletBase<T>)
GetTableRequestOptions()

Get a request options

(Inherited from StorageCloudCmdletBase<T>)
GetTrack2AppendBlobClient(CloudBlob, AzureStorageContext, BlobClientOptions)
GetTrack2BlobClient(CloudBlob, AzureStorageContext, BlobClientOptions)
GetTrack2PageBlobClient(CloudBlob, AzureStorageContext, BlobClientOptions)
GetUpdatedMetaData(Hashtable, IDictionary<String,String>)
InitChannelCurrentSubscription() (Inherited from StorageCloudCmdletBase<T>)
InitChannelCurrentSubscription(Boolean)

Init channel with or without subscription in storage cmdlet

(Inherited from StorageCloudCmdletBase<T>)
InitDebuggingFilter() (Inherited from AzurePSCmdlet)
InitializeQosEvent() (Inherited from AzureDataCmdlet)
IsDataCollectionAllowed() (Inherited from AzurePSCmdlet)
isDirectory(PathProperties)

decide if a object represent a folder of datalake gen2

IsTerminatingError(Exception) (Inherited from AzurePSCmdlet)
IsVerbose() (Inherited from AzurePSCmdlet)
LoadModuleVersion(String, Boolean) (Inherited from AzurePSCmdlet)
LogCmdletEndInvocationInfo() (Inherited from AzurePSCmdlet)
LogCmdletStartInvocationInfo() (Inherited from AzurePSCmdlet)
LogQosEvent() (Inherited from AzurePSCmdlet)
ProcessRecord() (Inherited from StorageCloudCmdletBase<T>)
RegisterDynamicParameters(RuntimeDefinedParameterDictionary) (Inherited from AzurePSCmdlet)
ResolveUserPath(String) (Inherited from AzurePSCmdlet)
ResolveUserPath(String[]) (Inherited from AzurePSCmdlet)
SafeWriteOutputPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
SetBackgroundJobDescription(String) (Inherited from AzurePSCmdlet)
SetBlobMeta_Track2(IDictionary<String,String>, Hashtable)
SetBlobMeta(CloudBlob, Hashtable)

set blob metadata to a blob object

SetBlobProperties(CloudBlob, Hashtable)

set blob properties to a blob object

SetClientOptionsWithEncryptionScope(String)
SetDatalakegen2ItemMetaData(DataLakePathClient, Hashtable, Boolean)

Set Metadata to a datalake gen2 item

SetDatalakegen2ItemProperties(DataLakePathClient, Hashtable, Boolean)

Set properties to a datalake gen2 Datalakegen2Item

SetupDebuggingTraces() (Inherited from AzurePSCmdlet)
SetupHttpClientPipeline() (Inherited from AzurePSCmdlet)
StopProcessing()

stop processing time-consuming operation should work with ShouldForceQuit

(Inherited from StorageCloudCmdletBase<T>)
TearDownDebuggingTraces() (Inherited from AzurePSCmdlet)
TearDownHttpClientPipeline() (Inherited from AzurePSCmdlet)
ThrowIfPremium(String)
ThrowTerminatingError(ErrorRecord) (Inherited from AzurePSCmdlet)
UseTrack2Sdk()
ValidateBlobProperties(Hashtable)

check whether the blob properties is valid

ValidateBlobTier(BlobType, Nullable<PremiumPageBlobTier>, Nullable<Boolean>, Nullable<RehydratePriority>)
ValidateBlobTier(BlobType, Nullable<PremiumPageBlobTier>)
ValidateBlobType(CloudBlob)
ValidateBlobType(CloudBlob)
WriteCommandDetail(String) (Inherited from AzurePSCmdlet)
WriteDebug(String) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteError(ErrorRecord) (Inherited from AzurePSCmdlet)
WriteErrorWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteExceptionError(Exception)

Write error with category and identifier

(Inherited from StorageCloudCmdletBase<T>)
WriteInformation(Object, String[]) (Inherited from AzurePSCmdlet)
WriteInformation(String, Nullable<Boolean>) (Inherited from AzurePSCmdlet)
WriteInformationWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteInitializationWarnings(String) (Inherited from AzurePSCmdlet)
WriteObject(Object, Boolean) (Inherited from AzurePSCmdlet)
WriteObject(Object) (Inherited from AzurePSCmdlet)
WriteProgress(ProgressRecord) (Inherited from AzurePSCmdlet)
WriteSurvey() (Inherited from AzurePSCmdlet)
WriteTaskSummary() (Inherited from StorageCloudCmdletBase<T>)
WriteTerminatingError(Exception)

write terminating error

(Inherited from StorageCloudCmdletBase<T>)
WriteTransmitSummaryStatus()

Write transmit summary status

(Inherited from StorageCloudCmdletBase<T>)
WriteVerbose(String) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteWarning(String) (Inherited from AzurePSCmdlet)
WriteWarningWithTimestamp(String) (Inherited from AzurePSCmdlet)

Extension Methods

DisableDataCollection(AzurePSCmdlet)
EnableDataCollection(AzurePSCmdlet)

Applies to