Skip to content

Commit 23bd34b

Browse files
author
SDKAuto
committed
CodeGen from PR 34631 in Azure/azure-rest-api-specs
Merge 5afe59a92e729a1560e9a3d44cede1709b858b34 into c269b7b78cac2808d7acc55124a9653b2e904e4b
1 parent 0346175 commit 23bd34b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+6014
-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/developer/trustedsigning/py.typed
4+
recursive-include tests *.py
5+
recursive-include samples *.py *.md
6+
include azure/__init__.py
7+
include azure/developer/__init__.py
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Azure Developer Trustedsigning client library for Python
2+
<!-- write necessary description of service -->
3+
4+
## Getting started
5+
6+
### Install the package
7+
8+
```bash
9+
python -m pip install azure-developer-trustedsigning
10+
```
11+
12+
#### Prequisites
13+
14+
- Python 3.9 or later is required to use this package.
15+
- You need an [Azure subscription][azure_sub] to use this package.
16+
- An existing Azure Developer Trustedsigning instance.
17+
18+
#### Create with an Azure Active Directory Credential
19+
To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
20+
provide an instance of the desired credential type obtained from the
21+
[azure-identity][azure_identity_credentials] library.
22+
23+
To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
24+
25+
After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
26+
As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
27+
28+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
29+
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
30+
31+
Use the returned token credential to authenticate the client:
32+
33+
```python
34+
>>> from azure.developer.trustedsigning import TrustedSigningClient
35+
>>> from azure.identity import DefaultAzureCredential
36+
>>> client = TrustedSigningClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
37+
```
38+
39+
## Examples
40+
41+
```python
42+
>>> from azure.developer.trustedsigning import TrustedSigningClient
43+
>>> from azure.identity import DefaultAzureCredential
44+
>>> from azure.core.exceptions import HttpResponseError
45+
46+
>>> client = TrustedSigningClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
47+
>>> try:
48+
<!-- write test code here -->
49+
except HttpResponseError as e:
50+
print('service responds error: {}'.format(e.response.json()))
51+
52+
```
53+
54+
## Contributing
55+
56+
This project welcomes contributions and suggestions. Most contributions require
57+
you to agree to a Contributor License Agreement (CLA) declaring that you have
58+
the right to, and actually do, grant us the rights to use your contribution.
59+
For details, visit https://cla.microsoft.com.
60+
61+
When you submit a pull request, a CLA-bot will automatically determine whether
62+
you need to provide a CLA and decorate the PR appropriately (e.g., label,
63+
comment). Simply follow the instructions provided by the bot. You will only
64+
need to do this once across all repos using our CLA.
65+
66+
This project has adopted the
67+
[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
68+
see the Code of Conduct FAQ or contact [email protected] with any
69+
additional questions or comments.
70+
71+
<!-- LINKS -->
72+
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
73+
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
74+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
75+
[azure_identity_pip]: https://pypi.org/project/azure-identity/
76+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
77+
[pip]: https://pypi.org/project/pip/
78+
[azure_sub]: https://azure.microsoft.com/free/
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "c537a4e6cc3ed95c030b2c10671d1f0585ddcc08",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/trustedsigning/TrustedSigning",
5+
"@azure-tools/typespec-python": "0.44.2"
6+
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"CrossLanguagePackageId": "Azure.Developer.TrustedSigning",
3+
"CrossLanguageDefinitionId": {
4+
"azure.developer.trustedsigning.models.ExtendedKeyUsage": "Azure.Developer.TrustedSigning.ExtendedKeyUsage",
5+
"azure.developer.trustedsigning.models.OperationStatusSignResultError": "Azure.Core.Foundations.OperationStatus",
6+
"azure.developer.trustedsigning.models.SigningPayloadOptions": "Azure.Developer.TrustedSigning.SigningPayloadOptions",
7+
"azure.developer.trustedsigning.models.SignResult": "Azure.Developer.TrustedSigning.SignResult",
8+
"azure.developer.trustedsigning.models.OperationState": "Azure.Core.Foundations.OperationState",
9+
"azure.developer.trustedsigning.models.SignatureAlgorithm": "Azure.Developer.TrustedSigning.SignatureAlgorithm",
10+
"azure.developer.trustedsigning.operations.CertificateProfileOperationsOperations.get_signing_status": "Azure.Developer.TrustedSigning.CertificateProfileOperations.getSigningStatus",
11+
"azure.developer.trustedsigning.aio.operations.CertificateProfileOperationsOperations.get_signing_status": "Azure.Developer.TrustedSigning.CertificateProfileOperations.getSigningStatus",
12+
"azure.developer.trustedsigning.operations.CertificateProfileOperationsOperations.get_sign_root_certificate": "Azure.Developer.TrustedSigning.CertificateProfileOperations.getSignRootCertificate",
13+
"azure.developer.trustedsigning.aio.operations.CertificateProfileOperationsOperations.get_sign_root_certificate": "Azure.Developer.TrustedSigning.CertificateProfileOperations.getSignRootCertificate",
14+
"azure.developer.trustedsigning.operations.CertificateProfileOperationsOperations.list_extended_key_usages": "Azure.Developer.TrustedSigning.CertificateProfileOperations.listExtendedKeyUsages",
15+
"azure.developer.trustedsigning.aio.operations.CertificateProfileOperationsOperations.list_extended_key_usages": "Azure.Developer.TrustedSigning.CertificateProfileOperations.listExtendedKeyUsages",
16+
"azure.developer.trustedsigning.operations.CertificateProfileOperationsOperations.begin_sign": "Azure.Developer.TrustedSigning.CertificateProfileOperations.sign",
17+
"azure.developer.trustedsigning.aio.operations.CertificateProfileOperationsOperations.begin_sign": "Azure.Developer.TrustedSigning.CertificateProfileOperations.sign"
18+
}
19+
}
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 TrustedSigningClient # 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+
"TrustedSigningClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
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 TrustedSigningClientConfiguration
18+
from ._utils.serialization import Deserializer, Serializer
19+
from .operations import CertificateProfileOperationsOperations
20+
21+
if TYPE_CHECKING:
22+
from azure.core.credentials import TokenCredential
23+
24+
25+
class TrustedSigningClient:
26+
"""Azure Trusted Signing is a service that provides managed artifact signing for all.
27+
28+
:ivar certificate_profile_operations: CertificateProfileOperationsOperations operations
29+
:vartype certificate_profile_operations:
30+
azure.developer.trustedsigning.operations.CertificateProfileOperationsOperations
31+
:param endpoint: The Azure Trusted signing service endpoint. Required.
32+
:type endpoint: str
33+
:param credential: Credential used to authenticate requests to the service. Required.
34+
:type credential: ~azure.core.credentials.TokenCredential
35+
:keyword api_version: The API version to use for this operation. Default value is
36+
"2023-06-15-preview". Note that overriding this default value may result in unsupported
37+
behavior.
38+
:paramtype api_version: str
39+
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
40+
Retry-After header is present.
41+
"""
42+
43+
def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
44+
_endpoint = "{endpoint}"
45+
self._config = TrustedSigningClientConfiguration(endpoint=endpoint, credential=credential, **kwargs)
46+
47+
_policies = kwargs.pop("policies", None)
48+
if _policies is None:
49+
_policies = [
50+
policies.RequestIdPolicy(**kwargs),
51+
self._config.headers_policy,
52+
self._config.user_agent_policy,
53+
self._config.proxy_policy,
54+
policies.ContentDecodePolicy(**kwargs),
55+
self._config.redirect_policy,
56+
self._config.retry_policy,
57+
self._config.authentication_policy,
58+
self._config.custom_hook_policy,
59+
self._config.logging_policy,
60+
policies.DistributedTracingPolicy(**kwargs),
61+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
62+
self._config.http_logging_policy,
63+
]
64+
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
65+
66+
self._serialize = Serializer()
67+
self._deserialize = Deserializer()
68+
self._serialize.client_side_validation = False
69+
self.certificate_profile_operations = CertificateProfileOperationsOperations(
70+
self._client, self._config, self._serialize, self._deserialize
71+
)
72+
73+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
74+
"""Runs the network request through the client's chained policies.
75+
76+
>>> from azure.core.rest import HttpRequest
77+
>>> request = HttpRequest("GET", "https://www.example.org/")
78+
<HttpRequest [GET], url: 'https://www.example.org/'>
79+
>>> response = client.send_request(request)
80+
<HttpResponse: 200 OK>
81+
82+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
83+
84+
:param request: The network request you want to make. Required.
85+
:type request: ~azure.core.rest.HttpRequest
86+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
87+
:return: The response of your network call. Does not do error handling on your response.
88+
:rtype: ~azure.core.rest.HttpResponse
89+
"""
90+
91+
request_copy = deepcopy(request)
92+
path_format_arguments = {
93+
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"),
94+
}
95+
96+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
97+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
98+
99+
def close(self) -> None:
100+
self._client.close()
101+
102+
def __enter__(self) -> Self:
103+
self._client.__enter__()
104+
return self
105+
106+
def __exit__(self, *exc_details: Any) -> None:
107+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)