# Microsoft Azure SDK for Python
This is the Microsoft Azure Hardwaresecuritymodules Management Client Library.
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_
## Getting started
### Prerequisites
- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)
### Install the package
```bash
pip install azure-mgmt-hardwaresecuritymodules
pip install azure-identity
```
### 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.hardwaresecuritymodules import HardwareSecurityModulesMgmtClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = HardwareSecurityModulesMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```
## Examples
Code samples for this package can be found at:
- [Search Hardwaresecuritymodules 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.
# Release History
## 1.0.0 (2025-07-02)
### Features Added
- Enum `ProvisioningState` added member `UPDATING`
- Model `CloudHsmClusterBackupStatusOperations` added method `begin_get`
- Model `CloudHsmClusterRestoreStatusOperations` added method `begin_get`
### Breaking Changes
- This version introduces new hybrid models which have dual dictionary and model nature. And please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
- Deleted or renamed model `CloudHsmClusterResource`
- Deleted or renamed model `IdentityType`
- Deleted or renamed model `OutboundEnvironmentEndpointCollection`
- Deleted or renamed method `CloudHsmClusterBackupStatusOperations.get`
- Deleted or renamed method `CloudHsmClusterRestoreStatusOperations.get`
- Method `CloudHsmClustersOperations.begin_create_or_update` inserted a `positional_or_keyword` parameter `body`
- Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `location` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `identity` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `sku` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `properties` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_update` inserted a `positional_or_keyword` parameter `body`
- Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `identity` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.list_by_resource_group` changed its parameter `skiptoken` from `positional_or_keyword` to `keyword_only`
- Method `CloudHsmClustersOperations.list_by_subscription` changed its parameter `skiptoken` from `positional_or_keyword` to `keyword_only`
- Method `DedicatedHsmOperations.begin_update` inserted a `positional_or_keyword` parameter `parameters`
- Method `DedicatedHsmOperations.begin_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`
## 1.0.0b2 (2025-02-06)
### Features Added
- Client `HardwareSecurityModulesMgmtClient` added operation group `cloud_hsm_cluster_backup_status`
- Client `HardwareSecurityModulesMgmtClient` added operation group `cloud_hsm_cluster_restore_status`
- Model `ApiEntityReference` added property `resource_id`
- Model `CloudHsmClusterProperties` added property `activation_state`
- Model `NetworkInterface` added property `resource_id`
- Model `PrivateLinkResourceListResult` added property `next_link`
- Added enum `ActionType`
- Added enum `ActivationState`
- Added enum `AutoGeneratedDomainNameLabelScope`
- Added model `BackupRequestProperties`
- Added model `BackupRestoreBaseResultProperties`
- Added enum `BackupRestoreOperationStatus`
- Added model `BackupRestoreRequestBaseProperties`
- Added model `BackupResult`
- Added model `BackupResultProperties`
- Added model `ErrorAdditionalInfo`
- Added model `ErrorDetail`
- Added model `ErrorResponse`
- Added model `Operation`
- Added model `OperationDisplay`
- Added model `OperationListResult`
- Added enum `Origin`
- Added enum `PublicNetworkAccess`
- Added model `RestoreRequestProperties`
- Added model `RestoreResult`
- Operation group `CloudHsmClustersOperations` added method `begin_backup`
- Operation group `CloudHsmClustersOperations` added method `begin_restore`
- Operation group `CloudHsmClustersOperations` added method `begin_validate_backup_properties`
- Operation group `CloudHsmClustersOperations` added method `begin_validate_restore_properties`
- Added operation group `CloudHsmClusterBackupStatusOperations`
- Added operation group `CloudHsmClusterRestoreStatusOperations`
### Breaking Changes
- Model `ApiEntityReference` deleted or renamed its instance variable `id`
- Model `CloudHsmClusterPatchParameters` deleted or renamed its instance variable `sku`
- Model `CloudHsmClusterPatchParameters` deleted or renamed its instance variable `properties`
- Model `CloudHsmClusterProperties` deleted or renamed its instance variable `security_domain`
- Model `CloudHsmClusterProperties` deleted or renamed its instance variable `restore_properties`
- Model `CloudHsmClusterProperties` deleted or renamed its instance variable `backup_properties`
- Model `NetworkInterface` deleted or renamed its instance variable `id`
- Parameter `sku` of model `DedicatedHsm` is now required
- Deleted or renamed model `BackupProperties`
- Deleted or renamed model `CHsmError`
- Deleted or renamed model `CloudHsmClusterError`
- Deleted or renamed model `CloudHsmClusterPatchParametersProperties`
- Deleted or renamed model `CloudHsmClusterSecurityDomainProperties`
- Deleted or renamed model `DedicatedHsmOperation`
- Deleted or renamed model `DedicatedHsmOperationDisplay`
- Deleted or renamed model `DedicatedHsmResource`
- Deleted or renamed model `RestoreProperties`
- Deleted or renamed model `SystemDataAutoGenerated`
- Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `sku` of kind `positional_or_keyword`
- Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `properties` of kind `positional_or_keyword`
## 1.0.0b1 (2024-01-26)
* Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-hardwaresecuritymodules",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "azure, azure sdk",
"author": "Microsoft Corporation",
"author_email": "azpysdkhelp@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/8e/e8/8a993bfd27521f4db46a3b9dd04f0f69c28db25a949e59d6c0e455a97c24/azure_mgmt_hardwaresecuritymodules-1.0.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Hardwaresecuritymodules Management Client Library.\nThis package has been tested with Python 3.9+.\nFor a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).\n\n## _Disclaimer_\n\n_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_\n\n## Getting started\n\n### Prerequisites\n\n- Python 3.9+ is required to use this package.\n- [Azure subscription](https://azure.microsoft.com/free/)\n\n### Install the package\n\n```bash\npip install azure-mgmt-hardwaresecuritymodules\npip install azure-identity\n```\n\n### Authentication\n\nBy default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.\n\n- `AZURE_CLIENT_ID` for Azure client ID.\n- `AZURE_TENANT_ID` for Azure tenant ID.\n- `AZURE_CLIENT_SECRET` for Azure client secret.\n\nIn addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.\n\nWith above configuration, client can be authenticated by following code:\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom azure.mgmt.hardwaresecuritymodules import HardwareSecurityModulesMgmtClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = HardwareSecurityModulesMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Hardwaresecuritymodules Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com\n- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)\n\n\n## Troubleshooting\n\n## Next steps\n\n## Provide Feedback\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n[Issues](https://github.com/Azure/azure-sdk-for-python/issues)\nsection of the project. \n\n\n# Release History\n\n## 1.0.0 (2025-07-02)\n\n### Features Added\n\n - Enum `ProvisioningState` added member `UPDATING`\n - Model `CloudHsmClusterBackupStatusOperations` added method `begin_get`\n - Model `CloudHsmClusterRestoreStatusOperations` added method `begin_get`\n\n### Breaking Changes\n\n - This version introduces new hybrid models which have dual dictionary and model nature. And please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration. \n - Deleted or renamed model `CloudHsmClusterResource`\n - Deleted or renamed model `IdentityType`\n - Deleted or renamed model `OutboundEnvironmentEndpointCollection`\n - Deleted or renamed method `CloudHsmClusterBackupStatusOperations.get`\n - Deleted or renamed method `CloudHsmClusterRestoreStatusOperations.get`\n - Method `CloudHsmClustersOperations.begin_create_or_update` inserted a `positional_or_keyword` parameter `body`\n - Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `location` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `identity` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `sku` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_create_or_update` deleted or renamed its parameter `properties` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_update` inserted a `positional_or_keyword` parameter `body`\n - Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `identity` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.list_by_resource_group` changed its parameter `skiptoken` from `positional_or_keyword` to `keyword_only`\n - Method `CloudHsmClustersOperations.list_by_subscription` changed its parameter `skiptoken` from `positional_or_keyword` to `keyword_only`\n - Method `DedicatedHsmOperations.begin_update` inserted a `positional_or_keyword` parameter `parameters`\n - Method `DedicatedHsmOperations.begin_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`\n\n## 1.0.0b2 (2025-02-06)\n\n### Features Added\n\n - Client `HardwareSecurityModulesMgmtClient` added operation group `cloud_hsm_cluster_backup_status`\n - Client `HardwareSecurityModulesMgmtClient` added operation group `cloud_hsm_cluster_restore_status`\n - Model `ApiEntityReference` added property `resource_id`\n - Model `CloudHsmClusterProperties` added property `activation_state`\n - Model `NetworkInterface` added property `resource_id`\n - Model `PrivateLinkResourceListResult` added property `next_link`\n - Added enum `ActionType`\n - Added enum `ActivationState`\n - Added enum `AutoGeneratedDomainNameLabelScope`\n - Added model `BackupRequestProperties`\n - Added model `BackupRestoreBaseResultProperties`\n - Added enum `BackupRestoreOperationStatus`\n - Added model `BackupRestoreRequestBaseProperties`\n - Added model `BackupResult`\n - Added model `BackupResultProperties`\n - Added model `ErrorAdditionalInfo`\n - Added model `ErrorDetail`\n - Added model `ErrorResponse`\n - Added model `Operation`\n - Added model `OperationDisplay`\n - Added model `OperationListResult`\n - Added enum `Origin`\n - Added enum `PublicNetworkAccess`\n - Added model `RestoreRequestProperties`\n - Added model `RestoreResult`\n - Operation group `CloudHsmClustersOperations` added method `begin_backup`\n - Operation group `CloudHsmClustersOperations` added method `begin_restore`\n - Operation group `CloudHsmClustersOperations` added method `begin_validate_backup_properties`\n - Operation group `CloudHsmClustersOperations` added method `begin_validate_restore_properties`\n - Added operation group `CloudHsmClusterBackupStatusOperations`\n - Added operation group `CloudHsmClusterRestoreStatusOperations`\n\n### Breaking Changes\n\n - Model `ApiEntityReference` deleted or renamed its instance variable `id`\n - Model `CloudHsmClusterPatchParameters` deleted or renamed its instance variable `sku`\n - Model `CloudHsmClusterPatchParameters` deleted or renamed its instance variable `properties`\n - Model `CloudHsmClusterProperties` deleted or renamed its instance variable `security_domain`\n - Model `CloudHsmClusterProperties` deleted or renamed its instance variable `restore_properties`\n - Model `CloudHsmClusterProperties` deleted or renamed its instance variable `backup_properties`\n - Model `NetworkInterface` deleted or renamed its instance variable `id`\n - Parameter `sku` of model `DedicatedHsm` is now required\n - Deleted or renamed model `BackupProperties`\n - Deleted or renamed model `CHsmError`\n - Deleted or renamed model `CloudHsmClusterError`\n - Deleted or renamed model `CloudHsmClusterPatchParametersProperties`\n - Deleted or renamed model `CloudHsmClusterSecurityDomainProperties`\n - Deleted or renamed model `DedicatedHsmOperation`\n - Deleted or renamed model `DedicatedHsmOperationDisplay`\n - Deleted or renamed model `DedicatedHsmResource`\n - Deleted or renamed model `RestoreProperties`\n - Deleted or renamed model `SystemDataAutoGenerated`\n - Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `sku` of kind `positional_or_keyword`\n - Method `CloudHsmClustersOperations.begin_update` deleted or renamed its parameter `properties` of kind `positional_or_keyword`\n\n## 1.0.0b1 (2024-01-26)\n\n* Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Hardwaresecuritymodules Management Client Library for Python",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "399a7aee9f0e05c28090a8725cd7d91eef7211df2a0c30fc90b4fcc69d7b9a09",
"md5": "b9d8705304fe4c0f75c3cbee091ebaf1",
"sha256": "7a46f8b96f42ebfe04cb85e4b94a9f6810229ccc3086a059f8757ebe6cd16b96"
},
"downloads": -1,
"filename": "azure_mgmt_hardwaresecuritymodules-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9d8705304fe4c0f75c3cbee091ebaf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 80228,
"upload_time": "2025-07-17T14:32:46",
"upload_time_iso_8601": "2025-07-17T14:32:46.934334Z",
"url": "https://files.pythonhosted.org/packages/39/9a/7aee9f0e05c28090a8725cd7d91eef7211df2a0c30fc90b4fcc69d7b9a09/azure_mgmt_hardwaresecuritymodules-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8ee88a993bfd27521f4db46a3b9dd04f0f69c28db25a949e59d6c0e455a97c24",
"md5": "3fe0c853d3f80ff6948f9972f15b62d7",
"sha256": "2d3a85bcd9242d56a3d6a9d6b5ab63b28fd33ca2cb7cfb9a2555ce7e553ee4b9"
},
"downloads": -1,
"filename": "azure_mgmt_hardwaresecuritymodules-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3fe0c853d3f80ff6948f9972f15b62d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 73412,
"upload_time": "2025-07-17T14:32:45",
"upload_time_iso_8601": "2025-07-17T14:32:45.984864Z",
"url": "https://files.pythonhosted.org/packages/8e/e8/8a993bfd27521f4db46a3b9dd04f0f69c28db25a949e59d6c0e455a97c24/azure_mgmt_hardwaresecuritymodules-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 14:32:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-mgmt-hardwaresecuritymodules"
}
JSON
