Support pagination for enumerating deleted items #26974
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
|
@microsoft-github-policy-service agree company="Microsoft"
Regards
Amrita
…On Tue, Jan 7, 2025 at 3:20 PM microsoft-github-policy-service[bot] < ***@***.***> wrote:
@amrita-hegde <https://github.com/amrita-hegde> please read the following
Contributor License Agreement(CLA). If you agree with the CLA, please reply
with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of
intellectual property rights to my Submissions and I am not making
Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
- (when company given) I am making Submissions in the course of work
for my employer (or my employer has intellectual property rights in my
Submissions by contract or applicable law). I have permission from my
employer to make Submissions and enter into this Agreement on behalf of my
employer. By signing below, the defined term “You” includes me and my
employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement (*“Agreement”*) is agreed to by the
party signing below (*“You”*),
and conveys certain license rights to Microsoft Corporation and its
affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is
effective as of the latest signature
date below.
1. *Definitions*.
*“Code”* means the computer software code, whether in human-readable
or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
*“Project”* means any of the projects owned or managed by Microsoft
and offered under a license
approved by the Open Source Initiative (www.opensource.org).
*“Submit”* is the act of uploading, submitting, transmitting, or
distributing code or other content to any
Project, including but not limited to communication on electronic
mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf
of, the Project for the purpose of
discussing and improving that Project, but excluding communication
that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
*“Submission”* means the Code and any other copyrightable material
Submitted by You, including any
associated comments and documentation.
2. *Your Submission*. You must agree to the terms of this Agreement
before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now
or in the future (except as
described in Section 4 below), Submit to any Project.
3. *Originality of Work*. You represent that each of Your Submissions
is entirely Your original work.
Should You wish to Submit materials that are not Your original work,
You may Submit them separately
to the Project if You (a) retain all copyright and license information
that was in the materials as You
received them, (b) in the description accompanying Your Submission,
include the phrase “Submission
containing materials of a third party:” followed by the names of the
third party and any licenses or other
restrictions of which You are aware, and (c) follow any other
instructions in the Project’s written
guidelines concerning Submissions.
4. *Your Employer*. References to “employer” in this Agreement include
Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a
contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your
employer has intellectual
property rights in Your Submission by contract or applicable law, You
must secure permission from Your
employer to make the Submission before signing this Agreement. In that
case, the term “You” in this
Agreement will refer to You and the employer collectively. If You
change employers in the future and
desire to Submit additional Submissions for the new employer, then You
agree to sign a new Agreement
and secure permission from the new employer before Submitting those
Submissions.
5. *Licenses*.
- *Copyright License*. You grant Microsoft, and those who receive the
Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly
display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all
of the foregoing rights to third
parties.
- *Patent License*. You grant Microsoft, and those who receive the
Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or
the combination of the
Submission with the Project to which it was Submitted to make, have
made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the
Project.
- *Other Rights Reserved*. Each party reserves all rights not
expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without
limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.
6. *Representations and Warranties*. You represent that You are
legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your
original work (except as You may
have disclosed under Section 3). You represent that You have secured
permission from Your employer to
make the Submission in cases where Your Submission is made in the
course of Your work for Your
employer or Your employer has intellectual property rights in Your
Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You
represent and warrant that You
have the necessary authority to bind the listed employer to the
obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless
You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE
WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED
UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO,
ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. *Notice to Microsoft*. You agree to notify Microsoft in writing of
any facts or circumstances of which
You later become aware that would make Your representations in this
Agreement inaccurate in any
respect.
8. *Information about Submissions*. You agree that contributions to
Projects and information about
contributions may be maintained indefinitely and disclosed publicly,
including Your name and other
information that You submit with Your Submission.
9. *Governing Law/Jurisdiction*. This Agreement is governed by the
laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal
courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in
which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County,
Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
10. *Entire Agreement/Assignment*. This Agreement is the entire
agreement between the parties, and
supersedes any and all prior agreements, understandings or
communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may
be assigned by Microsoft.
—
Reply to this email directly, view it on GitHub
<#26974 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BNPYB5M4DYGFNJGM3VJUUDL2JOPNLAVCNFSM6AAAAABUXK4LPGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZUHA2DKMBWGQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 26974 in repo Azure/azure-powershell |
src/DataLakeStore/DataLakeStore/DataPlaneModels/AdlsClientFactory.cs
Outdated
Show resolved
Hide resolved
src/DataLakeStore/DataLakeStore/DataPlaneModels/DataLakeStoreFileSystemClient.cs
Show resolved
Hide resolved
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
Head branch was pushed to by a user without write access
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
| return new object(); | ||
| } | ||
| ) | ||
| Account = AzureRmProfileProvider.Instance.Profile.DefaultContext.Account, |
There was a problem hiding this comment.
I have 2 modes: recording and playback. In playback mode, you should use MockCredential. Specifically in you case, you should set AdlsClientFactory.IsTest = true. In pipeline, the test cases are all run in playback mode, which no access to EntraID service.
There was a problem hiding this comment.
I have updated the code to use MockCredentials for test. Please take a look.
isra-fel
force-pushed
the
release-2025-06-03
branch
from
85ea2c5 to
ba9dc3f
Compare
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
There was a problem hiding this comment.
The CustomDelegatingHAndler is not passed to the AdlsClient. This method is removed from the 2.0.2 SDK. By passing the custom delegating handler, it will inject custom handler into the normal HttpClient. So marked 7 tests as LiveOnly mode since they were trying to call azure environment in playback mode.
| Mandatory = false, | ||
| ParameterSetName = DefaultParameterSet, | ||
| HelpMessage = "Token returned by system in the previous invocation")] | ||
| public string listAfter { get; set; } |
There was a problem hiding this comment.
Per .NET and PowerShell naming convention, the parameter name should be ListAfter (capital 'L')
| WriteObject(toReturn, enumerateCollection: true); | ||
|
|
||
| // Write the continuation token. | ||
| WriteObject($"Continuation Token: {continuationToken}"); |
There was a problem hiding this comment.
The WriteObject is kind of special in PowerShell SDK. It is used to output the returned object instead of a result message. Any reason why the token should be piped out?
There was a problem hiding this comment.
Continuation token will be the input to the next request. So user has to know the continuation token to fetch the next page.
There was a problem hiding this comment.
WriteObject will output multiple objects with different types which is not recommended. It may break the existing automation script and looks like a breaking change. Could you please write a test case to verify? Still I don't quite understand why the token is necessary here. Could it be wrapped into the object model?
There was a problem hiding this comment.
We were using WriteObject to output the trash entries earlier. Only the continuation token is the addition here. The whole purpose of this change is to give back a continuation token to the user so that they can pass it in the next command to get the subsequent pages of the deleted item entries. If it has to be wrapped into an object, it needs multiple change in dotnet sdk.
There was a problem hiding this comment.
I think the comment of @vidai-msft does make sense. WriteObject 2 times should not supported in Azure PowerShell. Could you prepare a cmdlet test example with screenshots to describes your case?
| @@ -47,17 +49,17 @@ internal static AdlsClient GetAdlsClient(string accntNm, IAzureContext context) | |||
| AdlsClient client = null; | |||
| if (IsTest) | |||
| { | |||
| client = AdlsClient.CreateClient(accntNm, MockCredentials, DataLakeStoreFileSystemClient.ImportExportMaxThreads, CustomDelegatingHAndler); | |||
| client = AdlsClient.CreateClient(accntNm, MockCredentials, new string[] { }); | |||
There was a problem hiding this comment.
The IsTest looks like has no use here. Can you please refactor the code here to avoid any confuse in the future?
| { | ||
| AdlsClientFactory.IsTest = true; | ||
|
|
||
| var serviceClientCredentials = context.GetClientCredentials("https://datalake.azure.net"); |
There was a problem hiding this comment.
We have a class to predefine all the well-known URLs. datalake.azure.net could be referenced by AzureEnvironment.Endpoint.DataLakeEndpointResourceId. Can consider replacing with this variable.
There was a problem hiding this comment.
This class is not needed anymore. removed
| null, | ||
| ShowDialog.Never, | ||
| null, | ||
| "https://datalake.azure.net/"); |
There was a problem hiding this comment.
Better use AzureEnvironment.Endpoint.DataLakeEndpointResourceId to reference the endpoint here.
| @@ -14,8 +14,8 @@ Searches for deleted entries in trash which match the filter. | |||
| ## SYNTAX | |||
|
|
|||
| ``` | |||
| Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count <Int32>] [-AsJob] | |||
| [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] | |||
| Get-AzDataLakeStoreDeletedItem [-Account] <String> [-Filter] <String> [-Count <Int32>] [-listAfter <String>] | |||
There was a problem hiding this comment.
Please update the listAfter to ListAfter and re-generate the help docs.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
| @@ -70,7 +70,7 @@ public void TestAdlsTrustedIdProvider() | |||
| } | |||
|
|
|||
| [Fact] | |||
| [Trait(Category.AcceptanceType, Category.CheckIn)] | |||
| [Trait(Category.AcceptanceType, Category.LiveOnly)] | |||
There was a problem hiding this comment.
Any reason to remove the test cases?
There was a problem hiding this comment.
#26974 (review) As mentioned here, passing the CustomDelegatingHAndler to adls client is not supported in the new .net sdk. Discussed this with @vidai-msft and marked the testcases as LiveOnly.
| WriteObject(toReturn, enumerateCollection: true); | ||
|
|
||
| // Write the continuation token. | ||
| WriteObject($"Continuation Token: {continuationToken}"); |
There was a problem hiding this comment.
I think the comment of @vidai-msft does make sense. WriteObject 2 times should not supported in Azure PowerShell. Could you prepare a cmdlet test example with screenshots to describes your case?
|
To the author of the pull request, |
Description
Cosmos customers currently utilize the Azure PowerShell for restoring items. However, a limitation exists in the tool: it lacks the capability to retrieve the items by enumerating them page-wise. This change provides the capability to pass a continuation token to the Get-AzDataLakeStoreDeletedItem cmdlet so that, users can retrieve the next page using the continuation token. Maximum allowed value for this numResults(pagesize) is 4000. The number of returned entries could be more or less than numResults.
###Changes
Azure PowerShell
To enable subsequent pages to be fetched from PowerShell,
Define the optional parameter Continuation Token in Azure PowerShell for GetAzureRmDataLakeStoreDeletedItem command.
Use the continuation token to fetch subsequent pages when calling the API.
.NET SDK
Azure/azure-data-lake-store-net#69
Change is released in https://www.nuget.org/packages/Microsoft.Azure.DataLake.Store/2.0.2
This overloaded method will be called from Azure PowerShell by consuming the latest SDK version 2.0.2.
Testing
Response from GetAzureRmDataLakeStoreDeletedItem cmd
Test execution
When expired/incorrect continuation token is passed
Local build
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.