Skip to content

Commit b974a3c

Browse files
authored
[Storage] Add user agent for dataplane cmdlets (#12255)
1 parent 360dfad commit b974a3c

22 files changed

+38
-31
lines changed

src/Storage/Storage.Management/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Fixed the issue that UserAgent not added for some dataplane cmdlets.
2122
* Supported create/update Storage account with MinimumTlsVersion and AllowBlobPublicAccess
2223
- `New-AzStorageAccount`
2324
- `Set-AzStorageAccount`

src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainerStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ internal async Task GetAzureContainerStoredAccessPolicyAsync(long taskId, IStora
8686
internal async Task<SharedAccessBlobPolicies> GetPoliciesAsync(IStorageBlobManagement localChannel, string containerName, string policyName)
8787
{
8888
CloudBlobContainer container = localChannel.GetContainerReference(containerName);
89-
BlobContainerPermissions blobContainerPermissions = await localChannel.GetContainerPermissionsAsync(container, null, null, null, CmdletCancellationToken).ConfigureAwait(false);
89+
BlobContainerPermissions blobContainerPermissions = await localChannel.GetContainerPermissionsAsync(container, null, null, OperationContext, CmdletCancellationToken).ConfigureAwait(false);
9090
return blobContainerPermissions.SharedAccessPolicies;
9191
}
9292

src/Storage/Storage/Blob/Cmdlet/NewAzureStorageContainerStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ internal string CreateAzureContainerStoredAccessPolicy(IStorageBlobManagement lo
7777

7878
//Get existing permissions
7979
CloudBlobContainer container = localChannel.GetContainerReference(containerName);
80-
BlobContainerPermissions blobContainerPermissions = localChannel.GetContainerPermissions(container);
80+
BlobContainerPermissions blobContainerPermissions = localChannel.GetContainerPermissions(container, null, null, OperationContext);
8181

8282
//Add new policy
8383
if (blobContainerPermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -90,7 +90,7 @@ internal string CreateAzureContainerStoredAccessPolicy(IStorageBlobManagement lo
9090
blobContainerPermissions.SharedAccessPolicies.Add(policyName, policy);
9191

9292
//Set permissions back to container
93-
localChannel.SetContainerPermissions(container, blobContainerPermissions);
93+
localChannel.SetContainerPermissions(container, blobContainerPermissions, null, null, OperationContext);
9494
return policyName;
9595
}
9696

src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageContainerStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ internal bool RemoveAzureContainerStoredAccessPolicy(IStorageBlobManagement loca
6969

7070
//Get existing permissions
7171
CloudBlobContainer container = localChannel.GetContainerReference(containerName);
72-
BlobContainerPermissions blobContainerPermissions = localChannel.GetContainerPermissions(container);
72+
BlobContainerPermissions blobContainerPermissions = localChannel.GetContainerPermissions(container, null, null, OperationContext);
7373

7474
//remove the specified policy
7575
if (!blobContainerPermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -80,7 +80,7 @@ internal bool RemoveAzureContainerStoredAccessPolicy(IStorageBlobManagement loca
8080
if (ShouldProcess(policyName, "Remove policy"))
8181
{
8282
blobContainerPermissions.SharedAccessPolicies.Remove(policyName);
83-
localChannel.SetContainerPermissions(container, blobContainerPermissions);
83+
localChannel.SetContainerPermissions(container, blobContainerPermissions, null, null, OperationContext);
8484
success = true;
8585
}
8686

src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerAcl.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ internal async Task SetContainerAcl(long taskId, IStorageBlobManagement localCha
8787
BlobContainerPermissions permissions;
8888
try
8989
{
90-
permissions = localChannel.GetContainerPermissions(container);
90+
permissions = localChannel.GetContainerPermissions(container, null, requestOptions, OperationContext);
9191
}
9292
catch (StorageException e) when (e.IsNotFoundException())
9393
{

src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ internal string SetAzureContainerStoredAccessPolicy(IStorageBlobManagement local
7878
{
7979
//Get existing permissions
8080
CloudBlobContainer container = localChannel.GetContainerReference(containerName);
81-
BlobContainerPermissions blobContainerPermissions = localChannel.GetContainerPermissions(container);
81+
BlobContainerPermissions blobContainerPermissions = localChannel.GetContainerPermissions(container, null, null, OperationContext);
8282

8383
//Set the policy with new value
8484
if (!blobContainerPermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -91,7 +91,7 @@ internal string SetAzureContainerStoredAccessPolicy(IStorageBlobManagement local
9191
blobContainerPermissions.SharedAccessPolicies[policyName] = policy;
9292

9393
//Set permission back to container
94-
localChannel.SetContainerPermissions(container, blobContainerPermissions);
94+
localChannel.SetContainerPermissions(container, blobContainerPermissions, null, null, OperationContext);
9595
WriteObject(AccessPolicyHelper.ConstructPolicyOutputPSObject<SharedAccessBlobPolicy>(blobContainerPermissions.SharedAccessPolicies, policyName));
9696
return policyName;
9797
}

src/Storage/Storage/Common/CmdletOperationContext.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
namespace Microsoft.WindowsAzure.Commands.Storage.Common
1616
{
1717
using Microsoft.Azure.Storage;
18+
using Microsoft.WindowsAzure.Commands.Common;
1819
using System;
1920
using System.Threading;
2021
using XTable = Microsoft.Azure.Cosmos.Table;
@@ -148,6 +149,9 @@ public static OperationContext GetStorageOperationContext(Action<string> outputW
148149
}
149150
};
150151

152+
context.CustomUserAgent = ApiConstants.UserAgentHeaderValue;
153+
154+
151155
return context;
152156
}
153157

@@ -207,6 +211,8 @@ public static XTable.OperationContext GetStorageTableOperationContext(Action<str
207211
}
208212
};
209213

214+
context.CustomUserAgent = ApiConstants.UserAgentHeaderValue;
215+
210216
return context;
211217
}
212218

src/Storage/Storage/Common/Util.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,10 @@ private static CloudBlob GetBlobReferenceFromServer(
108108
return null;
109109
}
110110

111-
return GetCorrespondingTypeBlobReference(blob);
111+
return GetCorrespondingTypeBlobReference(blob, operationContext);
112112
}
113113

114-
public static CloudBlob GetCorrespondingTypeBlobReference(CloudBlob blob)
114+
public static CloudBlob GetCorrespondingTypeBlobReference(CloudBlob blob, OperationContext operationContext)
115115
{
116116
CloudBlob targetBlob;
117117
switch (blob.Properties.BlobType)
@@ -135,7 +135,7 @@ public static CloudBlob GetCorrespondingTypeBlobReference(CloudBlob blob)
135135

136136
try
137137
{
138-
Task.Run(() => targetBlob.FetchAttributesAsync()).Wait();
138+
Task.Run(() => targetBlob.FetchAttributesAsync(null, null, operationContext)).Wait();
139139
}
140140
catch (AggregateException e) when (e.InnerException is StorageException)
141141
{

src/Storage/Storage/File/Cmdlet/GetAzureStorageShareStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ internal async Task GetAzureShareStoredAccessPolicyAsync(long taskId, IStorageFi
7070
internal async Task<SharedAccessFilePolicies> GetPoliciesAsync(IStorageFileManagement localChannel, string shareName, string policyName)
7171
{
7272
CloudFileShare share = localChannel.GetShareReference(shareName);
73-
FileSharePermissions permissions = await localChannel.GetSharePermissionsAsync(share, null, null, null, CmdletCancellationToken).ConfigureAwait(false);
73+
FileSharePermissions permissions = await localChannel.GetSharePermissionsAsync(share, null, null, OperationContext, CmdletCancellationToken).ConfigureAwait(false);
7474
return permissions.SharedAccessPolicies;
7575
}
7676

src/Storage/Storage/File/Cmdlet/NewAzureStorageShareStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public override void ExecuteCmdlet()
9393
//Set permissions back to container
9494
try
9595
{
96-
Task.Run(() => fileShare.SetPermissionsAsync(fileSharePermissions)).Wait();
96+
Task.Run(() => fileShare.SetPermissionsAsync(fileSharePermissions, null, null, OperationContext)).Wait();
9797
}
9898
catch (AggregateException e) when (e.InnerException is StorageException)
9999
{

src/Storage/Storage/File/Cmdlet/RemoveAzureStorageShareStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ internal bool RemoveAzureShareStoredAccessPolicy(IStorageFileManagement localCha
6363
if (ShouldProcess(policyName, "Remove policy"))
6464
{
6565
permissions.SharedAccessPolicies.Remove(policyName);
66-
localChannel.SetSharePermissions(share, permissions);
66+
localChannel.SetSharePermissions(share, permissions, null, null, OperationContext);
6767
success = true;
6868
}
6969

src/Storage/Storage/File/Cmdlet/SetAzureStorageShareStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ internal string SetAzureShareStoredAccessPolicy(IStorageFileManagement localChan
7474
permissions.SharedAccessPolicies[policyName] = policy;
7575

7676
//Set permission back to share
77-
localChannel.SetSharePermissions(share, permissions);
77+
localChannel.SetSharePermissions(share, permissions, null, null, OperationContext);
7878
WriteObject(AccessPolicyHelper.ConstructPolicyOutputPSObject<SharedAccessFilePolicy>(permissions.SharedAccessPolicies, policyName));
7979
return policyName;
8080
}

src/Storage/Storage/File/Cmdlet/StartAzureStorageFileCopy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ private void StartCopyFromFile()
345345
taskId,
346346
destFile,
347347
() => this.ConfirmOverwrite(sourceFile.SnapshotQualifiedUri.ToString(), destFile.SnapshotQualifiedUri.ToString()),
348-
() => destFile.StartCopyAsync(sourceFile.GenerateCopySourceFile()));
348+
() => destFile.StartCopyAsync(sourceFile.GenerateCopySourceFile(), null, null, this.RequestOptions, this.OperationContext));
349349

350350
this.RunTask(taskGenerator);
351351
}

src/Storage/Storage/Model/Contract/StorageBlobManagement.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ public async Task<CloudBlob> GetBlobReferenceFromServerAsync(CloudBlobContainer
577577
CloudBlob blob = container.GetBlobReference(blobName);
578578
await blob.FetchAttributesAsync(accessCondition, options, operationContext, cancellationToken).ConfigureAwait(false);
579579

580-
return Util.GetCorrespondingTypeBlobReference(blob);
580+
return Util.GetCorrespondingTypeBlobReference(blob, operationContext);
581581
}
582582
catch (XSCL.StorageException e)
583583
{

src/Storage/Storage/Queue/Cmdlet/GetAzureStorageQueueStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ internal async Task GetAzureQueueStoredAccessPolicyAsync(long taskId, IStorageQu
8484
internal async Task<SharedAccessQueuePolicies> GetPoliciesAsync(IStorageQueueManagement localChannel, string queueName, string policyName)
8585
{
8686
CloudQueue queue = localChannel.GetQueueReference(queueName);
87-
QueuePermissions queuePermissions = await localChannel.GetPermissionsAsync(queue).ConfigureAwait(false);
87+
QueuePermissions queuePermissions = await localChannel.GetPermissionsAsync(queue, null, OperationContext).ConfigureAwait(false);
8888
return queuePermissions.SharedAccessPolicies;
8989
}
9090

src/Storage/Storage/Queue/Cmdlet/NewAzureStorageQueueStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ internal string CreateAzureQueueStoredAccessPolicy(IStorageQueueManagement local
7676

7777
//Get existing permissions
7878
CloudQueue queue = Channel.GetQueueReference(queueName);
79-
QueuePermissions queuePermissions = localChannel.GetPermissions(queue);
79+
QueuePermissions queuePermissions = localChannel.GetPermissions(queue, this.RequestOptions, this.OperationContext);
8080

8181
//Add new policy
8282
if (queuePermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -89,7 +89,7 @@ internal string CreateAzureQueueStoredAccessPolicy(IStorageQueueManagement local
8989
queuePermissions.SharedAccessPolicies.Add(policyName, policy);
9090

9191
//Set permissions back to queue
92-
localChannel.SetPermissions(queue, queuePermissions);
92+
localChannel.SetPermissions(queue, queuePermissions, null, OperationContext);
9393
return policyName;
9494
}
9595

src/Storage/Storage/Queue/Cmdlet/RemoveAzureStorageQueueStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ internal bool RemoveAzureQueueStoredAccessPolicy(IStorageQueueManagement localCh
6767

6868
//Get existing permissions
6969
CloudQueue queue = Channel.GetQueueReference(queueName);
70-
QueuePermissions queuePermissions = localChannel.GetPermissions(queue);
70+
QueuePermissions queuePermissions = localChannel.GetPermissions(queue, this.RequestOptions, this.OperationContext);
7171

7272
//remove the specified policy
7373
if (!queuePermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -78,7 +78,7 @@ internal bool RemoveAzureQueueStoredAccessPolicy(IStorageQueueManagement localCh
7878
if (ShouldProcess(policyName, "Remove policy"))
7979
{
8080
queuePermissions.SharedAccessPolicies.Remove(policyName);
81-
localChannel.SetPermissions(queue, queuePermissions);
81+
localChannel.SetPermissions(queue, queuePermissions, null, OperationContext);
8282
success = true;
8383
}
8484

src/Storage/Storage/Queue/Cmdlet/SetAzureStorageQueueStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ internal string SetAzureQueueStoredAccessPolicy(IStorageQueueManagement localCha
7676
{
7777
//Get existing permissions
7878
CloudQueue queue = Channel.GetQueueReference(queueName);
79-
QueuePermissions queuePermissions = localChannel.GetPermissions(queue);
79+
QueuePermissions queuePermissions = localChannel.GetPermissions(queue, this.RequestOptions, this.OperationContext);
8080

8181
//Set the policy with new value
8282
if (!queuePermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -90,7 +90,7 @@ internal string SetAzureQueueStoredAccessPolicy(IStorageQueueManagement localCha
9090

9191
//Set permission back to queue
9292
WriteObject(AccessPolicyHelper.ConstructPolicyOutputPSObject<SharedAccessQueuePolicy>(queuePermissions.SharedAccessPolicies, policyName));
93-
localChannel.SetPermissions(queue, queuePermissions);
93+
localChannel.SetPermissions(queue, queuePermissions, null, OperationContext);
9494
return policyName;
9595
}
9696

src/Storage/Storage/Table/Cmdlet/GetAzureStorageTableStoredAccessPolicy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ internal async Task GetAzureTableStoredAccessPolicyAsync(long taskId, IStorageTa
8484
internal async Task<SharedAccessTablePolicies> GetPoliciesAsync(IStorageTableManagement localChannel, string tableName, string policyName)
8585
{
8686
CloudTable table = localChannel.GetTableReference(tableName);
87-
TablePermissions tablePermissions = await localChannel.GetTablePermissionsAsync(table).ConfigureAwait(false);
87+
TablePermissions tablePermissions = await localChannel.GetTablePermissionsAsync(table, null, TableOperationContext).ConfigureAwait(false);
8888
return tablePermissions.SharedAccessPolicies;
8989
}
9090

src/Storage/Storage/Table/Cmdlet/NewAzureStorageTableStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ internal string CreateAzureTableStoredAccessPolicy(IStorageTableManagement local
7777

7878
//Get existing permissions
7979
CloudTable table = localChannel.GetTableReference(tableName);
80-
TablePermissions tablePermissions = localChannel.GetTablePermissions(table);
80+
TablePermissions tablePermissions = localChannel.GetTablePermissions(table, null, TableOperationContext);
8181

8282
//Add new policy
8383
if (tablePermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -90,7 +90,7 @@ internal string CreateAzureTableStoredAccessPolicy(IStorageTableManagement local
9090
tablePermissions.SharedAccessPolicies.Add(policyName, policy);
9191

9292
//Set permissions back to table
93-
localChannel.SetTablePermissions(table, tablePermissions);
93+
localChannel.SetTablePermissions(table, tablePermissions, null, TableOperationContext);
9494
return policyName;
9595
}
9696

src/Storage/Storage/Table/Cmdlet/RemoveAzureStorageTableStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ internal bool RemoveAzureTableStoredAccessPolicy(IStorageTableManagement localCh
6767

6868
//Get existing permissions
6969
CloudTable table = localChannel.GetTableReference(tableName);
70-
TablePermissions tablePermissions = localChannel.GetTablePermissions(table);
70+
TablePermissions tablePermissions = localChannel.GetTablePermissions(table, this.RequestOptions, this.TableOperationContext);
7171

7272
//remove the specified policy
7373
if (!tablePermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -78,7 +78,7 @@ internal bool RemoveAzureTableStoredAccessPolicy(IStorageTableManagement localCh
7878
if (ShouldProcess(policyName, "Remove policy"))
7979
{
8080
tablePermissions.SharedAccessPolicies.Remove(policyName);
81-
localChannel.SetTablePermissions(table, tablePermissions);
81+
localChannel.SetTablePermissions(table, tablePermissions, null, TableOperationContext);
8282
success = true;
8383
}
8484

src/Storage/Storage/Table/Cmdlet/SetAzureStorageTableStoredAccessPolicy.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ internal string SetAzureTableStoredAccessPolicy(IStorageTableManagement localCha
7979

8080
//Get existing permissions
8181
CloudTable table = localChannel.GetTableReference(Table);
82-
TablePermissions tablePermissions = localChannel.GetTablePermissions(table);
82+
TablePermissions tablePermissions = localChannel.GetTablePermissions(table, this.RequestOptions, this.TableOperationContext);
8383

8484
//Set the policy with new value
8585
if (!tablePermissions.SharedAccessPolicies.Keys.Contains(policyName))
@@ -92,7 +92,7 @@ internal string SetAzureTableStoredAccessPolicy(IStorageTableManagement localCha
9292
tablePermissions.SharedAccessPolicies[policyName] = policy;
9393

9494
//Set permission back to table
95-
localChannel.SetTablePermissions(table, tablePermissions);
95+
localChannel.SetTablePermissions(table, tablePermissions, null, TableOperationContext);
9696
WriteObject(AccessPolicyHelper.ConstructPolicyOutputPSObject<SharedAccessTablePolicy>(tablePermissions.SharedAccessPolicies, policyName));
9797
return policyName;
9898
}

0 commit comments

Comments
 (0)