Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading example #23537

Closed
Deondrede opened this issue Aug 15, 2022 · 6 comments
Closed

Misleading example #23537

Deondrede opened this issue Aug 15, 2022 · 6 comments
Assignees
Labels
Auto-Assign Auto assign by bot customer-reported Issues that are reported by GitHub users external to the Azure organization. DevOps Documentation Service Attention This issue is responsible by Azure service team.

Comments

@Deondrede
Copy link

Deondrede commented Aug 15, 2022

In the example section on this page it shows the token as

az devops security permission update  --allow-bit 7 --namespace-id 52d39943-cb85-4d7f-8fa8-c6baac873819 --subject user@fabrikam.com --token "$PROJECT:vstfs:///Classification/TeamProject/e479xxxx-2be8-xxxx-bb0b-3a0209cxxxx"

The example fails to acknowledge that in order to for the token parameter to be correct you need to escape the $.
The working example is

az devops security permission update  --allow-bit 7 --namespace-id 52d39943-cb85-4d7f-8fa8-c6baac873819 --subject user@fabrikam.com --token "`$PROJECT:vstfs:///Classification/TeamProject/e479xxxx-2be8-xxxx-bb0b-3a0209cxxxx"

The first command also does not fail or provide an error of any kind. It would be nice to have this rectified to avoid future confusion

Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@ghost ghost added customer-reported Issues that are reported by GitHub users external to the Azure organization. Auto-Assign Auto assign by bot CXP Attention This issue is handled by CXP team. DevOps labels Aug 15, 2022
@yonzhan
Copy link
Collaborator

yonzhan commented Aug 15, 2022

route to CXP team

@navba-MSFT navba-MSFT added Service Attention This issue is responsible by Azure service team. needs-team-attention This issue needs attention from Azure service team or SDK team and removed CXP Attention This issue is handled by CXP team. labels Aug 16, 2022
@ghost
Copy link

ghost commented Aug 16, 2022

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @v-anvashist, @V-hmusukula.

Issue Details

In the example section on this page it shows the token as

az devops security permission update  --allow-bit 7 --namespace-id 52d39943-cb85-4d7f-8fa8-c6baac873819 --subject user@fabrikam.com --token "$PROJECT:vstfs:///Classification/TeamProject/e479xxxx-2be8-xxxx-bb0b-3a0209cxxxx"

The example fails to acknowledge that in order to for the token parameter to be correct you need to escape the $.
The working example is

az devops security permission update  --allow-bit 7 --namespace-id 52d39943-cb85-4d7f-8fa8-c6baac873819 --subject user@fabrikam.com --token "`$PROJECT:vstfs:///Classification/TeamProject/e479xxxx-2be8-xxxx-bb0b-3a0209cxxxx"

The first command also does not fail or provide an error of any kind. It would be nice to have this rectified to avoid future confusion

Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Author: Deondrede
Assignees: -
Labels:

Service Attention, customer-reported, DevOps, needs-team-attention, Auto-Assign

Milestone: -

@navba-MSFT
Copy link
Contributor

Adding Service team to look into the devops issue.

@v-anvashist, @V-hmusukula Could you please look into this and provide an update ?

@Arvindgade
Copy link

@Deondrede could you please check the below similar issue having the solution provided
#23759
Hope this will work. Thanks!

@Deondrede
Copy link
Author

@Arvindgade the "solution" you linked to references this issue as the answer. I know what the solution is, my request is for the documentation page to be updated and for the command to throw an error or warning if the $ isn't properly escaped

@RakeshMohanMSFT RakeshMohanMSFT self-assigned this Jan 9, 2023
@RakeshMohanMSFT RakeshMohanMSFT added Documentation and removed needs-team-attention This issue needs attention from Azure service team or SDK team labels Jan 9, 2023
@RakeshMohanMSFT
Copy link
Contributor

This PR will fix this issue Azure/azure-devops-cli-extension#1333

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Assign Auto assign by bot customer-reported Issues that are reported by GitHub users external to the Azure organization. DevOps Documentation Service Attention This issue is responsible by Azure service team.
Projects
None yet
Development

No branches or pull requests

5 participants