azure-mgmt-dns


Nameazure-mgmt-dns JSON
Version 8.2.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure DNS Management Client Library for Python
upload_time2024-10-21 06:17:19
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 DNS 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-dns
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.dns import DnsManagementClient
import os

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

## Examples

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

## 8.2.0 (2024-10-22)

### Features Added

  - Model RecordSet has a new parameter traffic_management_profile

## 8.1.0 (2023-06-14)

### Features Added

  - Added operation group DnssecConfigsOperations
  - Model RecordSet has a new parameter ds_records
  - Model RecordSet has a new parameter naptr_records
  - Model RecordSet has a new parameter tlsa_records
  - Model Zone has a new parameter signing_keys
  - Model Zone has a new parameter system_data

## 8.1.0b1 (2023-02-10)

### Other Changes

  - Added generated samples in github repo
  - Drop support for python<3.7.0

## 8.0.0 (2021-04-14)

 - GA release

## 8.0.0b1 (2021-03-10)

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.


## 3.0.0 (2019-06-18)

**General Breaking changes**

This version uses a next-generation code generator that *might*
introduce breaking changes if you were importing from the v20xx_yy_zz
API folders. In summary, some modules were incorrectly
visible/importable and have been renamed. This fixed several issues
caused by usage of classes that were not supposed to be used in the
first place.

  - DnsManagementClient cannot be imported from
    `azure.mgmt.dns.v20xx_yy_zz.dns_management_client` anymore
    (import from `azure.mgmt.dns.v20xx_yy_zz` works like before)
  - DnsManagementClientConfiguration import has been moved from
    `azure.mgmt.dns.v20xx_yy_zz.dns_management_client` to
    `azure.mgmt.dns.v20xx_yy_zz`
  - A model `MyClass` from a "models" sub-module cannot be imported
    anymore using `azure.mgmt.dns.v20xx_yy_zz.models.my_class`
    (import from `azure.mgmt.dns.v20xx_yy_zz.models` works like
    before)
  - An operation class `MyClassOperations` from an `operations`
    sub-module cannot be imported anymore using
    `azure.mgmt.dns.v20xx_yy_zz.operations.my_class_operations`
    (import from `azure.mgmt.dns.v20xx_yy_zz.operations` works like
    before)

Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.

## 2.1.0 (2018-09-10)

**Features**

  - Model RecordSet has a new parameter target_resource
  - Added operation group DnsResourceReferenceOperations

## 2.0.0 (2018-07-01)

**Bugfixes**

  - Fix ARM compliance (correct settings of location, tags, etc.)

## 2.0.0rc2 (2018-07-05)

**Features**

  - Client class can be used as a context manager to keep the underlying
    HTTP session open for performance

**General Breaking changes**

This version uses a next-generation code generator that *might*
introduce breaking changes.

  - Model signatures now use only keyword-argument syntax. All
    positional arguments must be re-written as keyword-arguments. To
    keep auto-completion in most cases, models are now generated for
    Python 2 and Python 3. Python 3 uses the "*" syntax for
    keyword-only arguments.
  - Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
    improve the behavior when unrecognized enum values are encountered.
    While this is not a breaking change, the distinctions are important,
    and are documented here:
    <https://docs.python.org/3/library/enum.html#others> At a glance:
      - "is" should not be used at all.
      - "format" will return the string value, where "%s" string
        formatting will return `NameOfEnum.stringvalue`. Format syntax
        should be prefered.
  - New Long Running Operation:
      - Return type changes from
        `msrestazure.azure_operation.AzureOperationPoller` to
        `msrest.polling.LROPoller`. External API is the same.
      - Return type is now **always** a `msrest.polling.LROPoller`,
        regardless of the optional parameters used.
      - The behavior has changed when using `raw=True`. Instead of
        returning the initial call result as `ClientRawResponse`,
        without polling, now this returns an LROPoller. After polling,
        the final resource will be returned as a `ClientRawResponse`.
      - New `polling` parameter. The default behavior is
        `Polling=True` which will poll using ARM algorithm. When
        `Polling=False`, the response of the initial call will be
        returned without polling.
      - `polling` parameter accepts instances of subclasses of
        `msrest.polling.PollingMethod`.
      - `add_done_callback` will no longer raise if called after
        polling is finished, but will instead execute the callback right
        away.

