forked from Azure/azure-sdk-for-python
-
Notifications
You must be signed in to change notification settings - Fork 8
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 29551 in Azure/azure-rest-api-specs
Merge 6315fa27efb4f4f719cb316bef3dd6106f50b0b0 into a83c34348fbd25ad79a05e36816b91da0122b583
- Loading branch information
SDKAuto
committed
Jun 24, 2024
1 parent
97e3f94
commit 8da47ac
Showing
67 changed files
with
6,382 additions
and
2,403 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 |
---|---|---|
@@ -1,6 +1,8 @@ | ||
include _meta.json | ||
recursive-include tests *.py *.yaml | ||
recursive-include tests *.py *.json | ||
recursive-include samples *.py *.md | ||
include *.md | ||
include azure/__init__.py | ||
include azure/mgmt/__init__.py | ||
include LICENSE | ||
include azure/mgmt/powerbiembedded/py.typed |
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 |
---|---|---|
@@ -1,30 +1,61 @@ | ||
# Microsoft Azure SDK for Python | ||
|
||
This is the Microsoft Azure Power BI Embedded Management Client Library. | ||
This package has been tested with Python 3.6+. | ||
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_ | ||
|
||
# Usage | ||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt) | ||
- Python 3.8+ is required to use this package. | ||
- [Azure subscription](https://azure.microsoft.com/free/) | ||
|
||
### Install the package | ||
|
||
For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/power-bi) | ||
Code samples for this package can be found at [Power BI Embedded 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) | ||
```bash | ||
pip install azure-mgmt-powerbiembedded | ||
pip install azure-identity | ||
``` | ||
|
||
### Authentication | ||
|
||
# Provide Feedback | ||
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.powerbiembedded import PowerBIEmbeddedManagementClient | ||
import os | ||
|
||
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") | ||
client = PowerBIEmbeddedManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id) | ||
``` | ||
|
||
## Examples | ||
|
||
Code samples for this package can be found at: | ||
- [Search Power BI Embedded 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. | ||
|
||
|
||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-powerbiembedded%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 @@ | ||
{ | ||
"commit": "e5a296d56b5fa0c24b822195b204402fc9830999", | ||
"repository_url": "https://github.com/Azure/azure-rest-api-specs", | ||
"autorest": "3.10.2", | ||
"use": [ | ||
"@autorest/[email protected]", | ||
"@autorest/[email protected]" | ||
], | ||
"autorest_command": "autorest specification/powerbiembedded/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/[email protected] --use=@autorest/[email protected] --version=3.10.2 --version-tolerant=False", | ||
"readme": "specification/powerbiembedded/resource-manager/readme.md" | ||
} |
26 changes: 17 additions & 9 deletions
26
sdk/powerbiembedded/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded/__init__.py
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 |
---|---|---|
@@ -1,18 +1,26 @@ | ||
# 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. | ||
# | ||
# 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. | ||
# Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
# -------------------------------------------------------------------------- | ||
|
||
from .power_bi_embedded_management_client import PowerBIEmbeddedManagementClient | ||
from .version import VERSION | ||
|
||
__all__ = ['PowerBIEmbeddedManagementClient'] | ||
from ._power_bi_embedded_management_client import PowerBIEmbeddedManagementClient | ||
from ._version import VERSION | ||
|
||
__version__ = VERSION | ||
|
||
try: | ||
from ._patch import __all__ as _patch_all | ||
from ._patch import * # pylint: disable=unused-wildcard-import | ||
except ImportError: | ||
_patch_all = [] | ||
from ._patch import patch_sdk as _patch_sdk | ||
|
||
__all__ = [ | ||
"PowerBIEmbeddedManagementClient", | ||
] | ||
__all__.extend([p for p in _patch_all if p not in __all__]) | ||
|
||
_patch_sdk() |
66 changes: 66 additions & 0 deletions
66
sdk/powerbiembedded/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded/_configuration.py
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,66 @@ | ||
# 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.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 PowerBIEmbeddedManagementClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long | ||
"""Configuration for PowerBIEmbeddedManagementClient. | ||
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. Required. | ||
:type credential: ~azure.core.credentials.TokenCredential | ||
:param subscription_id: Gets subscription credentials which uniquely identify a Microsoft Azure | ||
subscription. The subscription ID forms part of the URI for every service call. Required. | ||
:type subscription_id: str | ||
:keyword api_version: Api Version. Default value is "2016-01-29". Note that overriding this | ||
default value may result in unsupported behavior. | ||
:paramtype api_version: str | ||
""" | ||
|
||
def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None: | ||
api_version: str = kwargs.pop("api_version", "2016-01-29") | ||
|
||
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 = api_version | ||
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"]) | ||
kwargs.setdefault("sdk_moniker", "mgmt-powerbiembedded/{}".format(VERSION)) | ||
self.polling_interval = kwargs.get("polling_interval", 30) | ||
self._configure(**kwargs) | ||
|
||
def _configure(self, **kwargs: Any) -> 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.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) | ||
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) | ||
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**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 | ||
) |
20 changes: 20 additions & 0 deletions
20
sdk/powerbiembedded/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded/_patch.py
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,20 @@ | ||
# ------------------------------------ | ||
# Copyright (c) Microsoft Corporation. | ||
# Licensed under the MIT License. | ||
# ------------------------------------ | ||
"""Customize generated code here. | ||
Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize | ||
""" | ||
from typing import List | ||
|
||
__all__: List[str] = [] # Add all objects you want publicly available to users at this package level | ||
|
||
|
||
def patch_sdk(): | ||
"""Do not remove from this file. | ||
`patch_sdk` is a last resort escape hatch that allows you to do customizations | ||
you can't accomplish using the techniques described in | ||
https://aka.ms/azsdk/python/dpcodegen/python/customize | ||
""" |
124 changes: 124 additions & 0 deletions
124
...e-mgmt-powerbiembedded/azure/mgmt/powerbiembedded/_power_bi_embedded_management_client.py
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,124 @@ | ||
# 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, TYPE_CHECKING | ||
|
||
from azure.core.pipeline import policies | ||
from azure.core.rest import HttpRequest, HttpResponse | ||
from azure.mgmt.core import ARMPipelineClient | ||
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy | ||
|
||
from . import models as _models | ||
from ._configuration import PowerBIEmbeddedManagementClientConfiguration | ||
from ._serialization import Deserializer, Serializer | ||
from .operations import ( | ||
PowerBIEmbeddedManagementClientOperationsMixin, | ||
WorkspaceCollectionsOperations, | ||
WorkspacesOperations, | ||
) | ||
|
||
if TYPE_CHECKING: | ||
# pylint: disable=unused-import,ungrouped-imports | ||
from azure.core.credentials import TokenCredential | ||
|
||
|
||
class PowerBIEmbeddedManagementClient( | ||
PowerBIEmbeddedManagementClientOperationsMixin | ||
): # pylint: disable=client-accepts-api-version-keyword | ||
"""Client to manage your Power BI Embedded workspace collections and retrieve workspaces. | ||
:ivar workspace_collections: WorkspaceCollectionsOperations operations | ||
:vartype workspace_collections: | ||
azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations | ||
:ivar workspaces: WorkspacesOperations operations | ||
:vartype workspaces: azure.mgmt.powerbiembedded.operations.WorkspacesOperations | ||
:param credential: Credential needed for the client to connect to Azure. Required. | ||
:type credential: ~azure.core.credentials.TokenCredential | ||
:param subscription_id: Gets subscription credentials which uniquely identify a Microsoft Azure | ||
subscription. The subscription ID forms part of the URI for every service call. Required. | ||
:type subscription_id: str | ||
:param base_url: Service URL. Default value is "https://management.azure.com". | ||
:type base_url: str | ||
:keyword api_version: Api Version. Default value is "2016-01-29". Note that overriding this | ||
default value may result in unsupported behavior. | ||
:paramtype api_version: 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 = PowerBIEmbeddedManagementClientConfiguration( | ||
credential=credential, subscription_id=subscription_id, **kwargs | ||
) | ||
_policies = kwargs.pop("policies", None) | ||
if _policies is None: | ||
_policies = [ | ||
policies.RequestIdPolicy(**kwargs), | ||
self._config.headers_policy, | ||
self._config.user_agent_policy, | ||
self._config.proxy_policy, | ||
policies.ContentDecodePolicy(**kwargs), | ||
ARMAutoResourceProviderRegistrationPolicy(), | ||
self._config.redirect_policy, | ||
self._config.retry_policy, | ||
self._config.authentication_policy, | ||
self._config.custom_hook_policy, | ||
self._config.logging_policy, | ||
policies.DistributedTracingPolicy(**kwargs), | ||
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, | ||
self._config.http_logging_policy, | ||
] | ||
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, policies=_policies, **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.workspace_collections = WorkspaceCollectionsOperations( | ||
self._client, self._config, self._serialize, self._deserialize | ||
) | ||
self.workspaces = WorkspacesOperations(self._client, self._config, self._serialize, self._deserialize) | ||
|
||
def _send_request(self, request: HttpRequest, *, stream: bool = False, **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/dpcodegen/python/send_request | ||
: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, stream=stream, **kwargs) # type: ignore | ||
|
||
def close(self) -> None: | ||
self._client.close() | ||
|
||
def __enter__(self) -> "PowerBIEmbeddedManagementClient": | ||
self._client.__enter__() | ||
return self | ||
|
||
def __exit__(self, *exc_details: Any) -> None: | ||
self._client.__exit__(*exc_details) |
Oops, something went wrong.