# pylint: disable=too-many-lines
# 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.
# --------------------------------------------------------------------------
import sys
from typing import Any, Callable, Dict, IO, Iterable, Optional, TypeVar, Union, cast, overload
import urllib.parse
from azure.core.exceptions import (
ClientAuthenticationError,
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
ResourceNotModifiedError,
map_error,
)
from azure.core.paging import ItemPaged
from azure.core.pipeline import PipelineResponse
from azure.core.pipeline.transport import HttpResponse
from azure.core.polling import LROPoller, NoPolling, PollingMethod
from azure.core.rest import HttpRequest
from azure.core.tracing.decorator import distributed_trace
from azure.core.utils import case_insensitive_dict
from azure.mgmt.core.exceptions import ARMErrorFormat
from azure.mgmt.core.polling.arm_polling import ARMPolling
from .. import models as _models
from .._serialization import Serializer
from .._vendor import ManagementGroupsAPIMixinABC, _convert_request, _format_url_section
if sys.version_info >= (3, 8):
from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports
else:
from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports
T = TypeVar("T")
ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]]
_SERIALIZER = Serializer()
_SERIALIZER.client_side_validation = False
def build_list_request(
*, cache_control: str = "no-cache", skiptoken: Optional[str] = None, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-04-01")) # type: Literal["2021-04-01"]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/providers/Microsoft.Management/managementGroups")
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
if skiptoken is not None:
_params["$skiptoken"] = _SERIALIZER.query("skiptoken", skiptoken, "str")
# Construct headers
if cache_control is not None:
_headers["Cache-Control"] = _SERIALIZER.header("cache_control", cache_control, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_get_request(
group_id: str,
*,
expand: Optional[Union[str, _models.ManagementGroupExpandType]] = None,
recurse: Optional[bool] = None,
filter: Optional[str] = None,
cache_control: str = "no-cache",
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-04-01")) # type: Literal["2021-04-01"]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/providers/Microsoft.Management/managementGroups/{groupId}")
path_format_arguments = {
"groupId": _SERIALIZER.url("group_id", group_id, "str"),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
if expand is not None:
_params["$expand"] = _SERIALIZER.query("expand", expand, "str")
if recurse is not None:
_params["$recurse"] = _SERIALIZER.query("recurse", recurse, "bool")
if filter is not None:
_params["$filter"] = _SERIALIZER.query("filter", filter, "str")
# Construct headers
if cache_control is not None:
_headers["Cache-Control"] = _SERIALIZER.header("cache_control", cache_control, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_create_or_update_request(group_id: str, *, cache_control: str = "no-cache", **kwargs: Any) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-04-01")) # type: Literal["2021-04-01"]
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/providers/Microsoft.Management/managementGroups/{groupId}")
path_format_arguments = {
"groupId": _SERIALIZER.url("group_id", group_id, "str"),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if cache_control is not None:
_headers["Cache-Control"] = _SERIALIZER.header("cache_control", cache_control, "str")
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs)
def build_update_request(group_id: str, *, cache_control: str = "no-cache", **kwargs: Any) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-04-01")) # type: Literal["2021-04-01"]
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/providers/Microsoft.Management/managementGroups/{groupId}")
path_format_arguments = {
"groupId": _SERIALIZER.url("group_id", group_id, "str"),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if cache_control is not None:
_headers["Cache-Control"] = _SERIALIZER.header("cache_control", cache_control, "str")
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs)
def build_delete_request(group_id: str, *, cache_control: str = "no-cache", **kwargs: Any) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-04-01")) # type: Literal["2021-04-01"]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/providers/Microsoft.Management/managementGroups/{groupId}")
path_format_arguments = {
"groupId": _SERIALIZER.url("group_id", group_id, "str"),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if cache_control is not None:
_headers["Cache-Control"] = _SERIALIZER.header("cache_control", cache_control, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs)
def build_get_descendants_request(
group_id: str, *, skiptoken: Optional[str] = None, top: Optional[int] = None, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-04-01")) # type: Literal["2021-04-01"]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/providers/Microsoft.Management/managementGroups/{groupId}/descendants")
path_format_arguments = {
"groupId": _SERIALIZER.url("group_id", group_id, "str"),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
if skiptoken is not None:
_params["$skiptoken"] = _SERIALIZER.query("skiptoken", skiptoken, "str")
if top is not None:
_params["$top"] = _SERIALIZER.query("top", top, "int")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
[docs]class ManagementGroupsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.managementgroups.ManagementGroupsAPI`'s
:attr:`management_groups` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
[docs] @distributed_trace
def list(
self, cache_control: str = "no-cache", skiptoken: Optional[str] = None, **kwargs: Any
) -> Iterable["_models.ManagementGroupInfo"]:
"""List management groups for the authenticated user.
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:param skiptoken: Page continuation token is only used if a previous operation returned a
partial result.
If a previous response contains a nextLink element, the value of the nextLink element will
include a token parameter that specifies a starting point to use for subsequent calls. Default
value is None.
:type skiptoken: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either ManagementGroupInfo or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.managementgroups.models.ManagementGroupInfo]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
cls = kwargs.pop("cls", None) # type: ClsType[_models.ManagementGroupListResult]
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
request = build_list_request(
cache_control=cache_control,
skiptoken=skiptoken,
api_version=api_version,
template_url=self.list.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
request.method = "GET"
return request
def extract_data(pipeline_response):
deserialized = self._deserialize("ManagementGroupListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
list.metadata = {"url": "/providers/Microsoft.Management/managementGroups"} # type: ignore
[docs] @distributed_trace
def get(
self,
group_id: str,
expand: Optional[Union[str, _models.ManagementGroupExpandType]] = None,
recurse: Optional[bool] = None,
filter: Optional[str] = None,
cache_control: str = "no-cache",
**kwargs: Any
) -> _models.ManagementGroup:
"""Get the details of the management group.
:param group_id: Management Group ID. Required.
:type group_id: str
:param expand: The $expand=children query string parameter allows clients to request inclusion
of children in the response payload. $expand=path includes the path from the root group to the
current group. $expand=ancestors includes the ancestor Ids of the current group. Known values
are: "children", "path", and "ancestors". Default value is None.
:type expand: str or ~azure.mgmt.managementgroups.models.ManagementGroupExpandType
:param recurse: The $recurse=true query string parameter allows clients to request inclusion of
entire hierarchy in the response payload. Note that $expand=children must be passed up if
$recurse is set to true. Default value is None.
:type recurse: bool
:param filter: A filter which allows the exclusion of subscriptions from results (i.e.
'$filter=children.childType ne Subscription'). Default value is None.
:type filter: str
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: ManagementGroup or the result of cls(response)
:rtype: ~azure.mgmt.managementgroups.models.ManagementGroup
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
cls = kwargs.pop("cls", None) # type: ClsType[_models.ManagementGroup]
request = build_get_request(
group_id=group_id,
expand=expand,
recurse=recurse,
filter=filter,
cache_control=cache_control,
api_version=api_version,
template_url=self.get.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("ManagementGroup", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}"} # type: ignore
def _create_or_update_initial(
self,
group_id: str,
create_management_group_request: Union[_models.CreateManagementGroupRequest, IO],
cache_control: str = "no-cache",
**kwargs: Any
) -> Union[_models.ManagementGroup, _models.AzureAsyncOperationResults]:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop(
"cls", None
) # type: ClsType[Union[_models.ManagementGroup, _models.AzureAsyncOperationResults]]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_management_group_request, (IO, bytes)):
_content = create_management_group_request
else:
_json = self._serialize.body(create_management_group_request, "CreateManagementGroupRequest")
request = build_create_or_update_request(
group_id=group_id,
cache_control=cache_control,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self._create_or_update_initial.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 200:
deserialized = self._deserialize("ManagementGroup", pipeline_response)
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("Azure-AsyncOperation")
)
deserialized = self._deserialize("AzureAsyncOperationResults", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, response_headers)
return deserialized
_create_or_update_initial.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}"} # type: ignore
@overload
def begin_create_or_update(
self,
group_id: str,
create_management_group_request: _models.CreateManagementGroupRequest,
cache_control: str = "no-cache",
*,
content_type: str = "application/json",
**kwargs: Any
) -> Union[LROPoller[_models.ManagementGroup], LROPoller[_models.AzureAsyncOperationResults]]:
"""Create or update a management group.
If a management group is already created and a subsequent create request is issued with
different properties, the management group properties will be updated.
:param group_id: Management Group ID. Required.
:type group_id: str
:param create_management_group_request: Management group creation parameters. Required.
:type create_management_group_request:
~azure.mgmt.managementgroups.models.CreateManagementGroupRequest
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either ManagementGroup or An instance of
LROPoller that returns either AzureAsyncOperationResults or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.ManagementGroup] or
~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.AzureAsyncOperationResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
group_id: str,
create_management_group_request: IO,
cache_control: str = "no-cache",
*,
content_type: str = "application/json",
**kwargs: Any
) -> Union[LROPoller[_models.ManagementGroup], LROPoller[_models.AzureAsyncOperationResults]]:
"""Create or update a management group.
If a management group is already created and a subsequent create request is issued with
different properties, the management group properties will be updated.
:param group_id: Management Group ID. Required.
:type group_id: str
:param create_management_group_request: Management group creation parameters. Required.
:type create_management_group_request: IO
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either ManagementGroup or An instance of
LROPoller that returns either AzureAsyncOperationResults or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.ManagementGroup] or
~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.AzureAsyncOperationResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def begin_create_or_update(
self,
group_id: str,
create_management_group_request: Union[_models.CreateManagementGroupRequest, IO],
cache_control: str = "no-cache",
**kwargs: Any
) -> Union[LROPoller[_models.ManagementGroup], LROPoller[_models.AzureAsyncOperationResults]]:
"""Create or update a management group.
If a management group is already created and a subsequent create request is issued with
different properties, the management group properties will be updated.
:param group_id: Management Group ID. Required.
:type group_id: str
:param create_management_group_request: Management group creation parameters. Is either a model
type or a IO type. Required.
:type create_management_group_request:
~azure.mgmt.managementgroups.models.CreateManagementGroupRequest or IO
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either ManagementGroup or An instance of
LROPoller that returns either AzureAsyncOperationResults or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.ManagementGroup] or
~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.AzureAsyncOperationResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.ManagementGroup]
polling = kwargs.pop("polling", True) # type: Union[bool, PollingMethod]
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token = kwargs.pop("continuation_token", None) # type: Optional[str]
if cont_token is None:
raw_result = self._create_or_update_initial( # type: ignore
group_id=group_id,
create_management_group_request=create_management_group_request,
cache_control=cache_control,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ManagementGroup", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
if polling is True:
polling_method = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
) # type: PollingMethod
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller.from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller(self._client, raw_result, get_long_running_output, polling_method)
begin_create_or_update.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}"} # type: ignore
@overload
def update(
self,
group_id: str,
patch_group_request: _models.PatchManagementGroupRequest,
cache_control: str = "no-cache",
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.ManagementGroup:
"""Update a management group.
:param group_id: Management Group ID. Required.
:type group_id: str
:param patch_group_request: Management group patch parameters. Required.
:type patch_group_request: ~azure.mgmt.managementgroups.models.PatchManagementGroupRequest
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: ManagementGroup or the result of cls(response)
:rtype: ~azure.mgmt.managementgroups.models.ManagementGroup
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def update(
self,
group_id: str,
patch_group_request: IO,
cache_control: str = "no-cache",
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.ManagementGroup:
"""Update a management group.
:param group_id: Management Group ID. Required.
:type group_id: str
:param patch_group_request: Management group patch parameters. Required.
:type patch_group_request: IO
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: ManagementGroup or the result of cls(response)
:rtype: ~azure.mgmt.managementgroups.models.ManagementGroup
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def update(
self,
group_id: str,
patch_group_request: Union[_models.PatchManagementGroupRequest, IO],
cache_control: str = "no-cache",
**kwargs: Any
) -> _models.ManagementGroup:
"""Update a management group.
:param group_id: Management Group ID. Required.
:type group_id: str
:param patch_group_request: Management group patch parameters. Is either a model type or a IO
type. Required.
:type patch_group_request: ~azure.mgmt.managementgroups.models.PatchManagementGroupRequest or
IO
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: ManagementGroup or the result of cls(response)
:rtype: ~azure.mgmt.managementgroups.models.ManagementGroup
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.ManagementGroup]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(patch_group_request, (IO, bytes)):
_content = patch_group_request
else:
_json = self._serialize.body(patch_group_request, "PatchManagementGroupRequest")
request = build_update_request(
group_id=group_id,
cache_control=cache_control,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.update.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("ManagementGroup", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
update.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}"} # type: ignore
def _delete_initial(
self, group_id: str, cache_control: str = "no-cache", **kwargs: Any
) -> Optional[_models.AzureAsyncOperationResults]:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.AzureAsyncOperationResults]]
request = build_delete_request(
group_id=group_id,
cache_control=cache_control,
api_version=api_version,
template_url=self._delete_initial.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = None
response_headers = {}
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("Azure-AsyncOperation")
)
deserialized = self._deserialize("AzureAsyncOperationResults", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, response_headers)
return deserialized
_delete_initial.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}"} # type: ignore
[docs] @distributed_trace
def begin_delete(
self, group_id: str, cache_control: str = "no-cache", **kwargs: Any
) -> LROPoller[_models.AzureAsyncOperationResults]:
"""Delete management group.
If a management group contains child resources, the request will fail.
:param group_id: Management Group ID. Required.
:type group_id: str
:param cache_control: Indicates whether the request should utilize any caches. Populate the
header with 'no-cache' value to bypass existing caches. Default value is "no-cache".
:type cache_control: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either AzureAsyncOperationResults or the result
of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.managementgroups.models.AzureAsyncOperationResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
cls = kwargs.pop("cls", None) # type: ClsType[_models.AzureAsyncOperationResults]
polling = kwargs.pop("polling", True) # type: Union[bool, PollingMethod]
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token = kwargs.pop("continuation_token", None) # type: Optional[str]
if cont_token is None:
raw_result = self._delete_initial( # type: ignore
group_id=group_id,
cache_control=cache_control,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
response_headers = {}
response = pipeline_response.http_response
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("Azure-AsyncOperation")
)
deserialized = self._deserialize("AzureAsyncOperationResults", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, response_headers)
return deserialized
if polling is True:
polling_method = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
) # type: PollingMethod
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller.from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller(self._client, raw_result, get_long_running_output, polling_method)
begin_delete.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}"} # type: ignore
[docs] @distributed_trace
def get_descendants(
self, group_id: str, skiptoken: Optional[str] = None, top: Optional[int] = None, **kwargs: Any
) -> Iterable["_models.DescendantInfo"]:
"""List all entities that descend from a management group.
:param group_id: Management Group ID. Required.
:type group_id: str
:param skiptoken: Page continuation token is only used if a previous operation returned a
partial result.
If a previous response contains a nextLink element, the value of the nextLink element will
include a token parameter that specifies a starting point to use for subsequent calls. Default
value is None.
:type skiptoken: str
:param top: Number of elements to return when retrieving results. Passing this in will override
$skipToken. Default value is None.
:type top: int
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either DescendantInfo or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.managementgroups.models.DescendantInfo]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop(
"api_version", _params.pop("api-version", self._config.api_version)
) # type: Literal["2021-04-01"]
cls = kwargs.pop("cls", None) # type: ClsType[_models.DescendantListResult]
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
request = build_get_descendants_request(
group_id=group_id,
skiptoken=skiptoken,
top=top,
api_version=api_version,
template_url=self.get_descendants.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
request.method = "GET"
return request
def extract_data(pipeline_response):
deserialized = self._deserialize("DescendantListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
get_descendants.metadata = {"url": "/providers/Microsoft.Management/managementGroups/{groupId}/descendants"} # type: ignore