**Bugfixes**

  - Compatibility of the sdist with wheel 0.31.0

## 2.0.0rc1 (2018-03-14)

**Features**

  - Add public/private zone
  - Add record_sets.list_all_by_dns_zone operation
  - Add zones.update operation

**Breaking changes**

  - 'zone_type' is now required when creating a zone ('Public' is
    equivalent as previous behavior)

New API version 2018-03-01-preview

## 1.2.0 (2017-10-26)

  - add record_type CAA
  - remove pointless return type of delete

Api version moves from 2016-04-01 to 2017-09-01

## 1.1.0 (2017-10-10)

  - Add "recordsetnamesuffix" filter parameter to list operations

## 1.0.1 (2017-04-20)

This wheel package is now built with the azure wheel extension

## 1.0.0 (2016-12-12)

  - Initial release


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-dns",
    "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/11/4d/1ec6359c0977b8a41b033f0bdf221662e12b94b8fdbce4fe5672c9d007f0/azure_mgmt_dns-8.2.0.tar.gz",
    "platform": null,
    "description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure DNS 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-dns\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.dns import DnsManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = DnsManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search DNS 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## 8.2.0 (2024-10-22)\n\n### Features Added\n\n  - Model RecordSet has a new parameter traffic_management_profile\n\n## 8.1.0 (2023-06-14)\n\n### Features Added\n\n  - Added operation group DnssecConfigsOperations\n  - Model RecordSet has a new parameter ds_records\n  - Model RecordSet has a new parameter naptr_records\n  - Model RecordSet has a new parameter tlsa_records\n  - Model Zone has a new parameter signing_keys\n  - Model Zone has a new parameter system_data\n\n## 8.1.0b1 (2023-02-10)\n\n### Other Changes\n\n  - Added generated samples in github repo\n  - Drop support for python<3.7.0\n\n## 8.0.0 (2021-04-14)\n\n - GA release\n\n## 8.0.0b1 (2021-03-10)\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## 3.0.0 (2019-06-18)\n\n**General Breaking changes**\n\nThis version uses a next-generation code generator that *might*\nintroduce breaking changes if you were importing from the v20xx_yy_zz\nAPI folders. In summary, some modules were incorrectly\nvisible/importable and have been renamed. This fixed several issues\ncaused by usage of classes that were not supposed to be used in the\nfirst place.\n\n  - DnsManagementClient cannot be imported from\n    `azure.mgmt.dns.v20xx_yy_zz.dns_management_client` anymore\n    (import from `azure.mgmt.dns.v20xx_yy_zz` works like before)\n  - DnsManagementClientConfiguration import has been moved from\n    `azure.mgmt.dns.v20xx_yy_zz.dns_management_client` to\n    `azure.mgmt.dns.v20xx_yy_zz`\n  - A model `MyClass` from a \"models\" sub-module cannot be imported\n    anymore using `azure.mgmt.dns.v20xx_yy_zz.models.my_class`\n    (import from `azure.mgmt.dns.v20xx_yy_zz.models` works like\n    before)\n  - An operation class `MyClassOperations` from an `operations`\n    sub-module cannot be imported anymore using\n    `azure.mgmt.dns.v20xx_yy_zz.operations.my_class_operations`\n    (import from `azure.mgmt.dns.v20xx_yy_zz.operations` works like\n    before)\n\nLast but not least, HTTP connection pooling is now enabled by default.\nYou should always use a client as a context manager, or call close(), or\nuse no more than one client per process.\n\n## 2.1.0 (2018-09-10)\n\n**Features**\n\n  - Model RecordSet has a new parameter target_resource\n  - Added operation group DnsResourceReferenceOperations\n\n## 2.0.0 (2018-07-01)\n\n**Bugfixes**\n\n  - Fix ARM compliance (correct settings of location, tags, etc.)\n\n## 2.0.0rc2 (2018-07-05)\n\n**Features**\n\n  - Client class can be used as a context manager to keep the underlying\n    HTTP session open for performance\n\n**General Breaking changes**\n\nThis version uses a next-generation code generator that *might*\nintroduce breaking changes.\n\n  - Model signatures now use only keyword-argument syntax. All\n    positional arguments must be re-written as keyword-arguments. To\n    keep auto-completion in most cases, models are now generated for\n    Python 2 and Python 3. Python 3 uses the \"*\" syntax for\n    keyword-only arguments.\n  - Enum types now use the \"str\" mixin (class AzureEnum(str, Enum)) to\n    improve the behavior when unrecognized enum values are encountered.\n    While this is not a breaking change, the distinctions are important,\n    and are documented here:\n    <https://docs.python.org/3/library/enum.html#others> At a glance:\n      - \"is\" should not be used at all.\n      - \"format\" will return the string value, where \"%s\" string\n        formatting will return `NameOfEnum.stringvalue`. Format syntax\n        should be prefered.\n  - New Long Running Operation:\n      - Return type changes from\n        `msrestazure.azure_operation.AzureOperationPoller` to\n        `msrest.polling.LROPoller`. External API is the same.\n      - Return type is now **always** a `msrest.polling.LROPoller`,\n        regardless of the optional parameters used.\n      - The behavior has changed when using `raw=True`. Instead of\n        returning the initial call result as `ClientRawResponse`,\n        without polling, now this returns an LROPoller. After polling,\n        the final resource will be returned as a `ClientRawResponse`.\n      - New `polling` parameter. The default behavior is\n        `Polling=True` which will poll using ARM algorithm. When\n        `Polling=False`, the response of the initial call will be\n        returned without polling.\n      - `polling` parameter accepts instances of subclasses of\n        `msrest.polling.PollingMethod`.\n      - `add_done_callback` will no longer raise if called after\n        polling is finished, but will instead execute the callback right\n        away.\n\n**Bugfixes**\n\n  - Compatibility of the sdist with wheel 0.31.0\n\n## 2.0.0rc1 (2018-03-14)\n\n**Features**\n\n  - Add public/private zone\n  - Add record_sets.list_all_by_dns_zone operation\n  - Add zones.update operation\n\n**Breaking changes**\n\n  - 'zone_type' is now required when creating a zone ('Public' is\n    equivalent as previous behavior)\n\nNew API version 2018-03-01-preview\n\n## 1.2.0 (2017-10-26)\n\n  - add record_type CAA\n  - remove pointless return type of delete\n\nApi version moves from 2016-04-01 to 2017-09-01\n\n## 1.1.0 (2017-10-10)\n\n  - Add \"recordsetnamesuffix\" filter parameter to list operations\n\n## 1.0.1 (2017-04-20)\n\nThis wheel package is now built with the azure wheel extension\n\n## 1.0.0 (2016-12-12)\n\n  - Initial release\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure DNS Management Client Library for Python",
    "version": "8.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": "903fe3563ec509be28b0bd99e0a177b97d2576a8013d8eb0184bfd904450b88b",
                "md5": "38b3eb8850ea9bb356cf18f0c4bc9902",
                "sha256": "76695ca547f758a2954c8f7db9ffde0bacd2d9105ccf0dbb0ec81c014f64c37c"
            },
            "downloads": -1,
            "filename": "azure_mgmt_dns-8.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "38b3eb8850ea9bb356cf18f0c4bc9902",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 201904,
            "upload_time": "2024-10-21T06:17:21",
            "upload_time_iso_8601": "2024-10-21T06:17:21.680802Z",
            "url": "https://files.pythonhosted.org/packages/90/3f/e3563ec509be28b0bd99e0a177b97d2576a8013d8eb0184bfd904450b88b/azure_mgmt_dns-8.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "114d1ec6359c0977b8a41b033f0bdf221662e12b94b8fdbce4fe5672c9d007f0",
                "md5": "012a54d67f41e661b6c6a677747bea05",
                "sha256": "627b9ea3df0bf78a895acadc5148dec84c2898063bfaabfff8b14baa983b596e"
            },
            "downloads": -1,
            "filename": "azure_mgmt_dns-8.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "012a54d67f41e661b6c6a677747bea05",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 138189,
            "upload_time": "2024-10-21T06:17:19",
            "upload_time_iso_8601": "2024-10-21T06:17:19.740385Z",
            "url": "https://files.pythonhosted.org/packages/11/4d/1ec6359c0977b8a41b033f0bdf221662e12b94b8fdbce4fe5672c9d007f0/azure_mgmt_dns-8.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-21 06:17:19",
    "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-dns"
}
        
Elapsed time: 0.44637s