< Back
Get-AzureStorageBlobCopyState
Post
NAME Get-AzureStorageBlobCopyState
SYNOPSIS
Gets the copy status of an Azure Storage blob.
SYNTAX
Get-AzureStorageBlobCopyState [-Blob] <String> [-Container] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-WaitForComplete] [<CommonParameters>]
Get-AzureStorageBlobCopyState [-Blob] <String> [-ClientTimeoutPerRequest <Int32>] -CloudBlobContainer <CloudBlobContainer> [-ConcurrentTaskCount
<Int32>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-WaitForComplete] [<CommonParameters>]
Get-AzureStorageBlobCopyState [-ClientTimeoutPerRequest <Int32>] -CloudBlob <CloudBlob> [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-WaitForComplete] [<CommonParameters>]
DESCRIPTION
The Get-AzureStorageBlobCopyState cmdlet gets the copy status of an Azure Storage blob.
PARAMETERS
-Blob <String>
Specifies the name of a blob. This cmdlet gets the state of the blob copy operation for the Azure Storage blob that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClientTimeoutPerRequest <Int32>
Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this
cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CloudBlob <CloudBlob>
Specifies a CloudBlob object from Azure Storage Client library. To obtain a CloudBlob object, use the Get-AzureStorageBlob cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CloudBlobContainer <CloudBlobContainer>
Specifies a CloudBlobContainer object from the Azure Storage Client library. This cmdlet gets the copy status of a blob in the container that
this parameter specifies. To obtain a CloudBlobContainer object, use the Get-AzureStorageContainer cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage
by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core
count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default
value is 10.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Container <String>
Specifies the name of a container. This cmdlet gets the copy status for a blob in the container that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
Specifies the service side time-out interval, in seconds, for a request. If the specified interval elapses before the service processes the
request, the storage service returns an error.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WaitForComplete [<SwitchParameter>]
Indicates that this cmdlet waits for the copy to finish. If you do not specify this parameter, this cmdlet returns a result immediately.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
OUTPUTS
CopyState
NOTES
Example 1: Get the copy status of a blob
C:\\PS>Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015" -Container "ContosoUploads"
This command gets the copy status of the blob named ContosoPlanning2015 in the container ContosoUploads.
Example 2: Get the copy status for of a blob by using the pipeline
C:\\PS>Get-AzureStorageBlob -Blob "ContosoPlanning2015" -Container "ContosoUploads" | Get-AzureStorageBlobCopyState
This command gets the blob named ContosoPlanning2015 in the container named ContosoUploads by using the Get-AzureStorageBlob cmdlet, and then
passes the result to the current cmdlet by using the pipeline operator. The Get-AzureStorageBlobCopyState cmdlet gets the copy status for that
blob.
Example 3: Get the copy status for a blob in a container by using the pipeline
C:\\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015"
This command gets the container named by using the Get-AzureStorageBlob cmdlet, and then passes the result to the current cmdlet. The
Get-AzureStorageContainer cmdlet gets the copy status for the blob named ContosoPlanning2015 in that container.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... bcopystate
Start-AzureStorageBlobCopy
Stop-AzureStorageBlobCopy
SYNOPSIS
Gets the copy status of an Azure Storage blob.
SYNTAX
Get-AzureStorageBlobCopyState [-Blob] <String> [-Container] <String> [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-WaitForComplete] [<CommonParameters>]
Get-AzureStorageBlobCopyState [-Blob] <String> [-ClientTimeoutPerRequest <Int32>] -CloudBlobContainer <CloudBlobContainer> [-ConcurrentTaskCount
<Int32>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-WaitForComplete] [<CommonParameters>]
Get-AzureStorageBlobCopyState [-ClientTimeoutPerRequest <Int32>] -CloudBlob <CloudBlob> [-ConcurrentTaskCount <Int32>] [-Context
<IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-WaitForComplete] [<CommonParameters>]
DESCRIPTION
The Get-AzureStorageBlobCopyState cmdlet gets the copy status of an Azure Storage blob.
PARAMETERS
-Blob <String>
Specifies the name of a blob. This cmdlet gets the state of the blob copy operation for the Azure Storage blob that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClientTimeoutPerRequest <Int32>
Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this
cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CloudBlob <CloudBlob>
Specifies a CloudBlob object from Azure Storage Client library. To obtain a CloudBlob object, use the Get-AzureStorageBlob cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CloudBlobContainer <CloudBlobContainer>
Specifies a CloudBlobContainer object from the Azure Storage Client library. This cmdlet gets the copy status of a blob in the container that
this parameter specifies. To obtain a CloudBlobContainer object, use the Get-AzureStorageContainer cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConcurrentTaskCount <Int32>
Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage
by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core
count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default
value is 10.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Container <String>
Specifies the name of a container. This cmdlet gets the copy status for a blob in the container that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Context <IStorageContext>
Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-ServerTimeoutPerRequest <Int32>
Specifies the service side time-out interval, in seconds, for a request. If the specified interval elapses before the service processes the
request, the storage service returns an error.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WaitForComplete [<SwitchParameter>]
Indicates that this cmdlet waits for the copy to finish. If you do not specify this parameter, this cmdlet returns a result immediately.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
OUTPUTS
CopyState
NOTES
Example 1: Get the copy status of a blob
C:\\PS>Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015" -Container "ContosoUploads"
This command gets the copy status of the blob named ContosoPlanning2015 in the container ContosoUploads.
Example 2: Get the copy status for of a blob by using the pipeline
C:\\PS>Get-AzureStorageBlob -Blob "ContosoPlanning2015" -Container "ContosoUploads" | Get-AzureStorageBlobCopyState
This command gets the blob named ContosoPlanning2015 in the container named ContosoUploads by using the Get-AzureStorageBlob cmdlet, and then
passes the result to the current cmdlet by using the pipeline operator. The Get-AzureStorageBlobCopyState cmdlet gets the copy status for that
blob.
Example 3: Get the copy status for a blob in a container by using the pipeline
C:\\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015"
This command gets the container named by using the Get-AzureStorageBlob cmdlet, and then passes the result to the current cmdlet. The
Get-AzureStorageContainer cmdlet gets the copy status for the blob named ContosoPlanning2015 in that container.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... bcopystate
Start-AzureStorageBlobCopy
Stop-AzureStorageBlobCopy