forked from Azure/azure-sdk-for-python
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 18388 in Azure/azure-rest-api-specs
update readme (Azure#18388) * update readme * update readme * update readme
- Loading branch information
SDKAuto
committed
Mar 25, 2022
1 parent
77b9240
commit d31cc9a
Showing
37 changed files
with
6,236 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release History | ||
|
||
## 0.1.0 (1970-01-01) | ||
|
||
* Initial Release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Copyright (c) Microsoft Corporation. | ||
|
||
MIT License | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
include _meta.json | ||
recursive-include tests *.py *.yaml | ||
include *.md | ||
include azure/__init__.py | ||
include azure/mgmt/__init__.py | ||
include LICENSE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Microsoft Azure SDK for Python | ||
|
||
This is the Microsoft Azure MyService Management Client Library. | ||
This package has been tested with Python 3.6+. | ||
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 | ||
|
||
|
||
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 [MyService 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) | ||
|
||
|
||
# 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. | ||
|
||
|
||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-dnc%2FREADME.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"autorest": "3.7.2", | ||
"use": [ | ||
"@autorest/python@5.12.0", | ||
"@autorest/modelerfour@4.19.3" | ||
], | ||
"commit": "fb8e80cb9407ee7166cc7c1a75f8321a3b66db68", | ||
"repository_url": "https://github.com/Azure/azure-rest-api-specs", | ||
"autorest_command": "autorest specification/dnc/resource-manager/readme.md --multiapi --python --python-mode=update --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk --python3-only --track2 --use=@autorest/python@5.12.0 --use=@autorest/modelerfour@4.19.3 --version=3.7.2", | ||
"readme": "specification/dnc/resource-manager/readme.md" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# 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) AutoRest Code Generator. | ||
# Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
# -------------------------------------------------------------------------- | ||
|
||
from ._dnc import DNC | ||
from ._version import VERSION | ||
|
||
__version__ = VERSION | ||
__all__ = ['DNC'] | ||
|
||
# `._patch.py` is used for handwritten extensions to the generated code | ||
# Example: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md | ||
from ._patch import patch_sdk | ||
patch_sdk() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# 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) AutoRest Code Generator. | ||
# Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
# -------------------------------------------------------------------------- | ||
|
||
from typing import Any, TYPE_CHECKING | ||
|
||
from azure.core.configuration import Configuration | ||
from azure.core.pipeline import policies | ||
from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy | ||
|
||
from ._version import VERSION | ||
|
||
if TYPE_CHECKING: | ||
# pylint: disable=unused-import,ungrouped-imports | ||
from azure.core.credentials import TokenCredential | ||
|
||
|
||
class DNCConfiguration(Configuration): | ||
"""Configuration for DNC. | ||
Note that all parameters used to create this instance are saved as instance | ||
attributes. | ||
:param credential: Credential needed for the client to connect to Azure. | ||
:type credential: ~azure.core.credentials.TokenCredential | ||
:param subscription_id: The ID of the target subscription. | ||
:type subscription_id: str | ||
""" | ||
|
||
def __init__( | ||
self, | ||
credential: "TokenCredential", | ||
subscription_id: str, | ||
**kwargs: Any | ||
) -> None: | ||
super(DNCConfiguration, self).__init__(**kwargs) | ||
if credential is None: | ||
raise ValueError("Parameter 'credential' must not be None.") | ||
if subscription_id is None: | ||
raise ValueError("Parameter 'subscription_id' must not be None.") | ||
|
||
self.credential = credential | ||
self.subscription_id = subscription_id | ||
self.api_version = "2021-03-15" | ||
self.credential_scopes = kwargs.pop('credential_scopes', ['https://management.azure.com/.default']) | ||
kwargs.setdefault('sdk_moniker', 'mgmt-dnc/{}'.format(VERSION)) | ||
self._configure(**kwargs) | ||
|
||
def _configure( | ||
self, | ||
**kwargs # type: Any | ||
): | ||
# type: (...) -> None | ||
self.user_agent_policy = kwargs.get('user_agent_policy') or policies.UserAgentPolicy(**kwargs) | ||
self.headers_policy = kwargs.get('headers_policy') or policies.HeadersPolicy(**kwargs) | ||
self.proxy_policy = kwargs.get('proxy_policy') or policies.ProxyPolicy(**kwargs) | ||
self.logging_policy = kwargs.get('logging_policy') or policies.NetworkTraceLoggingPolicy(**kwargs) | ||
self.http_logging_policy = kwargs.get('http_logging_policy') or ARMHttpLoggingPolicy(**kwargs) | ||
self.retry_policy = kwargs.get('retry_policy') or policies.RetryPolicy(**kwargs) | ||
self.custom_hook_policy = kwargs.get('custom_hook_policy') or policies.CustomHookPolicy(**kwargs) | ||
self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs) | ||
self.authentication_policy = kwargs.get('authentication_policy') | ||
if self.credential and not self.authentication_policy: | ||
self.authentication_policy = ARMChallengeAuthenticationPolicy(self.credential, *self.credential_scopes, **kwargs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
# 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) AutoRest 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 | ||
|
||
from azure.core.rest import HttpRequest, HttpResponse | ||
from azure.mgmt.core import ARMPipelineClient | ||
from msrest import Deserializer, Serializer | ||
|
||
from . import models | ||
from ._configuration import DNCConfiguration | ||
from .operations import ControllerOperations, DelegatedNetworkOperations, DelegatedSubnetServiceOperations, Operations, OrchestratorInstanceServiceOperations | ||
|
||
if TYPE_CHECKING: | ||
# pylint: disable=unused-import,ungrouped-imports | ||
from azure.core.credentials import TokenCredential | ||
|
||
class DNC: | ||
"""DNC web api provides way to create, get and delete dnc controller. | ||
:ivar controller: ControllerOperations operations | ||
:vartype controller: azure.mgmt.dnc.operations.ControllerOperations | ||
:ivar delegated_network: DelegatedNetworkOperations operations | ||
:vartype delegated_network: azure.mgmt.dnc.operations.DelegatedNetworkOperations | ||
:ivar orchestrator_instance_service: OrchestratorInstanceServiceOperations operations | ||
:vartype orchestrator_instance_service: | ||
azure.mgmt.dnc.operations.OrchestratorInstanceServiceOperations | ||
:ivar delegated_subnet_service: DelegatedSubnetServiceOperations operations | ||
:vartype delegated_subnet_service: azure.mgmt.dnc.operations.DelegatedSubnetServiceOperations | ||
:ivar operations: Operations operations | ||
:vartype operations: azure.mgmt.dnc.operations.Operations | ||
:param credential: Credential needed for the client to connect to Azure. | ||
:type credential: ~azure.core.credentials.TokenCredential | ||
:param subscription_id: The ID of the target subscription. | ||
:type subscription_id: str | ||
:param base_url: Service URL. Default value is 'https://management.azure.com'. | ||
:type base_url: 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: str = "https://management.azure.com", | ||
**kwargs: Any | ||
) -> None: | ||
self._config = DNCConfiguration(credential=credential, subscription_id=subscription_id, **kwargs) | ||
self._client = ARMPipelineClient(base_url=base_url, config=self._config, **kwargs) | ||
|
||
client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} | ||
self._serialize = Serializer(client_models) | ||
self._deserialize = Deserializer(client_models) | ||
self._serialize.client_side_validation = False | ||
self.controller = ControllerOperations(self._client, self._config, self._serialize, self._deserialize) | ||
self.delegated_network = DelegatedNetworkOperations(self._client, self._config, self._serialize, self._deserialize) | ||
self.orchestrator_instance_service = OrchestratorInstanceServiceOperations(self._client, self._config, self._serialize, self._deserialize) | ||
self.delegated_subnet_service = DelegatedSubnetServiceOperations(self._client, self._config, self._serialize, self._deserialize) | ||
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize) | ||
|
||
|
||
def _send_request( | ||
self, | ||
request, # type: HttpRequest | ||
**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/python/protocol/quickstart | ||
: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) | ||
request_copy.url = self._client.format_url(request_copy.url) | ||
return self._client.send_request(request_copy, **kwargs) | ||
|
||
def close(self): | ||
# type: () -> None | ||
self._client.close() | ||
|
||
def __enter__(self): | ||
# type: () -> DNC | ||
self._client.__enter__() | ||
return self | ||
|
||
def __exit__(self, *exc_details): | ||
# type: (Any) -> None | ||
self._client.__exit__(*exc_details) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
{ | ||
"chosen_version": "2021-03-15", | ||
"total_api_version_list": ["2021-03-15"], | ||
"client": { | ||
"name": "DNC", | ||
"filename": "_dnc", | ||
"description": "DNC web api provides way to create, get and delete dnc controller.", | ||
"host_value": "\"https://management.azure.com\"", | ||
"parameterized_host_template": null, | ||
"azure_arm": true, | ||
"has_lro_operations": true, | ||
"client_side_validation": false, | ||
"sync_imports": "{\"typing\": {\"azurecore\": {\"azure.core.credentials\": [\"TokenCredential\"]}}, \"regular\": {\"azurecore\": {\"azure.profiles\": [\"KnownProfiles\", \"ProfileDefinition\"], \"azure.profiles.multiapiclient\": [\"MultiApiClientMixin\"], \"msrest\": [\"Deserializer\", \"Serializer\"], \"azure.mgmt.core\": [\"ARMPipelineClient\"]}, \"local\": {\"._configuration\": [\"DNCConfiguration\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\", \"Optional\"]}}}", | ||
"async_imports": "{\"typing\": {\"azurecore\": {\"azure.core.credentials_async\": [\"AsyncTokenCredential\"], \"azure.core.credentials\": [\"TokenCredential\"]}}, \"regular\": {\"azurecore\": {\"azure.profiles\": [\"KnownProfiles\", \"ProfileDefinition\"], \"azure.profiles.multiapiclient\": [\"MultiApiClientMixin\"], \"msrest\": [\"Deserializer\", \"Serializer\"], \"azure.mgmt.core\": [\"AsyncARMPipelineClient\"]}, \"local\": {\"._configuration\": [\"DNCConfiguration\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\", \"Optional\"]}}}" | ||
}, | ||
"global_parameters": { | ||
"sync": { | ||
"credential": { | ||
"signature": "credential, # type: \"TokenCredential\"", | ||
"description": "Credential needed for the client to connect to Azure.", | ||
"docstring_type": "~azure.core.credentials.TokenCredential", | ||
"required": true | ||
}, | ||
"subscription_id": { | ||
"signature": "subscription_id, # type: str", | ||
"description": "The ID of the target subscription.", | ||
"docstring_type": "str", | ||
"required": true | ||
} | ||
}, | ||
"async": { | ||
"credential": { | ||
"signature": "credential: \"AsyncTokenCredential\",", | ||
"description": "Credential needed for the client to connect to Azure.", | ||
"docstring_type": "~azure.core.credentials_async.AsyncTokenCredential", | ||
"required": true | ||
}, | ||
"subscription_id": { | ||
"signature": "subscription_id: str,", | ||
"description": "The ID of the target subscription.", | ||
"docstring_type": "str", | ||
"required": true | ||
} | ||
}, | ||
"constant": { | ||
}, | ||
"call": "credential, subscription_id", | ||
"service_client_specific": { | ||
"sync": { | ||
"api_version": { | ||
"signature": "api_version=None, # type: Optional[str]", | ||
"description": "API version to use if no profile is provided, or if missing in profile.", | ||
"docstring_type": "str", | ||
"required": false | ||
}, | ||
"base_url": { | ||
"signature": "base_url=\"https://management.azure.com\", # type: str", | ||
"description": "Service URL", | ||
"docstring_type": "str", | ||
"required": false | ||
}, | ||
"profile": { | ||
"signature": "profile=KnownProfiles.default, # type: KnownProfiles", | ||
"description": "A profile definition, from KnownProfiles to dict.", | ||
"docstring_type": "azure.profiles.KnownProfiles", | ||
"required": false | ||
} | ||
}, | ||
"async": { | ||
"api_version": { | ||
"signature": "api_version: Optional[str] = None,", | ||
"description": "API version to use if no profile is provided, or if missing in profile.", | ||
"docstring_type": "str", | ||
"required": false | ||
}, | ||
"base_url": { | ||
"signature": "base_url: str = \"https://management.azure.com\",", | ||
"description": "Service URL", | ||
"docstring_type": "str", | ||
"required": false | ||
}, | ||
"profile": { | ||
"signature": "profile: KnownProfiles = KnownProfiles.default,", | ||
"description": "A profile definition, from KnownProfiles to dict.", | ||
"docstring_type": "azure.profiles.KnownProfiles", | ||
"required": false | ||
} | ||
} | ||
} | ||
}, | ||
"config": { | ||
"credential": true, | ||
"credential_scopes": ["https://management.azure.com/.default"], | ||
"credential_call_sync": "ARMChallengeAuthenticationPolicy(self.credential, *self.credential_scopes, **kwargs)", | ||
"credential_call_async": "AsyncARMChallengeAuthenticationPolicy(self.credential, *self.credential_scopes, **kwargs)", | ||
"sync_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMChallengeAuthenticationPolicy\", \"ARMHttpLoggingPolicy\"]}, \"local\": {\"._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}}, \"typing\": {\"azurecore\": {\"azure.core.credentials\": [\"TokenCredential\"]}}}", | ||
"async_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\", \"AsyncARMChallengeAuthenticationPolicy\"]}, \"local\": {\".._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}}, \"typing\": {\"azurecore\": {\"azure.core.credentials_async\": [\"AsyncTokenCredential\"]}}}" | ||
}, | ||
"operation_groups": { | ||
"controller": "ControllerOperations", | ||
"delegated_network": "DelegatedNetworkOperations", | ||
"orchestrator_instance_service": "OrchestratorInstanceServiceOperations", | ||
"delegated_subnet_service": "DelegatedSubnetServiceOperations", | ||
"operations": "Operations" | ||
} | ||
} |
Oops, something went wrong.