Skip to content

Commit 86c4306

Browse files
author
SDKAuto
committed
CodeGen from PR 31060 in Azure/azure-rest-api-specs
Merge 0bddfc460fe46c97388a583999f342f295e0fe60 into b0014d135f949a3db605b0b0999206f077acedd1
1 parent ff36cdb commit 86c4306

37 files changed

+5598
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release History
2+
3+
## 1.0.0b1 (1970-01-01)
4+
5+
- Initial version
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include *.md
2+
include LICENSE
3+
include azure/keyvault/securitydomain/py.typed
4+
recursive-include tests *.py
5+
recursive-include samples *.py *.md
6+
include azure/__init__.py
7+
include azure/keyvault/__init__.py
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
2+
3+
# Azure Keyvault Securitydomain client library for Python
4+
<!-- write necessary description of service -->
5+
6+
## Getting started
7+
8+
### Install the package
9+
10+
```bash
11+
python -m pip install azure-keyvault-securitydomain
12+
```
13+
14+
#### Prequisites
15+
16+
- Python 3.8 or later is required to use this package.
17+
- You need an [Azure subscription][azure_sub] to use this package.
18+
- An existing Azure Keyvault Securitydomain instance.
19+
#### Create with an Azure Active Directory Credential
20+
To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
21+
provide an instance of the desired credential type obtained from the
22+
[azure-identity][azure_identity_credentials] library.
23+
24+
To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
25+
26+
After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
27+
As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
28+
29+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
30+
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
31+
32+
Use the returned token credential to authenticate the client:
33+
34+
```python
35+
>>> from azure.keyvault.securitydomain import KeyVaultClient
36+
>>> from azure.identity import DefaultAzureCredential
37+
>>> client = KeyVaultClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
38+
```
39+
40+
## Examples
41+
42+
```python
43+
>>> from azure.keyvault.securitydomain import KeyVaultClient
44+
>>> from azure.identity import DefaultAzureCredential
45+
>>> from azure.core.exceptions import HttpResponseError
46+
47+
>>> client = KeyVaultClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
48+
>>> try:
49+
<!-- write test code here -->
50+
except HttpResponseError as e:
51+
print('service responds error: {}'.format(e.response.json()))
52+
53+
```
54+
55+
## Contributing
56+
57+
This project welcomes contributions and suggestions. Most contributions require
58+
you to agree to a Contributor License Agreement (CLA) declaring that you have
59+
the right to, and actually do, grant us the rights to use your contribution.
60+
For details, visit https://cla.microsoft.com.
61+
62+
When you submit a pull request, a CLA-bot will automatically determine whether
63+
you need to provide a CLA and decorate the PR appropriately (e.g., label,
64+
comment). Simply follow the instructions provided by the bot. You will only
65+
need to do this once across all repos using our CLA.
66+
67+
This project has adopted the
68+
[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
69+
see the Code of Conduct FAQ or contact [email protected] with any
70+
additional questions or comments.
71+
72+
<!-- LINKS -->
73+
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
74+
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
75+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
76+
[azure_identity_pip]: https://pypi.org/project/azure-identity/
77+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
78+
[pip]: https://pypi.org/project/pip/
79+
[azure_sub]: https://azure.microsoft.com/free/
80+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "8b53908b9cb4984eceb5a588b926453ec51989c2",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/keyvault/Security.KeyVault.SecurityDomain",
5+
"@azure-tools/typespec-python": "0.39.1"
6+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"CrossLanguagePackageId": "KeyVault",
3+
"CrossLanguageDefinitionId": {
4+
"azure.keyvault.securitydomain.models.CertificateInfoObject": "KeyVault.CertificateInfoObject",
5+
"azure.keyvault.securitydomain.models.KeyVaultError": "KeyVaultError",
6+
"azure.keyvault.securitydomain.models.KeyVaultErrorError": "KeyVaultError.error.anonymous",
7+
"azure.keyvault.securitydomain.models.SecurityDomainJsonWebKey": "KeyVault.SecurityDomainJsonWebKey",
8+
"azure.keyvault.securitydomain.models.SecurityDomainObject": "KeyVault.SecurityDomainObject",
9+
"azure.keyvault.securitydomain.models.SecurityDomainOperationStatus": "KeyVault.SecurityDomainOperationStatus",
10+
"azure.keyvault.securitydomain.models.TransferKey": "KeyVault.TransferKey",
11+
"azure.keyvault.securitydomain.models.OperationStatus": "KeyVault.OperationStatus",
12+
"azure.keyvault.securitydomain.KeyVaultClient.get_download_status": "ClientCustomizations.KeyVaultClient.getDownloadStatus",
13+
"azure.keyvault.securitydomain.KeyVaultClient.get_upload_status": "ClientCustomizations.KeyVaultClient.getUploadStatus",
14+
"azure.keyvault.securitydomain.KeyVaultClient.get_transfer_key": "ClientCustomizations.KeyVaultClient.getTransferKey"
15+
}
16+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
# pylint: disable=wrong-import-position
9+
10+
from typing import TYPE_CHECKING
11+
12+
if TYPE_CHECKING:
13+
from ._patch import * # pylint: disable=unused-wildcard-import
14+
15+
from ._client import KeyVaultClient # type: ignore
16+
from ._version import VERSION
17+
18+
__version__ = VERSION
19+
20+
try:
21+
from ._patch import __all__ as _patch_all
22+
from ._patch import *
23+
except ImportError:
24+
_patch_all = []
25+
from ._patch import patch_sdk as _patch_sdk
26+
27+
__all__ = [
28+
"KeyVaultClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from copy import deepcopy
10+
from typing import Any, TYPE_CHECKING
11+
from typing_extensions import Self
12+
13+
from azure.core import PipelineClient
14+
from azure.core.pipeline import policies
15+
from azure.core.rest import HttpRequest, HttpResponse
16+
17+
from ._configuration import KeyVaultClientConfiguration
18+
from ._operations import KeyVaultClientOperationsMixin
19+
from ._serialization import Deserializer, Serializer
20+
21+
if TYPE_CHECKING:
22+
from azure.core.credentials import TokenCredential
23+
24+
25+
class KeyVaultClient(KeyVaultClientOperationsMixin):
26+
"""KeyVaultClient.
27+
28+
:param vault_base_url: Required.
29+
:type vault_base_url: str
30+
:param credential: Credential used to authenticate requests to the service. Required.
31+
:type credential: ~azure.core.credentials.TokenCredential
32+
:keyword api_version: The API version to use for this operation. Default value is "7.5". Note
33+
that overriding this default value may result in unsupported behavior.
34+
:paramtype api_version: str
35+
"""
36+
37+
def __init__(self, vault_base_url: str, credential: "TokenCredential", **kwargs: Any) -> None:
38+
_endpoint = "{vaultBaseUrl}"
39+
self._config = KeyVaultClientConfiguration(vault_base_url=vault_base_url, credential=credential, **kwargs)
40+
_policies = kwargs.pop("policies", None)
41+
if _policies is None:
42+
_policies = [
43+
policies.RequestIdPolicy(**kwargs),
44+
self._config.headers_policy,
45+
self._config.user_agent_policy,
46+
self._config.proxy_policy,
47+
policies.ContentDecodePolicy(**kwargs),
48+
self._config.redirect_policy,
49+
self._config.retry_policy,
50+
self._config.authentication_policy,
51+
self._config.custom_hook_policy,
52+
self._config.logging_policy,
53+
policies.DistributedTracingPolicy(**kwargs),
54+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
55+
self._config.http_logging_policy,
56+
]
57+
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
58+
59+
self._serialize = Serializer()
60+
self._deserialize = Deserializer()
61+
self._serialize.client_side_validation = False
62+
63+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
64+
"""Runs the network request through the client's chained policies.
65+
66+
>>> from azure.core.rest import HttpRequest
67+
>>> request = HttpRequest("GET", "https://www.example.org/")
68+
<HttpRequest [GET], url: 'https://www.example.org/'>
69+
>>> response = client.send_request(request)
70+
<HttpResponse: 200 OK>
71+
72+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
73+
74+
:param request: The network request you want to make. Required.
75+
:type request: ~azure.core.rest.HttpRequest
76+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
77+
:return: The response of your network call. Does not do error handling on your response.
78+
:rtype: ~azure.core.rest.HttpResponse
79+
"""
80+
81+
request_copy = deepcopy(request)
82+
path_format_arguments = {
83+
"vaultBaseUrl": self._serialize.url(
84+
"self._config.vault_base_url", self._config.vault_base_url, "str", skip_quote=True
85+
),
86+
}
87+
88+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
89+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
90+
91+
def close(self) -> None:
92+
self._client.close()
93+
94+
def __enter__(self) -> Self:
95+
self._client.__enter__()
96+
return self
97+
98+
def __exit__(self, *exc_details: Any) -> None:
99+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)