Skip to content

Commit aeed631

Browse files
author
SDKAuto
committed
CodeGen from PR 34351 in Azure/azure-rest-api-specs
Merge 1bd65de03c2a67dd5184228e73bdcdcc65ed9da6 into b3dfafdf8ef76a48e56f0e1916f5155993005cab
1 parent 3b2d219 commit aeed631

Some content is hidden

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

57 files changed

+11024
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Release History
2+
3+
## 1.0.0b1 (2025-05-06)
4+
5+
### Other Changes
6+
7+
- Initial version
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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
include _meta.json
2+
recursive-include tests *.py *.json
3+
recursive-include samples *.py *.md
4+
include *.md
5+
include azure/__init__.py
6+
include azure/mgmt/__init__.py
7+
include LICENSE
8+
include azure/mgmt/fileshares/py.typed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Microsoft Azure SDK for Python
2+
3+
This is the Microsoft Azure Fileshares Management Client Library.
4+
This package has been tested with Python 3.9+.
5+
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
6+
7+
## _Disclaimer_
8+
9+
_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_
10+
11+
## Getting started
12+
13+
### Prerequisites
14+
15+
- Python 3.9+ is required to use this package.
16+
- [Azure subscription](https://azure.microsoft.com/free/)
17+
18+
### Install the package
19+
20+
```bash
21+
pip install azure-mgmt-fileshares
22+
pip install azure-identity
23+
```
24+
25+
### Authentication
26+
27+
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.
28+
29+
- `AZURE_CLIENT_ID` for Azure client ID.
30+
- `AZURE_TENANT_ID` for Azure tenant ID.
31+
- `AZURE_CLIENT_SECRET` for Azure client secret.
32+
33+
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
34+
35+
With above configuration, client can be authenticated by following code:
36+
37+
```python
38+
from azure.identity import DefaultAzureCredential
39+
from azure.mgmt.fileshares import FileSharesClient
40+
import os
41+
42+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
43+
client = FileSharesClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
44+
```
45+
46+
## Examples
47+
48+
Code samples for this package can be found at:
49+
- [Search Fileshares Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
50+
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
51+
52+
53+
## Troubleshooting
54+
55+
## Next steps
56+
57+
## Provide Feedback
58+
59+
If you encounter any bugs or have suggestions, please file an issue in the
60+
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
61+
section of the project.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "820a5b0d327e8090333a074fec74eb75416849ca",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/fileshares/FileShares.Management",
5+
"@azure-tools/typespec-python": "0.44.1"
6+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
{
2+
"CrossLanguagePackageId": "Microsoft.FileShares",
3+
"CrossLanguageDefinitionId": {
4+
"azure.mgmt.fileshares.models.CheckNameAvailabilityRequest": "Azure.ResourceManager.CommonTypes.CheckNameAvailabilityRequest",
5+
"azure.mgmt.fileshares.models.CheckNameAvailabilityResponse": "Azure.ResourceManager.CommonTypes.CheckNameAvailabilityResponse",
6+
"azure.mgmt.fileshares.models.ErrorAdditionalInfo": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo",
7+
"azure.mgmt.fileshares.models.ErrorDetail": "Azure.ResourceManager.CommonTypes.ErrorDetail",
8+
"azure.mgmt.fileshares.models.ErrorResponse": "Azure.ResourceManager.CommonTypes.ErrorResponse",
9+
"azure.mgmt.fileshares.models.Resource": "Azure.ResourceManager.CommonTypes.Resource",
10+
"azure.mgmt.fileshares.models.TrackedResource": "Azure.ResourceManager.CommonTypes.TrackedResource",
11+
"azure.mgmt.fileshares.models.FileShare": "Microsoft.FileShares.FileShare",
12+
"azure.mgmt.fileshares.models.FileShareProperties": "Microsoft.FileShares.FileShareProperties",
13+
"azure.mgmt.fileshares.models.ProxyResource": "Azure.ResourceManager.CommonTypes.ProxyResource",
14+
"azure.mgmt.fileshares.models.FileShareSnapshot": "Microsoft.FileShares.FileShareSnapshot",
15+
"azure.mgmt.fileshares.models.FileShareSnapshotProperties": "Microsoft.FileShares.FileShareSnapshotProperties",
16+
"azure.mgmt.fileshares.models.FileShareSnapshotUpdate": "Azure.ResourceManager.Foundations.ResourceUpdateModel",
17+
"azure.mgmt.fileshares.models.FileShareSnapshotUpdateProperties": "Azure.ResourceManager.Foundations.ResourceUpdateModelProperties",
18+
"azure.mgmt.fileshares.models.FileShareUpdate": "Azure.ResourceManager.Foundations.ResourceUpdateModel",
19+
"azure.mgmt.fileshares.models.FileShareUpdateProperties": "Azure.ResourceManager.Foundations.ResourceUpdateModelProperties",
20+
"azure.mgmt.fileshares.models.NfsProtocolProperties": "Microsoft.FileShares.NfsProtocolProperties",
21+
"azure.mgmt.fileshares.models.Operation": "Azure.ResourceManager.CommonTypes.Operation",
22+
"azure.mgmt.fileshares.models.OperationDisplay": "Azure.ResourceManager.CommonTypes.OperationDisplay",
23+
"azure.mgmt.fileshares.models.PrivateEndpoint": "Azure.ResourceManager.CommonTypes.PrivateEndpoint",
24+
"azure.mgmt.fileshares.models.PrivateEndpointConnection": "Azure.ResourceManager.CommonTypes.PrivateEndpointConnection",
25+
"azure.mgmt.fileshares.models.PrivateEndpointConnectionProperties": "Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionProperties",
26+
"azure.mgmt.fileshares.models.PrivateLinkServiceConnectionState": "Azure.ResourceManager.CommonTypes.PrivateLinkServiceConnectionState",
27+
"azure.mgmt.fileshares.models.PublicAccessProperties": "Microsoft.FileShares.PublicAccessProperties",
28+
"azure.mgmt.fileshares.models.SystemData": "Azure.ResourceManager.CommonTypes.SystemData",
29+
"azure.mgmt.fileshares.models.CreatedByType": "Azure.ResourceManager.CommonTypes.createdByType",
30+
"azure.mgmt.fileshares.models.MediaTier": "Microsoft.FileShares.MediaTier",
31+
"azure.mgmt.fileshares.models.Redundancy": "Microsoft.FileShares.Redundancy",
32+
"azure.mgmt.fileshares.models.Protocol": "Microsoft.FileShares.Protocol",
33+
"azure.mgmt.fileshares.models.ShareRootSquash": "Microsoft.FileShares.ShareRootSquash",
34+
"azure.mgmt.fileshares.models.FileShareProvisioningState": "Microsoft.FileShares.FileShareProvisioningState",
35+
"azure.mgmt.fileshares.models.PublicNetworkAccess": "Microsoft.FileShares.PublicNetworkAccess",
36+
"azure.mgmt.fileshares.models.PrivateEndpointServiceConnectionStatus": "Azure.ResourceManager.CommonTypes.PrivateEndpointServiceConnectionStatus",
37+
"azure.mgmt.fileshares.models.PrivateEndpointConnectionProvisioningState": "Azure.ResourceManager.CommonTypes.PrivateEndpointConnectionProvisioningState",
38+
"azure.mgmt.fileshares.models.CheckNameAvailabilityReason": "Azure.ResourceManager.CommonTypes.CheckNameAvailabilityReason",
39+
"azure.mgmt.fileshares.models.Origin": "Azure.ResourceManager.CommonTypes.Origin",
40+
"azure.mgmt.fileshares.models.ActionType": "Azure.ResourceManager.CommonTypes.ActionType",
41+
"azure.mgmt.fileshares.operations.FileSharesOperations.get": "Microsoft.FileShares.FileShares.get",
42+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.get": "Microsoft.FileShares.FileShares.get",
43+
"azure.mgmt.fileshares.operations.FileSharesOperations.begin_create_or_update": "Microsoft.FileShares.FileShares.createOrUpdate",
44+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.begin_create_or_update": "Microsoft.FileShares.FileShares.createOrUpdate",
45+
"azure.mgmt.fileshares.operations.FileSharesOperations.begin_update": "Microsoft.FileShares.FileShares.update",
46+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.begin_update": "Microsoft.FileShares.FileShares.update",
47+
"azure.mgmt.fileshares.operations.FileSharesOperations.begin_delete": "Microsoft.FileShares.FileShares.delete",
48+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.begin_delete": "Microsoft.FileShares.FileShares.delete",
49+
"azure.mgmt.fileshares.operations.FileSharesOperations.list_by_subscription": "Microsoft.FileShares.FileShares.listBySubscription",
50+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.list_by_subscription": "Microsoft.FileShares.FileShares.listBySubscription",
51+
"azure.mgmt.fileshares.operations.FileSharesOperations.list_by_parent": "Microsoft.FileShares.FileShares.listByParent",
52+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.list_by_parent": "Microsoft.FileShares.FileShares.listByParent",
53+
"azure.mgmt.fileshares.operations.FileSharesOperations.check_name_availability": "Microsoft.FileShares.FileShares.checkNameAvailability",
54+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.check_name_availability": "Microsoft.FileShares.FileShares.checkNameAvailability",
55+
"azure.mgmt.fileshares.operations.FileSharesOperations.get_file_share_snapshot": "Microsoft.FileShares.FileShares.getFileShareSnapshot",
56+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.get_file_share_snapshot": "Microsoft.FileShares.FileShares.getFileShareSnapshot",
57+
"azure.mgmt.fileshares.operations.FileSharesOperations.create_or_update_file_share_snapshot": "Microsoft.FileShares.FileShares.createOrUpdateFileShareSnapshot",
58+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.create_or_update_file_share_snapshot": "Microsoft.FileShares.FileShares.createOrUpdateFileShareSnapshot",
59+
"azure.mgmt.fileshares.operations.FileSharesOperations.begin_update_file_share_snapshot": "Microsoft.FileShares.FileShares.updateFileShareSnapshot",
60+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.begin_update_file_share_snapshot": "Microsoft.FileShares.FileShares.updateFileShareSnapshot",
61+
"azure.mgmt.fileshares.operations.FileSharesOperations.begin_delete_file_share_snapshot": "Microsoft.FileShares.FileShares.deleteFileShareSnapshot",
62+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.begin_delete_file_share_snapshot": "Microsoft.FileShares.FileShares.deleteFileShareSnapshot",
63+
"azure.mgmt.fileshares.operations.FileSharesOperations.list_by_file_share": "Microsoft.FileShares.FileShares.listByFileShare",
64+
"azure.mgmt.fileshares.aio.operations.FileSharesOperations.list_by_file_share": "Microsoft.FileShares.FileShares.listByFileShare",
65+
"azure.mgmt.fileshares.operations.Operations.list": "Microsoft.FileShares.Operations.list",
66+
"azure.mgmt.fileshares.aio.operations.Operations.list": "Microsoft.FileShares.Operations.list"
67+
}
68+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
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 FileSharesClient # 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+
"FileSharesClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
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, Optional, TYPE_CHECKING, cast
11+
from typing_extensions import Self
12+
13+
from azure.core.pipeline import policies
14+
from azure.core.rest import HttpRequest, HttpResponse
15+
from azure.core.settings import settings
16+
from azure.mgmt.core import ARMPipelineClient
17+
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
18+
from azure.mgmt.core.tools import get_arm_endpoints
19+
20+
from ._configuration import FileSharesClientConfiguration
21+
from ._utils.serialization import Deserializer, Serializer
22+
from .operations import FileSharesOperations, Operations
23+
24+
if TYPE_CHECKING:
25+
from azure.core.credentials import TokenCredential
26+
27+
28+
class FileSharesClient:
29+
"""Azure File Shares Resource Provider API.
30+
31+
:ivar file_shares: FileSharesOperations operations
32+
:vartype file_shares: azure.mgmt.fileshares.operations.FileSharesOperations
33+
:ivar operations: Operations operations
34+
:vartype operations: azure.mgmt.fileshares.operations.Operations
35+
:param credential: Credential used to authenticate requests to the service. Required.
36+
:type credential: ~azure.core.credentials.TokenCredential
37+
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
38+
:type subscription_id: str
39+
:param base_url: Service host. Default value is None.
40+
:type base_url: str
41+
:keyword api_version: The API version to use for this operation. Default value is
42+
"2024-01-01-preview". Note that overriding this default value may result in unsupported
43+
behavior.
44+
:paramtype api_version: str
45+
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
46+
Retry-After header is present.
47+
"""
48+
49+
def __init__(
50+
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
51+
) -> None:
52+
_endpoint = "{endpoint}"
53+
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
54+
_endpoints = get_arm_endpoints(_cloud)
55+
if not base_url:
56+
base_url = _endpoints["resource_manager"]
57+
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
58+
self._config = FileSharesClientConfiguration(
59+
credential=credential,
60+
subscription_id=subscription_id,
61+
base_url=cast(str, base_url),
62+
credential_scopes=credential_scopes,
63+
**kwargs
64+
)
65+
66+
_policies = kwargs.pop("policies", None)
67+
if _policies is None:
68+
_policies = [
69+
policies.RequestIdPolicy(**kwargs),
70+
self._config.headers_policy,
71+
self._config.user_agent_policy,
72+
self._config.proxy_policy,
73+
policies.ContentDecodePolicy(**kwargs),
74+
ARMAutoResourceProviderRegistrationPolicy(),
75+
self._config.redirect_policy,
76+
self._config.retry_policy,
77+
self._config.authentication_policy,
78+
self._config.custom_hook_policy,
79+
self._config.logging_policy,
80+
policies.DistributedTracingPolicy(**kwargs),
81+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
82+
self._config.http_logging_policy,
83+
]
84+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, _endpoint), policies=_policies, **kwargs)
85+
86+
self._serialize = Serializer()
87+
self._deserialize = Deserializer()
88+
self._serialize.client_side_validation = False
89+
self.file_shares = FileSharesOperations(self._client, self._config, self._serialize, self._deserialize)
90+
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
91+
92+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
93+
"""Runs the network request through the client's chained policies.
94+
95+
>>> from azure.core.rest import HttpRequest
96+
>>> request = HttpRequest("GET", "https://www.example.org/")
97+
<HttpRequest [GET], url: 'https://www.example.org/'>
98+
>>> response = client.send_request(request)
99+
<HttpResponse: 200 OK>
100+
101+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
102+
103+
:param request: The network request you want to make. Required.
104+
:type request: ~azure.core.rest.HttpRequest
105+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
106+
:return: The response of your network call. Does not do error handling on your response.
107+
:rtype: ~azure.core.rest.HttpResponse
108+
"""
109+
110+
request_copy = deepcopy(request)
111+
path_format_arguments = {
112+
"endpoint": self._serialize.url("self._config.base_url", self._config.base_url, "str", skip_quote=True),
113+
}
114+
115+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
116+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
117+
118+
def close(self) -> None:
119+
self._client.close()
120+
121+
def __enter__(self) -> Self:
122+
self._client.__enter__()
123+
return self
124+
125+
def __exit__(self, *exc_details: Any) -> None:
126+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)