azure-mgmt-frontdoor


Nameazure-mgmt-frontdoor JSON
Version 1.2.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure Front Door Service Client Library for Python
upload_time2024-04-15 08:30:31
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 Front Door Service 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-frontdoor
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.frontdoor import FrontDoorManagementClient
import os

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

## Examples

Code samples for this package can be found at:
- [Search Front Door Service](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.2.0 (2024-04-15)

### Features Added

  - Model CustomRule has a new parameter group_by
  - Model PolicySettings has a new parameter javascript_challenge_expiration_in_minutes
  - Model PolicySettings has a new parameter scrubbing_rules
  - Model PolicySettings has a new parameter state

## 1.1.0 (2023-05-19)

### Features Added

  - Added operation PoliciesOperations.begin_update
  - Added operation PoliciesOperations.list_by_subscription
  - Model FrontDoor has a new parameter extended_properties
  - Model FrontDoorProperties has a new parameter extended_properties

## 1.1.0b1 (2022-11-22)

### Features Added

  - Added operation PoliciesOperations.begin_update
  - Model FrontDoor has a new parameter extended_properties
  - Model FrontDoorProperties has a new parameter extended_properties

## 1.0.1 (2022-03-29)

**Fixes**

- Fix duplicated description in annotation

## 1.0.0 (2021-03-26)

 - GA release

## 1.0.0b1 (2021-02-09)

This is beta preview version.
For detailed changelog please refer to equivalent stable version 10.2.0 (https://pypi.org/project/azure-mgmt-network/10.2.0/)

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.3.0 (2019-10-11)

  - Fixed new network experiment SDK structure

## 0.2.0 (2019-10-09)

**Features**

  - Model RoutingRule has a new parameter route_configuration
  - Model PolicySettings has a new parameter redirect_url
  - Model PolicySettings has a new parameter
    custom_block_response_body
  - Model PolicySettings has a new parameter
    custom_block_response_status_code
  - Model HealthProbeSettingsModel has a new parameter enabled_state
  - Model HealthProbeSettingsModel has a new parameter
    health_probe_method
  - Model HealthProbeSettingsUpdateParameters has a new parameter
    enabled_state
  - Model HealthProbeSettingsUpdateParameters has a new parameter
    health_probe_method
  - Model FrontDoorUpdateParameters has a new parameter
    backend_pools_settings
  - Model CustomRule has a new parameter enabled_state
  - Model FrontDoor has a new parameter backend_pools_settings
  - Model RoutingRuleUpdateParameters has a new parameter
    route_configuration
  - Added operation group ProfilesOperations
  - Added operation group ExperimentsOperations
  - Added operation group PreconfiguredEndpointsOperations
  - Added operation group ManagedRuleSetsOperations
  - Added operation group FrontDoorManagementClientOperationsMixin

**Breaking changes**

  - Parameter certificate_source of model CustomHttpsConfiguration is
    now required
  - Parameter protocol_type of model CustomHttpsConfiguration is now
    required
  - Model RoutingRule no longer has parameter custom_forwarding_path
  - Model RoutingRule no longer has parameter forwarding_protocol
  - Model RoutingRule no longer has parameter cache_configuration
  - Model RoutingRule no longer has parameter backend_pool
  - Model CustomRule no longer has parameter etag
  - Model CustomRule no longer has parameter transforms
  - Model CustomHttpsConfiguration has a new required parameter
    minimum_tls_version
  - Model RoutingRuleUpdateParameters no longer has parameter
    custom_forwarding_path
  - Model RoutingRuleUpdateParameters no longer has parameter
    forwarding_protocol
  - Model RoutingRuleUpdateParameters no longer has parameter
    cache_configuration
  - Model RoutingRuleUpdateParameters no longer has parameter
    backend_pool
  - Removed operation FrontendEndpointsOperations.delete
  - Removed operation FrontendEndpointsOperations.create_or_update
  - Model ManagedRuleSet has a new signature
  - Removed operation group LoadBalancingSettingsOperations
  - Removed operation group RoutingRulesOperations
  - Removed operation group HealthProbeSettingsOperations
  - Removed operation group BackendPoolsOperations

## 0.1.0 (2019-03-11)

  - Initial Release

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-frontdoor",
    "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/e0/8b/4673bde71ed5daa29c6850ef6e456cdb7274816ca09d7ec0c419092bf7b0/azure_mgmt_frontdoor-1.2.0.tar.gz",
    "platform": null,
    "description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Front Door Service 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-frontdoor\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.frontdoor import FrontDoorManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = FrontDoorManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Front Door Service](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.2.0 (2024-04-15)\n\n### Features Added\n\n  - Model CustomRule has a new parameter group_by\n  - Model PolicySettings has a new parameter javascript_challenge_expiration_in_minutes\n  - Model PolicySettings has a new parameter scrubbing_rules\n  - Model PolicySettings has a new parameter state\n\n## 1.1.0 (2023-05-19)\n\n### Features Added\n\n  - Added operation PoliciesOperations.begin_update\n  - Added operation PoliciesOperations.list_by_subscription\n  - Model FrontDoor has a new parameter extended_properties\n  - Model FrontDoorProperties has a new parameter extended_properties\n\n## 1.1.0b1 (2022-11-22)\n\n### Features Added\n\n  - Added operation PoliciesOperations.begin_update\n  - Model FrontDoor has a new parameter extended_properties\n  - Model FrontDoorProperties has a new parameter extended_properties\n\n## 1.0.1 (2022-03-29)\n\n**Fixes**\n\n- Fix duplicated description in annotation\n\n## 1.0.0 (2021-03-26)\n\n - GA release\n\n## 1.0.0b1 (2021-02-09)\n\nThis is beta preview version.\nFor detailed changelog please refer to equivalent stable version 10.2.0 (https://pypi.org/project/azure-mgmt-network/10.2.0/)\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\n## 0.3.0 (2019-10-11)\n\n  - Fixed new network experiment SDK structure\n\n## 0.2.0 (2019-10-09)\n\n**Features**\n\n  - Model RoutingRule has a new parameter route_configuration\n  - Model PolicySettings has a new parameter redirect_url\n  - Model PolicySettings has a new parameter\n    custom_block_response_body\n  - Model PolicySettings has a new parameter\n    custom_block_response_status_code\n  - Model HealthProbeSettingsModel has a new parameter enabled_state\n  - Model HealthProbeSettingsModel has a new parameter\n    health_probe_method\n  - Model HealthProbeSettingsUpdateParameters has a new parameter\n    enabled_state\n  - Model HealthProbeSettingsUpdateParameters has a new parameter\n    health_probe_method\n  - Model FrontDoorUpdateParameters has a new parameter\n    backend_pools_settings\n  - Model CustomRule has a new parameter enabled_state\n  - Model FrontDoor has a new parameter backend_pools_settings\n  - Model RoutingRuleUpdateParameters has a new parameter\n    route_configuration\n  - Added operation group ProfilesOperations\n  - Added operation group ExperimentsOperations\n  - Added operation group PreconfiguredEndpointsOperations\n  - Added operation group ManagedRuleSetsOperations\n  - Added operation group FrontDoorManagementClientOperationsMixin\n\n**Breaking changes**\n\n  - Parameter certificate_source of model CustomHttpsConfiguration is\n    now required\n  - Parameter protocol_type of model CustomHttpsConfiguration is now\n    required\n  - Model RoutingRule no longer has parameter custom_forwarding_path\n  - Model RoutingRule no longer has parameter forwarding_protocol\n  - Model RoutingRule no longer has parameter cache_configuration\n  - Model RoutingRule no longer has parameter backend_pool\n  - Model CustomRule no longer has parameter etag\n  - Model CustomRule no longer has parameter transforms\n  - Model CustomHttpsConfiguration has a new required parameter\n    minimum_tls_version\n  - Model RoutingRuleUpdateParameters no longer has parameter\n    custom_forwarding_path\n  - Model RoutingRuleUpdateParameters no longer has parameter\n    forwarding_protocol\n  - Model RoutingRuleUpdateParameters no longer has parameter\n    cache_configuration\n  - Model RoutingRuleUpdateParameters no longer has parameter\n    backend_pool\n  - Removed operation FrontendEndpointsOperations.delete\n  - Removed operation FrontendEndpointsOperations.create_or_update\n  - Model ManagedRuleSet has a new signature\n  - Removed operation group LoadBalancingSettingsOperations\n  - Removed operation group RoutingRulesOperations\n  - Removed operation group HealthProbeSettingsOperations\n  - Removed operation group BackendPoolsOperations\n\n## 0.1.0 (2019-03-11)\n\n  - Initial Release\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure Front Door Service Client Library for Python",
    "version": "1.2.0",
    "project_urls": {
        "Homepage": "https://github.com/Azure/azure-sdk-for-python"
    },
    "split_keywords": [
        "azure",
        " azure sdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c0c48ea5cfd2452d98b502703e8a07b49054168d85b320f16e24130c4b22ca7c",
                "md5": "d8594088adc46361533c9221a1f3478d",
                "sha256": "22f1f60a0c875d8a4e71cebcf6557a3c67249b86431a7954fc1fa3fb9fedd2be"
            },
            "downloads": -1,
            "filename": "azure_mgmt_frontdoor-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d8594088adc46361533c9221a1f3478d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 143129,
            "upload_time": "2024-04-15T08:30:33",
            "upload_time_iso_8601": "2024-04-15T08:30:33.057477Z",
            "url": "https://files.pythonhosted.org/packages/c0/c4/8ea5cfd2452d98b502703e8a07b49054168d85b320f16e24130c4b22ca7c/azure_mgmt_frontdoor-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e08b4673bde71ed5daa29c6850ef6e456cdb7274816ca09d7ec0c419092bf7b0",
                "md5": "ed293452b323db00839b56e5c9942fe0",
                "sha256": "0d257fbc813aaf4c203cba477d3e0e0ea368c737823c894092c9ac9c4b84c528"
            },
            "downloads": -1,
            "filename": "azure_mgmt_frontdoor-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ed293452b323db00839b56e5c9942fe0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 98142,
            "upload_time": "2024-04-15T08:30:31",
            "upload_time_iso_8601": "2024-04-15T08:30:31.075243Z",
            "url": "https://files.pythonhosted.org/packages/e0/8b/4673bde71ed5daa29c6850ef6e456cdb7274816ca09d7ec0c419092bf7b0/azure_mgmt_frontdoor-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-15 08:30:31",
    "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-frontdoor"
}
        
Elapsed time: 0.22672s