Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 41 additions & 40 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

60 changes: 52 additions & 8 deletions sdk/healthbot/arm-healthbot/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,59 @@
# Release History

## 2.1.1 (Unreleased)

## 3.0.0 (2025-05-12)
### Features Added

### Breaking Changes
- Added operation group HealthBotsOperations
- Added Interface ErrorDetail
- Added Interface HealthBotClientOptionalParams
- Added Interface HealthBotKey
- Added Interface HealthBotKeysResponse
- Added Interface HealthBotsCreateOptionalParams
- Added Interface HealthBotsDeleteOptionalParams
- Added Interface HealthBotsGetOptionalParams
- Added Interface HealthBotsListByResourceGroupOptionalParams
- Added Interface HealthBotsListOptionalParams
- Added Interface HealthBotsListSecretsOptionalParams
- Added Interface HealthBotsRegenerateApiJwtSecretOptionalParams
- Added Interface HealthBotsUpdateOptionalParams
- Added Interface KeyVaultProperties
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface RestorePollerOptions
- Added Interface UserAssignedIdentityMap
- Added Class HealthBotClient
- Added Type Alias ContinuablePage
- Added Type Alias CreatedByType
- Interface HealthBotProperties has a new optional parameter keyVaultProperties
- Interface HealthBotUpdateParameters has a new optional parameter properties
- Added Enum KnownCreatedByType
- Added Enum KnownVersions
- Added function restorePoller

### Bugs Fixed

### Other Changes
### Breaking Changes

- Removed operation group AvailableOperations
- Removed operation group Bots
- Deleted Class HealthbotClient
- Type of parameter info of interface ErrorAdditionalInfo is changed from Record<string, unknown> to Record<string, any>
- Type of parameter error of interface ErrorModel is changed from ErrorError to ErrorDetail
- Type of parameter tags of interface HealthBotUpdateParameters is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter userAssignedIdentities of interface Identity is changed from {
[propertyName: string]: UserAssignedIdentity;
} to UserAssignedIdentityMap
- Type of parameter properties of interface OperationDetail is changed from Record<string, unknown> to Record<string, any>
- Type of parameter createdByType of interface SystemData is changed from IdentityType to CreatedByType
- Type of parameter lastModifiedByType of interface SystemData is changed from IdentityType to CreatedByType
- Type of parameter tags of interface TrackedResource is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Removed Enum KnownIdentityType
- Removed function getContinuationToken


## 2.1.0 (2022-11-25)

### Features Added
Expand All @@ -26,4 +70,4 @@ To understand the detail of the change, please refer to [Changelog](https://aka.

To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).

To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
2 changes: 1 addition & 1 deletion sdk/healthbot/arm-healthbot/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
48 changes: 23 additions & 25 deletions sdk/healthbot/arm-healthbot/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Azure Healthbot client library for JavaScript
# Azure HealthBot client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Healthbot client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure HealthBot client.

Azure Health Bot is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthbot/arm-healthbot) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-healthbot) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-healthbot) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthbot/arm-healthbot)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-healthbot)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-healthbot?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthbot/arm-healthbot/samples)

## Getting started

Expand All @@ -24,16 +26,16 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-healthbot` package

Install the Azure Healthbot client library for JavaScript with `npm`:
Install the Azure HealthBot client library for JavaScript with `npm`:

```bash
npm install @azure/arm-healthbot
```

### Create and authenticate a `HealthbotClient`
### Create and authenticate a `HealthBotClient`

To create a client object to access the Azure Healthbot API, you will need the `endpoint` of your Azure Healthbot resource and a `credential`. The Azure Healthbot client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Healthbot resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure HealthBot API, you will need the `endpoint` of your Azure HealthBot resource and a `credential`. The Azure HealthBot client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure HealthBot resource in the [Azure Portal][azure_portal].

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).

Expand All @@ -43,44 +45,42 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure Healthbot** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
You will also need to **register a new AAD application and grant access to Azure HealthBot** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

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).

Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:ReadmeSampleCreateClient_Node
import { HealthbotClient } from "@azure/arm-healthbot";
import { HealthBotClient } from "@azure/arm-healthbot";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new HealthbotClient(new DefaultAzureCredential(), subscriptionId);
const client = new HealthBotClient(new DefaultAzureCredential(), subscriptionId);
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { HealthbotClient } from "@azure/arm-healthbot";
import { HealthBotClient } from "@azure/arm-healthbot";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new HealthbotClient(credential, subscriptionId);
clientId: "<YOUR_CLIENT_ID>"
});
const client = new HealthBotClient(credential, subscriptionId);
```

### JavaScript Bundle

### JavaScript Bundle
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).

## Key concepts

### HealthbotClient
### HealthBotClient

`HealthbotClient` is the primary interface for developers using the Azure Healthbot client library. Explore the methods on this client object to understand the different features of the Azure Healthbot service that you can access.
`HealthBotClient` is the primary interface for developers using the Azure HealthBot client library. Explore the methods on this client object to understand the different features of the Azure HealthBot service that you can access.

## Troubleshooting

Expand All @@ -98,7 +98,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur

## Next steps

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.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthbot/arm-healthbot/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -108,8 +108,6 @@ If you'd like to contribute to this library, please read the [contributing guide

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)

[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
Expand Down
8 changes: 0 additions & 8 deletions sdk/healthbot/arm-healthbot/_meta.json

This file was deleted.

6 changes: 0 additions & 6 deletions sdk/healthbot/arm-healthbot/assets.json

This file was deleted.

14 changes: 14 additions & 0 deletions sdk/healthbot/arm-healthbot/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";

export default azsdkEslint.config([
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn",
},
},
]);
Loading