Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 44 additions & 11 deletions sdk/azurearcdata/azure-mgmt-azurearcdata/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,61 @@
# Microsoft Azure SDK for Python

This is the Microsoft Azure Azure Arc Data Management Client Library.
This package has been tested with Python 3.7+.
This package has been tested with Python 3.9+.
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)

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 [Azure Arc Data 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)
- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

# Provide Feedback
```bash
pip install azure-mgmt-azurearcdata
pip install azure-identity
```

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.
### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the 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.azurearcdata import AzureArcDataManagementClient
import os

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

## Examples

Code samples for this package can be found at:
- [Search Azure Arc Data 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.
10 changes: 5 additions & 5 deletions sdk/azurearcdata/azure-mgmt-azurearcdata/_meta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"commit": "be6cd9ccfcb6ba08c1c206627026eabfbff31fc1",
"commit": "4c6d0481729ff095999f4edf219bd68f9347d719",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"autorest": "3.9.2",
"autorest": "3.10.2",
"use": [
"@autorest/python@6.2.7",
"@autorest/modelerfour@4.24.3"
"@autorest/python@6.34.1",
"@autorest/modelerfour@4.27.0"
],
"autorest_command": "autorest specification/azurearcdata/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/home/vsts/work/1/azure-sdk-for-python/sdk --use=@autorest/python@6.2.7 --use=@autorest/modelerfour@4.24.3 --version=3.9.2 --version-tolerant=False",
"autorest_command": "autorest specification/azurearcdata/resource-manager/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.34.1 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False",
"readme": "specification/azurearcdata/resource-manager/readme.md"
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,28 @@
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=wrong-import-position

from ._azure_arc_data_management_client import AzureArcDataManagementClient
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from ._patch import * # pylint: disable=unused-wildcard-import

from ._azure_arc_data_management_client import AzureArcDataManagementClient # type: ignore
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
from ._patch import * # pylint: disable=unused-wildcard-import
from ._patch import *
except ImportError:
_patch_all = []
from ._patch import patch_sdk as _patch_sdk

__all__ = [
"AzureArcDataManagementClient",
]
__all__.extend([p for p in _patch_all if p not in __all__])
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore

_patch_sdk()
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,38 @@
# --------------------------------------------------------------------------

from copy import deepcopy
from typing import Any, TYPE_CHECKING
from typing import Any, Optional, TYPE_CHECKING, cast
from typing_extensions import Self

from azure.core.pipeline import policies
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.settings import settings
from azure.mgmt.core import ARMPipelineClient
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
from azure.mgmt.core.tools import get_arm_endpoints

from . import models as _models
from ._configuration import AzureArcDataManagementClientConfiguration
from ._serialization import Deserializer, Serializer
from ._utils.serialization import Deserializer, Serializer
from .operations import (
ActiveDirectoryConnectorsOperations,
DataControllersOperations,
FailoverGroupsOperations,
Operations,
PostgresInstancesOperations,
SqlManagedInstancesOperations,
SqlServerAvailabilityGroupsOperations,
SqlServerDatabasesOperations,
SqlServerEsuLicensesOperations,
SqlServerInstancesOperations,
SqlServerLicensesOperations,
)

if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from azure.core.credentials import TokenCredential


class AzureArcDataManagementClient: # pylint: disable=client-accepts-api-version-keyword
class AzureArcDataManagementClient: # pylint: disable=too-many-instance-attributes
"""The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data
Services on Azure Arc Resources.
Expand All @@ -38,39 +47,71 @@ class AzureArcDataManagementClient: # pylint: disable=client-accepts-api-versio
:ivar sql_managed_instances: SqlManagedInstancesOperations operations
:vartype sql_managed_instances:
azure.mgmt.azurearcdata.operations.SqlManagedInstancesOperations
:ivar failover_groups: FailoverGroupsOperations operations
:vartype failover_groups: azure.mgmt.azurearcdata.operations.FailoverGroupsOperations
:ivar sql_server_instances: SqlServerInstancesOperations operations
:vartype sql_server_instances: azure.mgmt.azurearcdata.operations.SqlServerInstancesOperations
:ivar sql_server_licenses: SqlServerLicensesOperations operations
:vartype sql_server_licenses: azure.mgmt.azurearcdata.operations.SqlServerLicensesOperations
:ivar data_controllers: DataControllersOperations operations
:vartype data_controllers: azure.mgmt.azurearcdata.operations.DataControllersOperations
:ivar active_directory_connectors: ActiveDirectoryConnectorsOperations operations
:vartype active_directory_connectors:
azure.mgmt.azurearcdata.operations.ActiveDirectoryConnectorsOperations
:ivar postgres_instances: PostgresInstancesOperations operations
:vartype postgres_instances: azure.mgmt.azurearcdata.operations.PostgresInstancesOperations
:ivar sql_server_availability_groups: SqlServerAvailabilityGroupsOperations operations
:vartype sql_server_availability_groups:
azure.mgmt.azurearcdata.operations.SqlServerAvailabilityGroupsOperations
:ivar sql_server_databases: SqlServerDatabasesOperations operations
:vartype sql_server_databases: azure.mgmt.azurearcdata.operations.SqlServerDatabasesOperations
:ivar sql_server_esu_licenses: SqlServerEsuLicensesOperations operations
:vartype sql_server_esu_licenses:
azure.mgmt.azurearcdata.operations.SqlServerEsuLicensesOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the Azure subscription. Required.
:type subscription_id: str
:param base_url: Service URL. Default value is "https://management.azure.com".
:param base_url: Service URL. Default value is None.
:type base_url: str
:keyword api_version: Api Version. Default value is "2022-03-01-preview". Note that overriding
:keyword api_version: Api Version. Default value is "2025-03-01-preview". 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
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
) -> None:
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
_endpoints = get_arm_endpoints(_cloud)
if not base_url:
base_url = _endpoints["resource_manager"]
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
self._config = AzureArcDataManagementClientConfiguration(
credential=credential, subscription_id=subscription_id, **kwargs
credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs
)
self._client = ARMPipelineClient(base_url=base_url, config=self._config, **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=cast(str, 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)
Expand All @@ -80,9 +121,13 @@ def __init__(
self.sql_managed_instances = SqlManagedInstancesOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.failover_groups = FailoverGroupsOperations(self._client, self._config, self._serialize, self._deserialize)
self.sql_server_instances = SqlServerInstancesOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.sql_server_licenses = SqlServerLicensesOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.data_controllers = DataControllersOperations(
self._client, self._config, self._serialize, self._deserialize
)
Expand All @@ -92,8 +137,17 @@ def __init__(
self.postgres_instances = PostgresInstancesOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.sql_server_availability_groups = SqlServerAvailabilityGroupsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.sql_server_databases = SqlServerDatabasesOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.sql_server_esu_licenses = SqlServerEsuLicensesOperations(
self._client, self._config, self._serialize, self._deserialize
)

def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
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
Expand All @@ -113,14 +167,14 @@ def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:

request_copy = deepcopy(request)
request_copy.url = self._client.format_url(request_copy.url)
return self._client.send_request(request_copy, **kwargs)
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore

def close(self) -> None:
self._client.close()

def __enter__(self) -> "AzureArcDataManagementClient":
def __enter__(self) -> Self:
self._client.__enter__()
return self

def __exit__(self, *exc_details) -> None:
def __exit__(self, *exc_details: Any) -> None:
self._client.__exit__(*exc_details)
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,18 @@
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

import sys
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 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

if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from azure.core.credentials import TokenCredential


class AzureArcDataManagementClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes
class AzureArcDataManagementClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
"""Configuration for AzureArcDataManagementClient.

Note that all parameters used to create this instance are saved as instance
Expand All @@ -35,14 +27,13 @@ class AzureArcDataManagementClientConfiguration(Configuration): # pylint: disab
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the Azure subscription. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2022-03-01-preview". Note that overriding
:keyword api_version: Api Version. Default value is "2025-03-01-preview". 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:
super(AzureArcDataManagementClientConfiguration, self).__init__(**kwargs)
api_version: Literal["2022-03-01-preview"] = kwargs.pop("api_version", "2022-03-01-preview")
api_version: str = kwargs.pop("api_version", "2025-03-01-preview")

if credential is None:
raise ValueError("Parameter 'credential' must not be None.")
Expand All @@ -54,6 +45,7 @@ def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs
self.api_version = api_version
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
kwargs.setdefault("sdk_moniker", "mgmt-azurearcdata/{}".format(VERSION))
self.polling_interval = kwargs.get("polling_interval", 30)
self._configure(**kwargs)

def _configure(self, **kwargs: Any) -> None:
Expand All @@ -62,9 +54,9 @@ def _configure(self, **kwargs: Any) -> None:
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.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(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# --------------------------------------------------------------------------
# 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.
# --------------------------------------------------------------------------
Loading