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

APIScan failure on DefaultAzureCredentialOptions several properties #44482

Closed
JRahnama opened this issue Jun 10, 2024 · 4 comments
Closed

APIScan failure on DefaultAzureCredentialOptions several properties #44482

JRahnama opened this issue Jun 10, 2024 · 4 comments
Assignees
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. issue-addressed Workflow: The Azure SDK team believes it to be addressed and ready to close. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@JRahnama
Copy link

Library name and version

Azure.Identity v1.11.3

Describe the bug

APIScan is not able to find documentation for below properties on DefaultAzureCredentialOptions

SharedTokenCacheTenantId, VisualStudioCodeTenantId, VisualStudioTenantId.

We have received several bug reports similar to below

Tool: ApiScan: Rule: documentationnotfound (Documentation Not Found). https://aka.ms/apiscan/learnmore?page=protocol%2fdocumentationnotfound.htm
azure.identity!Azure.Identity.DefaultAzureCredentialOptions.set_SharedTokenCacheTenantId is either an undocumented HVP API or the documentation is not discoverable.

We were not able to find related source for these properties in published documentation.

Expected behavior

We would except to find documentation publicly for these properties.
APIScan should be able to find the documentation.

Actual behavior

Tool: ApiScan: Rule: documentationnotfound (Documentation Not Found). https://aka.ms/apiscan/learnmore?page=protocol%2fdocumentationnotfound.htm
azure.identity!Azure.Identity.DefaultAzureCredentialOptions.set_SharedTokenCacheTenantId is either an undocumented HVP API or the documentation is not discoverable.

Reproduction Steps

There is no specific repro steps. You can try finding public documentation for those properties which leads to nowhere.

Environment

No response

@github-actions github-actions bot added Azure.Identity Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jun 10, 2024
Copy link

Thank you for your feedback. Tagging and routing to the team member best able to assist.

@christothes
Copy link
Member

christothes commented Jun 10, 2024

hi @JRahnama -
These properties are intentionally hidden. The generic TenantId property is meant to be used instead.

[EditorBrowsable(EditorBrowsableState.Never)]
public string InteractiveBrowserTenantId

@christothes christothes added the issue-addressed Workflow: The Azure SDK team believes it to be addressed and ready to close. label Jun 10, 2024
Copy link

Hi @JRahnama. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

@github-actions github-actions bot removed the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Jun 10, 2024
@JRahnama
Copy link
Author

We were able to replace those properties with TenantId. Thank you.

@github-actions github-actions bot locked and limited conversation to collaborators Sep 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. issue-addressed Workflow: The Azure SDK team believes it to be addressed and ready to close. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
Development

No branches or pull requests

2 participants