|
| 1 | +# Azure MicrosoftFileShares client library for JavaScript |
| 2 | + |
| 3 | +This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure MicrosoftFileShares client. |
| 4 | + |
| 5 | +Azure File Shares Resource Provider API. |
| 6 | + |
| 7 | +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/fileshares/arm-fileshares) | |
| 8 | +[Package (NPM)](https://www.npmjs.com/package/@azure/arm-fileshares) | |
| 9 | +[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-fileshares?view=azure-node-preview) | |
| 10 | +[Samples](https://github.com/Azure-Samples/azure-samples-js-management) |
| 11 | + |
| 12 | +## Getting started |
| 13 | + |
| 14 | +### Currently supported environments |
| 15 | + |
| 16 | +- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule) |
| 17 | +- Latest versions of Safari, Chrome, Edge and Firefox. |
| 18 | + |
| 19 | +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. |
| 20 | + |
| 21 | +### Prerequisites |
| 22 | + |
| 23 | +- An [Azure subscription][azure_sub]. |
| 24 | + |
| 25 | +### Install the `@azure/arm-fileshares` package |
| 26 | + |
| 27 | +Install the Azure MicrosoftFileShares client library for JavaScript with `npm`: |
| 28 | + |
| 29 | +```bash |
| 30 | +npm install @azure/arm-fileshares |
| 31 | +``` |
| 32 | + |
| 33 | +### Create and authenticate a `MicrosoftFileShares` |
| 34 | + |
| 35 | +To create a client object to access the Azure MicrosoftFileShares API, you will need the `endpoint` of your Azure MicrosoftFileShares resource and a `credential`. The Azure MicrosoftFileShares client can use Azure Active Directory credentials to authenticate. |
| 36 | +You can find the endpoint for your Azure MicrosoftFileShares resource in the [Azure Portal][azure_portal]. |
| 37 | + |
| 38 | +You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token). |
| 39 | + |
| 40 | +To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package: |
| 41 | + |
| 42 | +```bash |
| 43 | +npm install @azure/identity |
| 44 | +``` |
| 45 | + |
| 46 | +You will also need to **register a new AAD application and grant access to Azure MicrosoftFileShares** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions). |
| 47 | + |
| 48 | +For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal). |
| 49 | + |
| 50 | +Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client. |
| 51 | + |
| 52 | +```ts snippet:ReadmeSampleCreateClient_Node |
| 53 | +import { MicrosoftFileShares } from "@azure/arm-fileshares"; |
| 54 | +import { DefaultAzureCredential } from "@azure/identity"; |
| 55 | + |
| 56 | +const subscriptionId = "00000000-0000-0000-0000-000000000000"; |
| 57 | +const client = new MicrosoftFileShares(new DefaultAzureCredential(), subscriptionId); |
| 58 | +``` |
| 59 | + |
| 60 | +For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate. |
| 61 | + |
| 62 | +```ts snippet:ReadmeSampleCreateClient_Browser |
| 63 | +import { InteractiveBrowserCredential } from "@azure/identity"; |
| 64 | +import { MicrosoftFileShares } from "@azure/arm-fileshares"; |
| 65 | + |
| 66 | +const credential = new InteractiveBrowserCredential({ |
| 67 | + tenantId: "<YOUR_TENANT_ID>", |
| 68 | + clientId: "<YOUR_CLIENT_ID>" |
| 69 | + }); |
| 70 | +const client = new MicrosoftFileShares(credential, subscriptionId); |
| 71 | +``` |
| 72 | + |
| 73 | +### JavaScript Bundle |
| 74 | +To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling). |
| 75 | + |
| 76 | +## Key concepts |
| 77 | + |
| 78 | +### MicrosoftFileShares |
| 79 | + |
| 80 | +`MicrosoftFileShares` is the primary interface for developers using the Azure MicrosoftFileShares client library. Explore the methods on this client object to understand the different features of the Azure MicrosoftFileShares service that you can access. |
| 81 | + |
| 82 | +## Troubleshooting |
| 83 | + |
| 84 | +### Logging |
| 85 | + |
| 86 | +Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: |
| 87 | + |
| 88 | +```ts snippet:SetLogLevel |
| 89 | +import { setLogLevel } from "@azure/logger"; |
| 90 | + |
| 91 | +setLogLevel("info"); |
| 92 | +``` |
| 93 | + |
| 94 | +For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger). |
| 95 | + |
| 96 | +## Next steps |
| 97 | + |
| 98 | +Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library. |
| 99 | + |
| 100 | +## Contributing |
| 101 | + |
| 102 | +If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code. |
| 103 | + |
| 104 | +## Related projects |
| 105 | + |
| 106 | +- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js) |
| 107 | + |
| 108 | + |
| 109 | +[azure_cli]: https://learn.microsoft.com/cli/azure |
| 110 | +[azure_sub]: https://azure.microsoft.com/free/ |
| 111 | +[azure_sub]: https://azure.microsoft.com/free/ |
| 112 | +[azure_portal]: https://portal.azure.com |
| 113 | +[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity |
| 114 | +[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential |
0 commit comments