Skip to content

Commit

Permalink
[Identity] update readme and sample folder for broker plugin referenc…
Browse files Browse the repository at this point in the history
…es (#27651)
  • Loading branch information
KarishmaGhiya authored Nov 3, 2023
1 parent 7bb0229 commit 2719dcf
Show file tree
Hide file tree
Showing 18 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion sdk/identity/identity-broker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ main().catch((error) => {
process.exit(1);
});
```
For an example of using Electron app for retrieving a window handle, check [this sample](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1-beta/typescript/src/index.ts).
For an example of using an Electron app for retrieving a window handle, see [this sample](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1/typescript/src/index.ts).

## Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ npx cross-env AZURE_CLIENT_ID="<azure client id>" AZURE_AUTHORITY_HOST="<azure a

Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.

[index]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1-beta/javascript/index.js
[index]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1/javascript/index.js
[apiref]: https://learn.microsoft.com/javascript/api/@azure/identity
[freesub]: https://azure.microsoft.com/free/
[createinstance_azureactivedirectoryappregistration]: https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ npx cross-env AZURE_CLIENT_ID="<azure client id>" AZURE_AUTHORITY_HOST="<azure a

Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.

[index]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1-beta/typescript/src/index.ts
[index]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1/typescript/src/index.ts
[apiref]: https://learn.microsoft.com/javascript/api/@azure/identity
[freesub]: https://azure.microsoft.com/free/nodejs
[createinstance_azureactivedirectoryappregistration]: https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
Expand Down
3 changes: 1 addition & 2 deletions sdk/identity/identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,8 @@ Due to a [known issue](https://github.com/Azure/azure-sdk-for-js/issues/20500),
## Plugins

Azure Identity for JavaScript provides a plugin API that allows us to provide certain functionality through separate _plugin packages_. The `@azure/identity` package exports a top-level function (`useIdentityPlugin`) that can be used to enable a plugin. We provide two plugin packages:

- [`@azure/identity-broker`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity-broker), which provides brokered authentication support through a native broker, such as Web Account Manager.
- [`@azure/identity-cache-persistence`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity-cache-persistence), which provides persistent token caching in Node.js using a native secure storage system provided by your operating system. This plugin allows cached `access_token` values to persist across sessions, meaning that an interactive login flow does not need to be repeated as long as a cached token is available.
- [`@azure/identity-vscode`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity-vscode), which provides the dependencies of `VisualStudioCodeCredential` and enables it. Without this plugin, the `VisualStudioCodeCredential` in this package will throw a `CredentialUnavailableError`. The plugin provides the underlying implementation of this credential, enabling it for use both on its own and as part of the `DefaultAzureCredential` described above.

## Examples

Expand Down

0 comments on commit 2719dcf

Please sign in to comment.