azure-mgmt-appconfiguration


Nameazure-mgmt-appconfiguration JSON
Version 4.0.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure App Configuration Management Client Library for Python
upload_time2024-10-30 08:33:37
maintainerNone
docs_urlNone
authorMicrosoft Corporation
requires_python>=3.8
licenseMIT License
keywords azure azure sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Microsoft Azure SDK for Python

This is the Microsoft Azure App Configuration Management Client Library.
This package has been tested with Python 3.8+.
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.8+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-appconfiguration
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of 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.appconfiguration import AppConfigurationManagementClient
import os

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

## Examples

Code samples for this package can be found at:
- [Search App Configuration 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

## 4.0.0 (2024-10-29)

### Breaking Changes

  - This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ingore this change.

## 3.1.0 (2024-10-21)

### Features Added

  - Added operation group SnapshotsOperations
  - Model ConfigurationStore has a new parameter data_plane_proxy
  - Model ConfigurationStoreUpdateParameters has a new parameter data_plane_proxy

## 3.0.0 (2023-03-27)

### Breaking Changes

  - Removed operation KeyValuesOperations.list_by_configuration_store

## 3.0.0b1 (2023-02-15)

### Breaking Changes

  - Removed operation KeyValuesOperations.list_by_configuration_store

## 2.2.0 (2022-08-29)

### Features Added

  - Added operation group ReplicasOperations

### Other Changes

  - Changed to multiapi package(please refer to https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/multiapi.md for more info)

## 2.1.0 (2022-06-08)

**Features**

  - Added operation ConfigurationStoresOperations.begin_purge_deleted
  - Added operation ConfigurationStoresOperations.get_deleted
  - Added operation ConfigurationStoresOperations.list_deleted
  - Added operation Operations.regional_check_name_availability
  - Model ConfigurationStore has a new parameter create_mode
  - Model ConfigurationStore has a new parameter enable_purge_protection
  - Model ConfigurationStore has a new parameter soft_delete_retention_in_days
  - Model ConfigurationStoreUpdateParameters has a new parameter enable_purge_protection

## 2.1.0b2 (2022-02-28)

**Features**

  - Model ConfigurationStoreUpdateParameters has a new parameter enable_purge_protection

## 2.1.0b1 (2022-02-16)

**Features**

  - Added operation ConfigurationStoresOperations.begin_purge_deleted
  - Added operation ConfigurationStoresOperations.get_deleted
  - Added operation ConfigurationStoresOperations.list_deleted
  - Added operation Operations.regional_check_name_availability
  - Model ConfigurationStore has a new parameter create_mode
  - Model ConfigurationStore has a new parameter enable_purge_protection
  - Model ConfigurationStore has a new parameter soft_delete_retention_in_days

## 2.0.0 (2021-06-21)

**Features**

  - Model OperationDefinition has a new parameter properties
  - Model OperationDefinition has a new parameter is_data_action
  - Model OperationDefinition has a new parameter origin
  - Model KeyValue has a new parameter id
  - Model KeyValue has a new parameter type
  - Model KeyValue has a new parameter name
  - Model ConfigurationStore has a new parameter system_data
  - Model ConfigurationStore has a new parameter disable_local_auth
  - Model ConfigurationStoreUpdateParameters has a new parameter disable_local_auth
  - Added operation group KeyValuesOperations

**Breaking changes**

  - Model Resource no longer has parameter location
  - Model Resource no longer has parameter tags
  - Removed operation ConfigurationStoresOperations.list_key_value

## 1.0.1 (2020-09-18)

**Bug fix**

  - Require azure-mgmt-core>=1.2.0 in setup.py

## 1.0.0 (2020-09-15)

**Features**

  - Model ConfigurationStoreUpdateParameters has a new parameter public_network_access

## 1.0.0b1 (2020-06-17)

This is beta preview version.

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

**General breaking changes**

- Credential system has been completly revamped:

  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
  - `credentials` parameter has been renamed `credential`

- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:

  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
  - For a complete set of
  supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

**General new features**

- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.

## 0.4.0 (2020-02-07)

**Features**

- Model ConfigurationStoreUpdateParameters has a new parameter encryption
- Model ConfigurationStore has a new parameter encryption
- Added operation group PrivateEndpointConnectionsOperations
- Added operation group PrivateLinkResourcesOperations

**Breaking changes**

- Model ConfigurationStoreUpdateParameters no longer has parameter properties

## 0.3.0 (2019-11-08)

**Features**

  - Model ConfigurationStore has a new parameter identity
  - Model ConfigurationStoreUpdateParameters has a new parameter
    identity
  - Model ConfigurationStoreUpdateParameters has a new parameter sku

**Breaking changes**

  - Operation ConfigurationStoresOperations.create has a new signature
  - Operation ConfigurationStoresOperations.update has a new signature
  - Model ConfigurationStore has a new required parameter sku

## 0.2.0 (2019-11-04)

**Features**

  - Added operation ConfigurationStoresOperations.list_key_value

## 0.1.0 (2019-06-17)

  - Initial Release

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-appconfiguration",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "azure, azure sdk",
    "author": "Microsoft Corporation",
    "author_email": "azpysdkhelp@microsoft.com",
    "download_url": "https://files.pythonhosted.org/packages/c7/19/c6fe12739eb9a2d309c19282ec5ea674734d3b7cd314397cae5bf9db685f/azure_mgmt_appconfiguration-4.0.0.tar.gz",
    "platform": null,
    "description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure App Configuration Management Client Library.\nThis package has been tested with Python 3.8+.\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.8+ 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-appconfiguration\npip install azure-identity\n```\n\n### Authentication\n\nBy default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of 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.appconfiguration import AppConfigurationManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = AppConfigurationManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search App Configuration 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## 4.0.0 (2024-10-29)\n\n### Breaking Changes\n\n  - This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ingore this change.\n\n## 3.1.0 (2024-10-21)\n\n### Features Added\n\n  - Added operation group SnapshotsOperations\n  - Model ConfigurationStore has a new parameter data_plane_proxy\n  - Model ConfigurationStoreUpdateParameters has a new parameter data_plane_proxy\n\n## 3.0.0 (2023-03-27)\n\n### Breaking Changes\n\n  - Removed operation KeyValuesOperations.list_by_configuration_store\n\n## 3.0.0b1 (2023-02-15)\n\n### Breaking Changes\n\n  - Removed operation KeyValuesOperations.list_by_configuration_store\n\n## 2.2.0 (2022-08-29)\n\n### Features Added\n\n  - Added operation group ReplicasOperations\n\n### Other Changes\n\n  - Changed to multiapi package(please refer to https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/multiapi.md for more info)\n\n## 2.1.0 (2022-06-08)\n\n**Features**\n\n  - Added operation ConfigurationStoresOperations.begin_purge_deleted\n  - Added operation ConfigurationStoresOperations.get_deleted\n  - Added operation ConfigurationStoresOperations.list_deleted\n  - Added operation Operations.regional_check_name_availability\n  - Model ConfigurationStore has a new parameter create_mode\n  - Model ConfigurationStore has a new parameter enable_purge_protection\n  - Model ConfigurationStore has a new parameter soft_delete_retention_in_days\n  - Model ConfigurationStoreUpdateParameters has a new parameter enable_purge_protection\n\n## 2.1.0b2 (2022-02-28)\n\n**Features**\n\n  - Model ConfigurationStoreUpdateParameters has a new parameter enable_purge_protection\n\n## 2.1.0b1 (2022-02-16)\n\n**Features**\n\n  - Added operation ConfigurationStoresOperations.begin_purge_deleted\n  - Added operation ConfigurationStoresOperations.get_deleted\n  - Added operation ConfigurationStoresOperations.list_deleted\n  - Added operation Operations.regional_check_name_availability\n  - Model ConfigurationStore has a new parameter create_mode\n  - Model ConfigurationStore has a new parameter enable_purge_protection\n  - Model ConfigurationStore has a new parameter soft_delete_retention_in_days\n\n## 2.0.0 (2021-06-21)\n\n**Features**\n\n  - Model OperationDefinition has a new parameter properties\n  - Model OperationDefinition has a new parameter is_data_action\n  - Model OperationDefinition has a new parameter origin\n  - Model KeyValue has a new parameter id\n  - Model KeyValue has a new parameter type\n  - Model KeyValue has a new parameter name\n  - Model ConfigurationStore has a new parameter system_data\n  - Model ConfigurationStore has a new parameter disable_local_auth\n  - Model ConfigurationStoreUpdateParameters has a new parameter disable_local_auth\n  - Added operation group KeyValuesOperations\n\n**Breaking changes**\n\n  - Model Resource no longer has parameter location\n  - Model Resource no longer has parameter tags\n  - Removed operation ConfigurationStoresOperations.list_key_value\n\n## 1.0.1 (2020-09-18)\n\n**Bug fix**\n\n  - Require azure-mgmt-core>=1.2.0 in setup.py\n\n## 1.0.0 (2020-09-15)\n\n**Features**\n\n  - Model ConfigurationStoreUpdateParameters has a new parameter public_network_access\n\n## 1.0.0b1 (2020-06-17)\n\nThis is beta preview version.\n\nThis version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).\n\n**General breaking changes**\n\n- Credential system has been completly revamped:\n\n  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/\n  - `credentials` parameter has been renamed `credential`\n\n- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of\n  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n- You can't import a `version` module anymore, use `__version__` instead\n- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.\n- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).\n- Most of the operation kwarg have changed. Some of the most noticeable:\n\n  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user\n  - For a complete set of\n  supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n\n**General new features**\n\n- Type annotations support using `typing`. SDKs are mypy ready.\n- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.\n- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.\n\n## 0.4.0 (2020-02-07)\n\n**Features**\n\n- Model ConfigurationStoreUpdateParameters has a new parameter encryption\n- Model ConfigurationStore has a new parameter encryption\n- Added operation group PrivateEndpointConnectionsOperations\n- Added operation group PrivateLinkResourcesOperations\n\n**Breaking changes**\n\n- Model ConfigurationStoreUpdateParameters no longer has parameter properties\n\n## 0.3.0 (2019-11-08)\n\n**Features**\n\n  - Model ConfigurationStore has a new parameter identity\n  - Model ConfigurationStoreUpdateParameters has a new parameter\n    identity\n  - Model ConfigurationStoreUpdateParameters has a new parameter sku\n\n**Breaking changes**\n\n  - Operation ConfigurationStoresOperations.create has a new signature\n  - Operation ConfigurationStoresOperations.update has a new signature\n  - Model ConfigurationStore has a new required parameter sku\n\n## 0.2.0 (2019-11-04)\n\n**Features**\n\n  - Added operation ConfigurationStoresOperations.list_key_value\n\n## 0.1.0 (2019-06-17)\n\n  - Initial Release\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure App Configuration Management Client Library for Python",
    "version": "4.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": "766f6e7ef3adfc46c0def1e1ad1e81961db99b6954621b32b83ff56f5f08102f",
                "md5": "9556ed2f70323927e5a944e7dce0fc11",
                "sha256": "25c679d627410adec7267580cbb9327ef46a678994a7d9cc09646d6f2a780cb2"
            },
            "downloads": -1,
            "filename": "azure_mgmt_appconfiguration-4.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9556ed2f70323927e5a944e7dce0fc11",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 102515,
            "upload_time": "2024-10-30T08:33:38",
            "upload_time_iso_8601": "2024-10-30T08:33:38.715260Z",
            "url": "https://files.pythonhosted.org/packages/76/6f/6e7ef3adfc46c0def1e1ad1e81961db99b6954621b32b83ff56f5f08102f/azure_mgmt_appconfiguration-4.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c719c6fe12739eb9a2d309c19282ec5ea674734d3b7cd314397cae5bf9db685f",
                "md5": "c01f7d56ecea79dc753d03c2a0cec65a",
                "sha256": "c7d22d47c86242b8f7d752f1dc18288da4ac41c2f69740b97dee80239f0f0cee"
            },
            "downloads": -1,
            "filename": "azure_mgmt_appconfiguration-4.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c01f7d56ecea79dc753d03c2a0cec65a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 74445,
            "upload_time": "2024-10-30T08:33:37",
            "upload_time_iso_8601": "2024-10-30T08:33:37.126505Z",
            "url": "https://files.pythonhosted.org/packages/c7/19/c6fe12739eb9a2d309c19282ec5ea674734d3b7cd314397cae5bf9db685f/azure_mgmt_appconfiguration-4.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-30 08:33:37",
    "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-appconfiguration"
}
        
Elapsed time: 0.62813s