Skip to content
Draft
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
20 changes: 20 additions & 0 deletions sdk/healthbot/azure-mgmt-healthbot/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Release History

## 1.0.0 (2025-12-30)

### Features Added

- Model `HealthBotProperties` added property `access_control_method`
- Enum `SkuName` added member `C1`
- Enum `SkuName` added member `PES`
- Added enum `CreatedByType`
- Model `BotsOperations` added method `begin_update`

### Breaking Changes

- Deleted or renamed client `HealthBotMgmtClient`
- Deleted or renamed enum value `SkuName.S1`
- Deleted or renamed model `AvailableOperations`
- Deleted or renamed model `BotResponseList`
- Deleted or renamed model `IdentityType`
- Deleted or renamed model `ValidationResult`
- Deleted or renamed method `BotsOperations.update`

## 1.0.0b2 (2022-10-28)

### Features Added
Expand Down
9 changes: 4 additions & 5 deletions sdk/healthbot/azure-mgmt-healthbot/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
include _meta.json
recursive-include tests *.py *.json
recursive-include samples *.py *.md
include *.md
include azure/__init__.py
include azure/mgmt/__init__.py
include LICENSE
include azure/mgmt/healthbot/py.typed
recursive-include tests *.py
recursive-include samples *.py *.md
include azure/__init__.py
include azure/mgmt/__init__.py
55 changes: 44 additions & 11 deletions sdk/healthbot/azure-mgmt-healthbot/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,61 @@
# Microsoft Azure SDK for Python

This is the Microsoft Azure Health Bot Management Client Library.
This package has been tested with Python 3.7+.
This package has been tested with Python 3.9+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

# Usage
## Getting started

### Prerequisites

To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)

For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/)
Code samples for this package can be found at [Health Bot Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
Additional code samples for different Azure services are available at [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

# Provide Feedback
```bash
pip install azure-mgmt-healthbot
pip install azure-identity
```

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.healthbot import HealthBotMgmtClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = HealthBotMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search Health Bot Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
11 changes: 0 additions & 11 deletions sdk/healthbot/azure-mgmt-healthbot/_meta.json

This file was deleted.

7 changes: 7 additions & 0 deletions sdk/healthbot/azure-mgmt-healthbot/_metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"apiVersion": "2025-11-01",
"commit": "16c5a93d4e3e6d4cec95c969991fd65cb3458327",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"typespec_src": "specification/healthbot/HealthBot.Management",
"emitterVersion": "0.56.1"
}
43 changes: 43 additions & 0 deletions sdk/healthbot/azure-mgmt-healthbot/apiview-properties.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"CrossLanguagePackageId": "Microsoft.HealthBot",
"CrossLanguageDefinitionId": {
"azure.mgmt.healthbot.models.Error": "Microsoft.HealthBot.Error",
"azure.mgmt.healthbot.models.ErrorAdditionalInfo": "Microsoft.HealthBot.ErrorAdditionalInfo",
"azure.mgmt.healthbot.models.ErrorError": "Microsoft.HealthBot.ErrorDetail",
"azure.mgmt.healthbot.models.Resource": "Azure.ResourceManager.CommonTypes.Resource",
"azure.mgmt.healthbot.models.TrackedResource": "Azure.ResourceManager.CommonTypes.TrackedResource",
"azure.mgmt.healthbot.models.HealthBot": "Microsoft.HealthBot.HealthBot",
"azure.mgmt.healthbot.models.HealthBotKey": "Microsoft.HealthBot.HealthBotKey",
"azure.mgmt.healthbot.models.HealthBotKeysResponse": "Microsoft.HealthBot.HealthBotKeysResponse",
"azure.mgmt.healthbot.models.HealthBotProperties": "Microsoft.HealthBot.HealthBotProperties",
"azure.mgmt.healthbot.models.HealthBotUpdateParameters": "Microsoft.HealthBot.HealthBotUpdateParameters",
"azure.mgmt.healthbot.models.Identity": "Microsoft.HealthBot.Identity",
"azure.mgmt.healthbot.models.KeyVaultProperties": "Microsoft.HealthBot.KeyVaultProperties",
"azure.mgmt.healthbot.models.OperationDetail": "Microsoft.HealthBot.OperationDetail",
"azure.mgmt.healthbot.models.OperationDisplay": "Microsoft.HealthBot.OperationDisplay",
"azure.mgmt.healthbot.models.Sku": "Microsoft.HealthBot.Sku",
"azure.mgmt.healthbot.models.SystemData": "Azure.ResourceManager.CommonTypes.SystemData",
"azure.mgmt.healthbot.models.UserAssignedIdentity": "Microsoft.HealthBot.UserAssignedIdentity",
"azure.mgmt.healthbot.models.CreatedByType": "Azure.ResourceManager.CommonTypes.createdByType",
"azure.mgmt.healthbot.models.SkuName": "Microsoft.HealthBot.SkuName",
"azure.mgmt.healthbot.models.ResourceIdentityType": "Microsoft.HealthBot.ResourceIdentityType",
"azure.mgmt.healthbot.operations.Operations.list": "Azure.ResourceManager.Legacy.Operations.list",
"azure.mgmt.healthbot.aio.operations.Operations.list": "Azure.ResourceManager.Legacy.Operations.list",
"azure.mgmt.healthbot.operations.BotsOperations.get": "Microsoft.HealthBot.HealthBots.get",
"azure.mgmt.healthbot.aio.operations.BotsOperations.get": "Microsoft.HealthBot.HealthBots.get",
"azure.mgmt.healthbot.operations.BotsOperations.begin_create": "Microsoft.HealthBot.HealthBots.create",
"azure.mgmt.healthbot.aio.operations.BotsOperations.begin_create": "Microsoft.HealthBot.HealthBots.create",
"azure.mgmt.healthbot.operations.BotsOperations.begin_update": "Microsoft.HealthBot.HealthBots.update",
"azure.mgmt.healthbot.aio.operations.BotsOperations.begin_update": "Microsoft.HealthBot.HealthBots.update",
"azure.mgmt.healthbot.operations.BotsOperations.begin_delete": "Microsoft.HealthBot.HealthBots.delete",
"azure.mgmt.healthbot.aio.operations.BotsOperations.begin_delete": "Microsoft.HealthBot.HealthBots.delete",
"azure.mgmt.healthbot.operations.BotsOperations.list_by_resource_group": "Microsoft.HealthBot.HealthBots.listByResourceGroup",
"azure.mgmt.healthbot.aio.operations.BotsOperations.list_by_resource_group": "Microsoft.HealthBot.HealthBots.listByResourceGroup",
"azure.mgmt.healthbot.operations.BotsOperations.list": "Microsoft.HealthBot.HealthBots.list",
"azure.mgmt.healthbot.aio.operations.BotsOperations.list": "Microsoft.HealthBot.HealthBots.list",
"azure.mgmt.healthbot.operations.BotsOperations.list_secrets": "Microsoft.HealthBot.HealthBots.listSecrets",
"azure.mgmt.healthbot.aio.operations.BotsOperations.list_secrets": "Microsoft.HealthBot.HealthBots.listSecrets",
"azure.mgmt.healthbot.operations.BotsOperations.regenerate_api_jwt_secret": "Microsoft.HealthBot.HealthBots.regenerateApiJwtSecret",
"azure.mgmt.healthbot.aio.operations.BotsOperations.regenerate_api_jwt_secret": "Microsoft.HealthBot.HealthBots.regenerateApiJwtSecret"
}
}
2 changes: 1 addition & 1 deletion sdk/healthbot/azure-mgmt-healthbot/azure/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,31 @@
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Code generated by Microsoft (R) Python Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=wrong-import-position

from ._health_bot_mgmt_client import HealthBotMgmtClient
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from ._patch import * # pylint: disable=unused-wildcard-import

from ._client import HealthBotClient # type: ignore
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import
from ._patch import *
except ImportError:
_patch_all = []
from ._patch import patch_sdk as _patch_sdk

__all__ = [
"HealthBotMgmtClient",
"HealthBotClient",
]
__all__.extend([p for p in _patch_all if p not in __all__])
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore

_patch_sdk()
138 changes: 138 additions & 0 deletions sdk/healthbot/azure-mgmt-healthbot/azure/mgmt/healthbot/_client.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) Python Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from copy import deepcopy
from typing import Any, Optional, TYPE_CHECKING, cast
from typing_extensions import Self

from azure.core.pipeline import policies
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.settings import settings
from azure.mgmt.core import ARMPipelineClient
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
from azure.mgmt.core.tools import get_arm_endpoints

from ._configuration import HealthBotClientConfiguration
from ._utils.serialization import Deserializer, Serializer
from .operations import BotsOperations, Operations

if TYPE_CHECKING:
from azure.core import AzureClouds
from azure.core.credentials import TokenCredential


class HealthBotClient:
"""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.

:ivar operations: Operations operations
:vartype operations: azure.mgmt.healthbot.operations.Operations
:ivar bots: BotsOperations operations
:vartype bots: azure.mgmt.healthbot.operations.BotsOperations
:param credential: Credential used to authenticate requests to the service. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:param base_url: Service host. Default value is None.
:type base_url: str
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: The API version to use for this operation. Default value is "2025-11-01".
Note that overriding this default value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
"""

def __init__(
self,
credential: "TokenCredential",
subscription_id: str,
base_url: Optional[str] = None,
*,
cloud_setting: Optional["AzureClouds"] = None,
**kwargs: Any
) -> None:
_endpoint = "{endpoint}"
_cloud = cloud_setting or settings.current.azure_cloud # type: ignore
_endpoints = get_arm_endpoints(_cloud)
if not base_url:
base_url = _endpoints["resource_manager"]
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
self._config = HealthBotClientConfiguration(
credential=credential,
subscription_id=subscription_id,
base_url=cast(str, base_url),
cloud_setting=cloud_setting,
credential_scopes=credential_scopes,
**kwargs
)

_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
policies.RequestIdPolicy(**kwargs),
self._config.headers_policy,
self._config.user_agent_policy,
self._config.proxy_policy,
policies.ContentDecodePolicy(**kwargs),
ARMAutoResourceProviderRegistrationPolicy(),
self._config.redirect_policy,
self._config.retry_policy,
self._config.authentication_policy,
self._config.custom_hook_policy,
self._config.logging_policy,
policies.DistributedTracingPolicy(**kwargs),
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, _endpoint), policies=_policies, **kwargs)

self._serialize = Serializer()
self._deserialize = Deserializer()
self._serialize.client_side_validation = False
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
self.bots = BotsOperations(self._client, self._config, self._serialize, self._deserialize)

def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
"""Runs the network request through the client's chained policies.

>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

:param request: The network request you want to make. Required.
:type request: ~azure.core.rest.HttpRequest
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
:return: The response of your network call. Does not do error handling on your response.
:rtype: ~azure.core.rest.HttpResponse
"""

request_copy = deepcopy(request)
path_format_arguments = {
"endpoint": self._serialize.url("self._config.base_url", self._config.base_url, "str", skip_quote=True),
}

request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore

def close(self) -> None:
self._client.close()

def __enter__(self) -> Self:
self._client.__enter__()
return self

def __exit__(self, *exc_details: Any) -> None:
self._client.__exit__(*exc_details)
Loading
Loading