id
int64 0
843k
| repository_name
stringlengths 7
55
| file_path
stringlengths 9
332
| class_name
stringlengths 3
290
| human_written_code
stringlengths 12
4.36M
| class_skeleton
stringlengths 19
2.2M
| total_program_units
int64 1
9.57k
| total_doc_str
int64 0
4.2k
| AvgCountLine
float64 0
7.89k
| AvgCountLineBlank
float64 0
300
| AvgCountLineCode
float64 0
7.89k
| AvgCountLineComment
float64 0
7.89k
| AvgCyclomatic
float64 0
130
| CommentToCodeRatio
float64 0
176
| CountClassBase
float64 0
48
| CountClassCoupled
float64 0
589
| CountClassCoupledModified
float64 0
581
| CountClassDerived
float64 0
5.37k
| CountDeclInstanceMethod
float64 0
4.2k
| CountDeclInstanceVariable
float64 0
299
| CountDeclMethod
float64 0
4.2k
| CountDeclMethodAll
float64 0
4.2k
| CountLine
float64 1
115k
| CountLineBlank
float64 0
9.01k
| CountLineCode
float64 0
94.4k
| CountLineCodeDecl
float64 0
46.1k
| CountLineCodeExe
float64 0
91.3k
| CountLineComment
float64 0
27k
| CountStmt
float64 1
93.2k
| CountStmtDecl
float64 0
46.1k
| CountStmtExe
float64 0
90.2k
| MaxCyclomatic
float64 0
759
| MaxInheritanceTree
float64 0
16
| MaxNesting
float64 0
34
| SumCyclomatic
float64 0
6k
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
10,700 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/generated/action.py
|
azext_costmanagement.generated.action.AddQueryTimePeriod
|
class AddQueryTimePeriod(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
action = self.get_action(values, option_string)
namespace.query_time_period = action
def get_action(self, values, option_string): # pylint: disable=no-self-use
try:
properties = defaultdict(list)
for (k, v) in (x.split('=', 1) for x in values):
properties[k].append(v)
properties = dict(properties)
except ValueError:
raise CLIError('usage error: {} [KEY=VALUE ...]'.format(option_string))
d = {}
for k in properties:
kl = k.lower()
v = properties[k]
if kl == 'from':
d['from_property'] = v[0]
elif kl == 'to':
d['to'] = v[0]
return d
|
class AddQueryTimePeriod(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
pass
def get_action(self, values, option_string):
pass
| 3 | 0 | 10 | 0 | 10 | 1 | 4 | 0.05 | 1 | 3 | 0 | 0 | 2 | 0 | 2 | 9 | 22 | 1 | 21 | 8 | 18 | 1 | 20 | 8 | 17 | 6 | 3 | 2 | 7 |
10,701 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/generated/action.py
|
azext_costmanagement.generated.action.AddScheduleRecurrencePeriod
|
class AddScheduleRecurrencePeriod(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
action = self.get_action(values, option_string)
namespace.schedule_recurrence_period = action
def get_action(self, values, option_string): # pylint: disable=no-self-use
try:
properties = defaultdict(list)
for (k, v) in (x.split('=', 1) for x in values):
properties[k].append(v)
properties = dict(properties)
except ValueError:
raise CLIError('usage error: {} [KEY=VALUE ...]'.format(option_string))
d = {}
for k in properties:
kl = k.lower()
v = properties[k]
if kl == 'from':
d['from_property'] = v[0]
elif kl == 'to':
d['to'] = v[0]
return d
|
class AddScheduleRecurrencePeriod(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
pass
def get_action(self, values, option_string):
pass
| 3 | 0 | 10 | 0 | 10 | 1 | 4 | 0.05 | 1 | 3 | 0 | 0 | 2 | 0 | 2 | 9 | 22 | 1 | 21 | 8 | 18 | 1 | 20 | 8 | 17 | 6 | 3 | 2 | 7 |
10,702 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/generated/action.py
|
azext_costmanagement.generated.action.AddTimePeriod
|
class AddTimePeriod(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
action = self.get_action(values, option_string)
if hasattr(namespace, 'definition_time_period'):
namespace.definition_time_period = action
if hasattr(namespace, 'time_period'):
namespace.time_period = action
def get_action(self, values, option_string): # pylint: disable=no-self-use
try:
properties = defaultdict(list)
for (k, v) in (x.split('=', 1) for x in values):
properties[k].append(v)
properties = dict(properties)
except ValueError:
raise CLIError('usage error: {} [KEY=VALUE ...]'.format(option_string))
d = {}
for k in properties:
kl = k.lower()
v = properties[k]
if kl == 'from':
d['from_property'] = v[0]
elif kl == 'to':
d['to'] = v[0]
return d
|
class AddTimePeriod(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
pass
def get_action(self, values, option_string):
pass
| 3 | 0 | 12 | 0 | 12 | 1 | 5 | 0.04 | 1 | 3 | 0 | 0 | 2 | 0 | 2 | 9 | 25 | 1 | 24 | 8 | 21 | 1 | 23 | 8 | 20 | 6 | 3 | 2 | 9 |
10,703 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/_configuration.py
|
azext_costmanagement.vendored_sdks.costmanagement._configuration.CostManagementClientConfiguration
|
class CostManagementClientConfiguration(Configuration):
"""Configuration for CostManagementClient.
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.
:type credential: ~azure.core.credentials.TokenCredential
"""
def __init__(
self,
credential, # type: "TokenCredential"
**kwargs # type: Any
):
# type: (...) -> None
if credential is None:
raise ValueError("Parameter 'credential' must not be None.")
super(CostManagementClientConfiguration, self).__init__(**kwargs)
self.credential = credential
self.api_version = "2020-06-01"
self.credential_scopes = kwargs.pop('credential_scopes', ['https://management.azure.com/.default'])
kwargs.setdefault('sdk_moniker', 'mgmt-costmanagement/{}'.format(VERSION))
self._configure(**kwargs)
def _configure(
self,
**kwargs # type: Any
):
# type: (...) -> 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.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.authentication_policy = kwargs.get('authentication_policy')
if self.credential and not self.authentication_policy:
self.authentication_policy = policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs)
|
class CostManagementClientConfiguration(Configuration):
'''Configuration for CostManagementClient.
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.
:type credential: ~azure.core.credentials.TokenCredential
'''
def __init__(
self,
credential, # type: "TokenCredential"
**kwargs # type: Any
):
pass
def _configure(
self,
**kwargs # type: Any
):
pass
| 3 | 1 | 16 | 1 | 14 | 3 | 2 | 0.38 | 1 | 2 | 0 | 0 | 2 | 12 | 2 | 2 | 42 | 5 | 29 | 22 | 19 | 11 | 22 | 15 | 19 | 2 | 1 | 1 | 4 |
10,704 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/_cost_management_client.py
|
azext_costmanagement.vendored_sdks.costmanagement._cost_management_client.CostManagementClient
|
class CostManagementClient(object):
"""CostManagementClient.
:ivar views: ViewsOperations operations
:vartype views: azure.mgmt.costmanagement.operations.ViewsOperations
:ivar alerts: AlertsOperations operations
:vartype alerts: azure.mgmt.costmanagement.operations.AlertsOperations
:ivar forecast: ForecastOperations operations
:vartype forecast: azure.mgmt.costmanagement.operations.ForecastOperations
:ivar dimensions: DimensionsOperations operations
:vartype dimensions: azure.mgmt.costmanagement.operations.DimensionsOperations
:ivar query: QueryOperations operations
:vartype query: azure.mgmt.costmanagement.operations.QueryOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.costmanagement.operations.Operations
:ivar exports: ExportsOperations operations
:vartype exports: azure.mgmt.costmanagement.operations.ExportsOperations
:param credential: Credential needed for the client to connect to Azure.
:type credential: ~azure.core.credentials.TokenCredential
:param str base_url: Service URL
"""
def __init__(
self,
credential, # type: "TokenCredential"
base_url=None, # type: Optional[str]
**kwargs # type: Any
):
# type: (...) -> None
if not base_url:
base_url = 'https://management.azure.com'
self._config = CostManagementClientConfiguration(credential, **kwargs)
self._client = ARMPipelineClient(base_url=base_url, config=self._config, **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.views = ViewsOperations(
self._client, self._config, self._serialize, self._deserialize)
self.alerts = AlertsOperations(
self._client, self._config, self._serialize, self._deserialize)
self.forecast = ForecastOperations(
self._client, self._config, self._serialize, self._deserialize)
self.dimensions = DimensionsOperations(
self._client, self._config, self._serialize, self._deserialize)
self.query = QueryOperations(
self._client, self._config, self._serialize, self._deserialize)
self.operations = Operations(
self._client, self._config, self._serialize, self._deserialize)
self.exports = ExportsOperations(
self._client, self._config, self._serialize, self._deserialize)
def close(self):
# type: () -> None
self._client.close()
def __enter__(self):
# type: () -> CostManagementClient
self._client.__enter__()
return self
def __exit__(self, *exc_details):
# type: (Any) -> None
self._client.__exit__(*exc_details)
|
class CostManagementClient(object):
'''CostManagementClient.
:ivar views: ViewsOperations operations
:vartype views: azure.mgmt.costmanagement.operations.ViewsOperations
:ivar alerts: AlertsOperations operations
:vartype alerts: azure.mgmt.costmanagement.operations.AlertsOperations
:ivar forecast: ForecastOperations operations
:vartype forecast: azure.mgmt.costmanagement.operations.ForecastOperations
:ivar dimensions: DimensionsOperations operations
:vartype dimensions: azure.mgmt.costmanagement.operations.DimensionsOperations
:ivar query: QueryOperations operations
:vartype query: azure.mgmt.costmanagement.operations.QueryOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.costmanagement.operations.Operations
:ivar exports: ExportsOperations operations
:vartype exports: azure.mgmt.costmanagement.operations.ExportsOperations
:param credential: Credential needed for the client to connect to Azure.
:type credential: ~azure.core.credentials.TokenCredential
:param str base_url: Service URL
'''
def __init__(
self,
credential, # type: "TokenCredential"
base_url=None, # type: Optional[str]
**kwargs # type: Any
):
pass
def close(self):
pass
def __enter__(self):
pass
def __exit__(self, *exc_details):
pass
| 5 | 1 | 10 | 1 | 9 | 2 | 1 | 0.74 | 1 | 9 | 8 | 0 | 4 | 11 | 4 | 4 | 65 | 7 | 35 | 22 | 25 | 26 | 23 | 17 | 18 | 2 | 1 | 1 | 5 |
10,705 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/aio/_configuration.py
|
azext_costmanagement.vendored_sdks.costmanagement.aio._configuration.CostManagementClientConfiguration
|
class CostManagementClientConfiguration(Configuration):
"""Configuration for CostManagementClient.
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.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
"""
def __init__(
self,
credential: "AsyncTokenCredential",
**kwargs: Any
) -> None:
if credential is None:
raise ValueError("Parameter 'credential' must not be None.")
super(CostManagementClientConfiguration, self).__init__(**kwargs)
self.credential = credential
self.api_version = "2020-06-01"
self.credential_scopes = kwargs.pop('credential_scopes', ['https://management.azure.com/.default'])
kwargs.setdefault('sdk_moniker', 'mgmt-costmanagement/{}'.format(VERSION))
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.retry_policy = kwargs.get('retry_policy') or policies.AsyncRetryPolicy(**kwargs)
self.custom_hook_policy = kwargs.get('custom_hook_policy') or policies.CustomHookPolicy(**kwargs)
self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs)
self.authentication_policy = kwargs.get('authentication_policy')
if self.credential and not self.authentication_policy:
self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs)
|
class CostManagementClientConfiguration(Configuration):
'''Configuration for CostManagementClient.
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.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
'''
def __init__(
self,
credential: "AsyncTokenCredential",
**kwargs: Any
) -> None:
pass
def _configure(
self,
**kwargs: Any
) -> None:
pass
| 3 | 1 | 15 | 1 | 14 | 0 | 2 | 0.21 | 1 | 3 | 0 | 0 | 2 | 12 | 2 | 2 | 40 | 5 | 29 | 22 | 19 | 6 | 22 | 15 | 19 | 2 | 1 | 1 | 4 |
10,706 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/aio/_cost_management_client.py
|
azext_costmanagement.vendored_sdks.costmanagement.aio._cost_management_client.CostManagementClient
|
class CostManagementClient(object):
"""CostManagementClient.
:ivar views: ViewsOperations operations
:vartype views: azure.mgmt.costmanagement.aio.operations.ViewsOperations
:ivar alerts: AlertsOperations operations
:vartype alerts: azure.mgmt.costmanagement.aio.operations.AlertsOperations
:ivar forecast: ForecastOperations operations
:vartype forecast: azure.mgmt.costmanagement.aio.operations.ForecastOperations
:ivar dimensions: DimensionsOperations operations
:vartype dimensions: azure.mgmt.costmanagement.aio.operations.DimensionsOperations
:ivar query: QueryOperations operations
:vartype query: azure.mgmt.costmanagement.aio.operations.QueryOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.costmanagement.aio.operations.Operations
:ivar exports: ExportsOperations operations
:vartype exports: azure.mgmt.costmanagement.aio.operations.ExportsOperations
:param credential: Credential needed for the client to connect to Azure.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
:param str base_url: Service URL
"""
def __init__(
self,
credential: "AsyncTokenCredential",
base_url: Optional[str] = None,
**kwargs: Any
) -> None:
if not base_url:
base_url = 'https://management.azure.com'
self._config = CostManagementClientConfiguration(credential, **kwargs)
self._client = AsyncARMPipelineClient(base_url=base_url, config=self._config, **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.views = ViewsOperations(
self._client, self._config, self._serialize, self._deserialize)
self.alerts = AlertsOperations(
self._client, self._config, self._serialize, self._deserialize)
self.forecast = ForecastOperations(
self._client, self._config, self._serialize, self._deserialize)
self.dimensions = DimensionsOperations(
self._client, self._config, self._serialize, self._deserialize)
self.query = QueryOperations(
self._client, self._config, self._serialize, self._deserialize)
self.operations = Operations(
self._client, self._config, self._serialize, self._deserialize)
self.exports = ExportsOperations(
self._client, self._config, self._serialize, self._deserialize)
async def close(self) -> None:
await self._client.close()
async def __aenter__(self) -> "CostManagementClient":
await self._client.__aenter__()
return self
async def __aexit__(self, *exc_details) -> None:
await self._client.__aexit__(*exc_details)
|
class CostManagementClient(object):
'''CostManagementClient.
:ivar views: ViewsOperations operations
:vartype views: azure.mgmt.costmanagement.aio.operations.ViewsOperations
:ivar alerts: AlertsOperations operations
:vartype alerts: azure.mgmt.costmanagement.aio.operations.AlertsOperations
:ivar forecast: ForecastOperations operations
:vartype forecast: azure.mgmt.costmanagement.aio.operations.ForecastOperations
:ivar dimensions: DimensionsOperations operations
:vartype dimensions: azure.mgmt.costmanagement.aio.operations.DimensionsOperations
:ivar query: QueryOperations operations
:vartype query: azure.mgmt.costmanagement.aio.operations.QueryOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.costmanagement.aio.operations.Operations
:ivar exports: ExportsOperations operations
:vartype exports: azure.mgmt.costmanagement.aio.operations.ExportsOperations
:param credential: Credential needed for the client to connect to Azure.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
:param str base_url: Service URL
'''
def __init__(
self,
credential: "AsyncTokenCredential",
base_url: Optional[str] = None,
**kwargs: Any
) -> None:
pass
async def close(self) -> None:
pass
async def __aenter__(self) -> "CostManagementClient":
pass
async def __aexit__(self, *exc_details) -> None:
pass
| 5 | 1 | 9 | 1 | 9 | 0 | 1 | 0.54 | 1 | 11 | 8 | 0 | 4 | 11 | 4 | 4 | 61 | 7 | 35 | 22 | 25 | 19 | 23 | 17 | 18 | 2 | 1 | 1 | 5 |
10,707 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/aio/operations/_dimensions_operations.py
|
azext_costmanagement.vendored_sdks.costmanagement.aio.operations._dimensions_operations.DimensionsOperations
|
class DimensionsOperations:
"""DimensionsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that
instantiates it for you and attaches it as an attribute.
:ivar models: Alias to model classes used in this operation group.
:type models: ~azure.mgmt.costmanagement.models
:param client: Client for service requests.
:param config: Configuration of service client.
:param serializer: An object model serializer.
:param deserializer: An object model deserializer.
"""
models = _models
def __init__(self, client, config, serializer, deserializer) -> None:
self._client = client
self._serialize = serializer
self._deserialize = deserializer
self._config = config
def list(
self,
scope: str,
filter: Optional[str] = None,
expand: Optional[str] = None,
skiptoken: Optional[str] = None,
top: Optional[int] = None,
**kwargs
) -> AsyncIterable["_models.DimensionsListResult"]:
"""Lists the dimensions by the defined scope.
:param scope: The scope associated with dimension operations. This includes
'/subscriptions/{subscriptionId}/' for subscription scope,
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}'
for Department scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'
for EnrollmentAccount scope,
'/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group
scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'
for billingProfile scope,
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
for invoiceSection scope, and
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}'
specific for partners.
:type scope: str
:param filter: May be used to filter dimensions by properties/category, properties/usageStart,
properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.
:type filter: str
:param expand: May be used to expand the properties/data within a dimension category. By
default, data is not included when listing dimensions.
:type expand: str
:param skiptoken: Skiptoken is only used if a previous operation returned a partial result. If
a previous response contains a nextLink element, the value of the nextLink element will include
a skiptoken parameter that specifies a starting point to use for subsequent calls.
:type skiptoken: str
:param top: May be used to limit the number of results to the most recent N dimension data.
:type top: int
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either DimensionsListResult or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.costmanagement.models.DimensionsListResult]
:raises: ~azure.core.exceptions.HttpResponseError
"""
cls = kwargs.pop('cls', None) # type: ClsType["_models.DimensionsListResult"]
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}))
api_version = "2020-06-01"
accept = "application/json"
def prepare_request(next_link=None):
# Construct headers
header_parameters = {} # type: Dict[str, Any]
header_parameters['Accept'] = self._serialize.header("accept", accept, 'str')
if not next_link:
# Construct URL
url = self.list.metadata['url'] # type: ignore
path_format_arguments = {
'scope': self._serialize.url("scope", scope, 'str', skip_quote=True),
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {} # type: Dict[str, Any]
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if filter is not None:
query_parameters['$filter'] = self._serialize.query("filter", filter, 'str')
if expand is not None:
query_parameters['$expand'] = self._serialize.query("expand", expand, 'str')
if skiptoken is not None:
query_parameters['$skiptoken'] = self._serialize.query("skiptoken", skiptoken, 'str')
if top is not None:
query_parameters['$top'] = self._serialize.query("top", top, 'int', maximum=1000, minimum=1)
request = self._client.get(url, query_parameters, header_parameters)
else:
url = next_link
query_parameters = {} # type: Dict[str, Any]
request = self._client.get(url, query_parameters, header_parameters)
return request
async def extract_data(pipeline_response):
deserialized = self._deserialize('DimensionsListResult', pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return None, AsyncList(list_of_elem)
async def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = await self._client._pipeline.run(request, stream=False, **kwargs)
response = pipeline_response.http_response
if response.status_code not in [200]:
error = self._deserialize(_models.ErrorResponse, response)
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(
get_next, extract_data
)
list.metadata = {'url': '/{scope}/providers/Microsoft.CostManagement/dimensions'} # type: ignore
def by_external_cloud_provider_type(
self,
external_cloud_provider_type: Union[str, "_models.ExternalCloudProviderType"],
external_cloud_provider_id: str,
filter: Optional[str] = None,
expand: Optional[str] = None,
skiptoken: Optional[str] = None,
top: Optional[int] = None,
**kwargs
) -> AsyncIterable["_models.DimensionsListResult"]:
"""Lists the dimensions by the external cloud provider type.
:param external_cloud_provider_type: The external cloud provider type associated with
dimension/query operations. This includes 'externalSubscriptions' for linked account and
'externalBillingAccounts' for consolidated account.
:type external_cloud_provider_type: str or ~azure.mgmt.costmanagement.models.ExternalCloudProviderType
:param external_cloud_provider_id: This can be '{externalSubscriptionId}' for linked account or
'{externalBillingAccountId}' for consolidated account used with dimension/query operations.
:type external_cloud_provider_id: str
:param filter: May be used to filter dimensions by properties/category, properties/usageStart,
properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.
:type filter: str
:param expand: May be used to expand the properties/data within a dimension category. By
default, data is not included when listing dimensions.
:type expand: str
:param skiptoken: Skiptoken is only used if a previous operation returned a partial result. If
a previous response contains a nextLink element, the value of the nextLink element will include
a skiptoken parameter that specifies a starting point to use for subsequent calls.
:type skiptoken: str
:param top: May be used to limit the number of results to the most recent N dimension data.
:type top: int
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either DimensionsListResult or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.costmanagement.models.DimensionsListResult]
:raises: ~azure.core.exceptions.HttpResponseError
"""
cls = kwargs.pop('cls', None) # type: ClsType["_models.DimensionsListResult"]
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}))
api_version = "2020-06-01"
accept = "application/json"
def prepare_request(next_link=None):
# Construct headers
header_parameters = {} # type: Dict[str, Any]
header_parameters['Accept'] = self._serialize.header("accept", accept, 'str')
if not next_link:
# Construct URL
url = self.by_external_cloud_provider_type.metadata['url'] # type: ignore
path_format_arguments = {
'externalCloudProviderType': self._serialize.url("external_cloud_provider_type", external_cloud_provider_type, 'str'),
'externalCloudProviderId': self._serialize.url("external_cloud_provider_id", external_cloud_provider_id, 'str'),
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {} # type: Dict[str, Any]
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if filter is not None:
query_parameters['$filter'] = self._serialize.query("filter", filter, 'str')
if expand is not None:
query_parameters['$expand'] = self._serialize.query("expand", expand, 'str')
if skiptoken is not None:
query_parameters['$skiptoken'] = self._serialize.query("skiptoken", skiptoken, 'str')
if top is not None:
query_parameters['$top'] = self._serialize.query("top", top, 'int', maximum=1000, minimum=1)
request = self._client.get(url, query_parameters, header_parameters)
else:
url = next_link
query_parameters = {} # type: Dict[str, Any]
request = self._client.get(url, query_parameters, header_parameters)
return request
async def extract_data(pipeline_response):
deserialized = self._deserialize('DimensionsListResult', pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return None, AsyncList(list_of_elem)
async def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = await self._client._pipeline.run(request, stream=False, **kwargs)
response = pipeline_response.http_response
if response.status_code not in [200]:
error = self._deserialize(_models.ErrorResponse, response)
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(
get_next, extract_data
)
by_external_cloud_provider_type.metadata = {'url': '/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions'}
|
class DimensionsOperations:
'''DimensionsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that
instantiates it for you and attaches it as an attribute.
:ivar models: Alias to model classes used in this operation group.
:type models: ~azure.mgmt.costmanagement.models
:param client: Client for service requests.
:param config: Configuration of service client.
:param serializer: An object model serializer.
:param deserializer: An object model deserializer.
'''
def __init__(self, client, config, serializer, deserializer) -> None:
pass
def list(
self,
scope: str,
filter: Optional[str] = None,
expand: Optional[str] = None,
skiptoken: Optional[str] = None,
top: Optional[int] = None,
**kwargs
) -> AsyncIterable["_models.DimensionsListResult"]:
'''Lists the dimensions by the defined scope.
:param scope: The scope associated with dimension operations. This includes
'/subscriptions/{subscriptionId}/' for subscription scope,
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}'
for Department scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'
for EnrollmentAccount scope,
'/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group
scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'
for billingProfile scope,
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
for invoiceSection scope, and
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}'
specific for partners.
:type scope: str
:param filter: May be used to filter dimensions by properties/category, properties/usageStart,
properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.
:type filter: str
:param expand: May be used to expand the properties/data within a dimension category. By
default, data is not included when listing dimensions.
:type expand: str
:param skiptoken: Skiptoken is only used if a previous operation returned a partial result. If
a previous response contains a nextLink element, the value of the nextLink element will include
a skiptoken parameter that specifies a starting point to use for subsequent calls.
:type skiptoken: str
:param top: May be used to limit the number of results to the most recent N dimension data.
:type top: int
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either DimensionsListResult or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.costmanagement.models.DimensionsListResult]
:raises: ~azure.core.exceptions.HttpResponseError
'''
pass
def prepare_request(next_link=None):
pass
async def extract_data(pipeline_response):
pass
async def get_next(next_link=None):
pass
def by_external_cloud_provider_type(
self,
external_cloud_provider_type: Union[str, "_models.ExternalCloudProviderType"],
external_cloud_provider_id: str,
filter: Optional[str] = None,
expand: Optional[str] = None,
skiptoken: Optional[str] = None,
top: Optional[int] = None,
**kwargs
) -> AsyncIterable["_models.DimensionsListResult"]:
'''Lists the dimensions by the external cloud provider type.
:param external_cloud_provider_type: The external cloud provider type associated with
dimension/query operations. This includes 'externalSubscriptions' for linked account and
'externalBillingAccounts' for consolidated account.
:type external_cloud_provider_type: str or ~azure.mgmt.costmanagement.models.ExternalCloudProviderType
:param external_cloud_provider_id: This can be '{externalSubscriptionId}' for linked account or
'{externalBillingAccountId}' for consolidated account used with dimension/query operations.
:type external_cloud_provider_id: str
:param filter: May be used to filter dimensions by properties/category, properties/usageStart,
properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.
:type filter: str
:param expand: May be used to expand the properties/data within a dimension category. By
default, data is not included when listing dimensions.
:type expand: str
:param skiptoken: Skiptoken is only used if a previous operation returned a partial result. If
a previous response contains a nextLink element, the value of the nextLink element will include
a skiptoken parameter that specifies a starting point to use for subsequent calls.
:type skiptoken: str
:param top: May be used to limit the number of results to the most recent N dimension data.
:type top: int
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either DimensionsListResult or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.costmanagement.models.DimensionsListResult]
:raises: ~azure.core.exceptions.HttpResponseError
'''
pass
def prepare_request(next_link=None):
pass
async def extract_data(pipeline_response):
pass
async def get_next(next_link=None):
pass
| 10 | 3 | 34 | 3 | 23 | 10 | 3 | 0.68 | 0 | 3 | 0 | 0 | 3 | 4 | 3 | 3 | 231 | 26 | 129 | 62 | 102 | 88 | 97 | 45 | 87 | 6 | 0 | 2 | 23 |
10,708 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ExportType
|
class ExportType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The type of the query.
"""
USAGE = "Usage"
ACTUAL_COST = "ActualCost"
AMORTIZED_COST = "AmortizedCost"
|
class ExportType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The type of the query.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.5 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 7 | 1 | 4 | 4 | 3 | 2 | 4 | 4 | 3 | 0 | 1 | 0 | 0 |
10,709 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ExternalCloudProviderType
|
class ExternalCloudProviderType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
EXTERNAL_SUBSCRIPTIONS = "externalSubscriptions"
EXTERNAL_BILLING_ACCOUNTS = "externalBillingAccounts"
|
class ExternalCloudProviderType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
pass
| 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 4 | 1 | 3 | 3 | 2 | 0 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,710 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ForecastTimeframeType
|
class ForecastTimeframeType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The time frame for pulling data for the forecast. If custom, then a specific time period must
be provided.
"""
MONTH_TO_DATE = "MonthToDate"
BILLING_MONTH_TO_DATE = "BillingMonthToDate"
THE_LAST_MONTH = "TheLastMonth"
THE_LAST_BILLING_MONTH = "TheLastBillingMonth"
WEEK_TO_DATE = "WeekToDate"
CUSTOM = "Custom"
|
class ForecastTimeframeType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The time frame for pulling data for the forecast. If custom, then a specific time period must
be provided.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.43 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 11 | 1 | 7 | 7 | 6 | 3 | 7 | 7 | 6 | 0 | 1 | 0 | 0 |
10,711 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.Dimension
|
class Dimension(Resource):
"""Dimension.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar description: Dimension description.
:vartype description: str
:ivar filter_enabled: Filter enabled.
:vartype filter_enabled: bool
:ivar grouping_enabled: Grouping enabled.
:vartype grouping_enabled: bool
:param data:
:type data: list[str]
:ivar total: Total number of data for the dimension.
:vartype total: int
:ivar category: Dimension category.
:vartype category: str
:ivar usage_start: Usage start.
:vartype usage_start: ~datetime.datetime
:ivar usage_end: Usage end.
:vartype usage_end: ~datetime.datetime
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'tags': {'readonly': True},
'description': {'readonly': True},
'filter_enabled': {'readonly': True},
'grouping_enabled': {'readonly': True},
'total': {'readonly': True},
'category': {'readonly': True},
'usage_start': {'readonly': True},
'usage_end': {'readonly': True},
'next_link': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'description': {'key': 'properties.description', 'type': 'str'},
'filter_enabled': {'key': 'properties.filterEnabled', 'type': 'bool'},
'grouping_enabled': {'key': 'properties.groupingEnabled', 'type': 'bool'},
'data': {'key': 'properties.data', 'type': '[str]'},
'total': {'key': 'properties.total', 'type': 'int'},
'category': {'key': 'properties.category', 'type': 'str'},
'usage_start': {'key': 'properties.usageStart', 'type': 'iso-8601'},
'usage_end': {'key': 'properties.usageEnd', 'type': 'iso-8601'},
'next_link': {'key': 'properties.nextLink', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(Dimension, self).__init__(**kwargs)
self.description = None
self.filter_enabled = None
self.grouping_enabled = None
self.data = kwargs.get('data', None)
self.total = None
self.category = None
self.usage_start = None
self.usage_end = None
self.next_link = None
|
class Dimension(Resource):
'''Dimension.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar description: Dimension description.
:vartype description: str
:ivar filter_enabled: Filter enabled.
:vartype filter_enabled: bool
:ivar grouping_enabled: Grouping enabled.
:vartype grouping_enabled: bool
:param data:
:type data: list[str]
:ivar total: Total number of data for the dimension.
:vartype total: int
:ivar category: Dimension category.
:vartype category: str
:ivar usage_start: Usage start.
:vartype usage_start: ~datetime.datetime
:ivar usage_end: Usage end.
:vartype usage_end: ~datetime.datetime
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 14 | 0 | 14 | 0 | 1 | 0.66 | 1 | 1 | 0 | 0 | 1 | 9 | 1 | 2 | 78 | 5 | 44 | 16 | 39 | 29 | 14 | 13 | 12 | 1 | 2 | 0 | 1 |
10,712 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.DismissAlertPayload
|
class DismissAlertPayload(msrest.serialization.Model):
"""The request payload to update an alert.
:param definition: defines the type of alert.
:type definition: ~azure.mgmt.costmanagement.models.AlertPropertiesDefinition
:param description: Alert description.
:type description: str
:param source: Source of alert. Possible values include: "Preset", "User".
:type source: str or ~azure.mgmt.costmanagement.models.AlertSource
:param details: Alert details.
:type details: ~azure.mgmt.costmanagement.models.AlertPropertiesDetails
:param cost_entity_id: related budget.
:type cost_entity_id: str
:param status: alert status. Possible values include: "None", "Active", "Overridden",
"Resolved", "Dismissed".
:type status: str or ~azure.mgmt.costmanagement.models.AlertStatus
:param creation_time: dateTime in which alert was created.
:type creation_time: str
:param close_time: dateTime in which alert was closed.
:type close_time: str
:param modification_time: dateTime in which alert was last modified.
:type modification_time: str
:param status_modification_user_name:
:type status_modification_user_name: str
:param status_modification_time: dateTime in which the alert status was last modified.
:type status_modification_time: str
"""
_attribute_map = {
'definition': {'key': 'properties.definition', 'type': 'AlertPropertiesDefinition'},
'description': {'key': 'properties.description', 'type': 'str'},
'source': {'key': 'properties.source', 'type': 'str'},
'details': {'key': 'properties.details', 'type': 'AlertPropertiesDetails'},
'cost_entity_id': {'key': 'properties.costEntityId', 'type': 'str'},
'status': {'key': 'properties.status', 'type': 'str'},
'creation_time': {'key': 'properties.creationTime', 'type': 'str'},
'close_time': {'key': 'properties.closeTime', 'type': 'str'},
'modification_time': {'key': 'properties.modificationTime', 'type': 'str'},
'status_modification_user_name': {'key': 'properties.statusModificationUserName', 'type': 'str'},
'status_modification_time': {'key': 'properties.statusModificationTime', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(DismissAlertPayload, self).__init__(**kwargs)
self.definition = kwargs.get('definition', None)
self.description = kwargs.get('description', None)
self.source = kwargs.get('source', None)
self.details = kwargs.get('details', None)
self.cost_entity_id = kwargs.get('cost_entity_id', None)
self.status = kwargs.get('status', None)
self.creation_time = kwargs.get('creation_time', None)
self.close_time = kwargs.get('close_time', None)
self.modification_time = kwargs.get('modification_time', None)
self.status_modification_user_name = kwargs.get('status_modification_user_name', None)
self.status_modification_time = kwargs.get('status_modification_time', None)
|
class DismissAlertPayload(msrest.serialization.Model):
'''The request payload to update an alert.
:param definition: defines the type of alert.
:type definition: ~azure.mgmt.costmanagement.models.AlertPropertiesDefinition
:param description: Alert description.
:type description: str
:param source: Source of alert. Possible values include: "Preset", "User".
:type source: str or ~azure.mgmt.costmanagement.models.AlertSource
:param details: Alert details.
:type details: ~azure.mgmt.costmanagement.models.AlertPropertiesDetails
:param cost_entity_id: related budget.
:type cost_entity_id: str
:param status: alert status. Possible values include: "None", "Active", "Overridden",
"Resolved", "Dismissed".
:type status: str or ~azure.mgmt.costmanagement.models.AlertStatus
:param creation_time: dateTime in which alert was created.
:type creation_time: str
:param close_time: dateTime in which alert was closed.
:type close_time: str
:param modification_time: dateTime in which alert was last modified.
:type modification_time: str
:param status_modification_user_name:
:type status_modification_user_name: str
:param status_modification_time: dateTime in which the alert status was last modified.
:type status_modification_time: str
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 16 | 0 | 16 | 0 | 1 | 0.83 | 1 | 1 | 0 | 0 | 1 | 11 | 1 | 1 | 58 | 3 | 30 | 17 | 25 | 25 | 15 | 14 | 13 | 1 | 1 | 0 | 1 |
10,713 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ErrorResponse
|
class ErrorResponse(msrest.serialization.Model):
"""Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Some Error responses:
*
429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
*
503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
:param error: The details of the error.
:type error: ~azure.mgmt.costmanagement.models.ErrorDetails
"""
_attribute_map = {
'error': {'key': 'error', 'type': 'ErrorDetails'},
}
def __init__(
self,
**kwargs
):
super(ErrorResponse, self).__init__(**kwargs)
self.error = kwargs.get('error', None)
|
class ErrorResponse(msrest.serialization.Model):
'''Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Some Error responses:
*
429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
*
503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
:param error: The details of the error.
:type error: ~azure.mgmt.costmanagement.models.ErrorDetails
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 6 | 0 | 6 | 0 | 1 | 0.9 | 1 | 1 | 0 | 0 | 1 | 1 | 1 | 1 | 26 | 7 | 10 | 7 | 5 | 9 | 5 | 4 | 3 | 1 | 1 | 0 | 1 |
10,714 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.Export
|
class Export(ProxyResource):
"""An export resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param e_tag: eTag of the resource. To handle concurrent update scenario, this field will be
used to determine whether the user is updating the latest version or not.
:type e_tag: str
:param format: The format of the export being delivered. Currently only 'Csv' is supported.
Possible values include: "Csv".
:type format: str or ~azure.mgmt.costmanagement.models.FormatType
:param delivery_info: Has delivery information for the export.
:type delivery_info: ~azure.mgmt.costmanagement.models.ExportDeliveryInfo
:param definition: Has the definition for the export.
:type definition: ~azure.mgmt.costmanagement.models.ExportDefinition
:param run_history: If requested, has the most recent execution history for the export.
:type run_history: ~azure.mgmt.costmanagement.models.ExportExecutionListResult
:ivar next_run_time_estimate: If the export has an active schedule, provides an estimate of the
next execution time.
:vartype next_run_time_estimate: ~datetime.datetime
:param schedule: Has schedule information for the export.
:type schedule: ~azure.mgmt.costmanagement.models.ExportSchedule
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'next_run_time_estimate': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'e_tag': {'key': 'eTag', 'type': 'str'},
'format': {'key': 'properties.format', 'type': 'str'},
'delivery_info': {'key': 'properties.deliveryInfo', 'type': 'ExportDeliveryInfo'},
'definition': {'key': 'properties.definition', 'type': 'ExportDefinition'},
'run_history': {'key': 'properties.runHistory', 'type': 'ExportExecutionListResult'},
'next_run_time_estimate': {'key': 'properties.nextRunTimeEstimate', 'type': 'iso-8601'},
'schedule': {'key': 'properties.schedule', 'type': 'ExportSchedule'},
}
def __init__(
self,
**kwargs
):
super(Export, self).__init__(**kwargs)
self.format = kwargs.get('format', None)
self.delivery_info = kwargs.get('delivery_info', None)
self.definition = kwargs.get('definition', None)
self.run_history = kwargs.get('run_history', None)
self.next_run_time_estimate = None
self.schedule = kwargs.get('schedule', None)
|
class Export(ProxyResource):
'''An export resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param e_tag: eTag of the resource. To handle concurrent update scenario, this field will be
used to determine whether the user is updating the latest version or not.
:type e_tag: str
:param format: The format of the export being delivered. Currently only 'Csv' is supported.
Possible values include: "Csv".
:type format: str or ~azure.mgmt.costmanagement.models.FormatType
:param delivery_info: Has delivery information for the export.
:type delivery_info: ~azure.mgmt.costmanagement.models.ExportDeliveryInfo
:param definition: Has the definition for the export.
:type definition: ~azure.mgmt.costmanagement.models.ExportDefinition
:param run_history: If requested, has the most recent execution history for the export.
:type run_history: ~azure.mgmt.costmanagement.models.ExportExecutionListResult
:ivar next_run_time_estimate: If the export has an active schedule, provides an estimate of the
next execution time.
:vartype next_run_time_estimate: ~datetime.datetime
:param schedule: Has schedule information for the export.
:type schedule: ~azure.mgmt.costmanagement.models.ExportSchedule
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 11 | 0 | 11 | 0 | 1 | 0.87 | 1 | 1 | 0 | 0 | 1 | 6 | 1 | 2 | 61 | 5 | 30 | 13 | 25 | 26 | 11 | 10 | 9 | 1 | 2 | 0 | 1 |
10,715 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportDataset
|
class ExportDataset(msrest.serialization.Model):
"""The definition for data in the export.
:param granularity: The granularity of rows in the export. Currently only 'Daily' is supported.
Possible values include: "Daily".
:type granularity: str or ~azure.mgmt.costmanagement.models.GranularityType
:param configuration: The export dataset configuration.
:type configuration: ~azure.mgmt.costmanagement.models.ExportDatasetConfiguration
"""
_attribute_map = {
'granularity': {'key': 'granularity', 'type': 'str'},
'configuration': {'key': 'configuration', 'type': 'ExportDatasetConfiguration'},
}
def __init__(
self,
**kwargs
):
super(ExportDataset, self).__init__(**kwargs)
self.granularity = kwargs.get('granularity', None)
self.configuration = kwargs.get('configuration', None)
|
class ExportDataset(msrest.serialization.Model):
'''The definition for data in the export.
:param granularity: The granularity of rows in the export. Currently only 'Daily' is supported.
Possible values include: "Daily".
:type granularity: str or ~azure.mgmt.costmanagement.models.GranularityType
:param configuration: The export dataset configuration.
:type configuration: ~azure.mgmt.costmanagement.models.ExportDatasetConfiguration
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 7 | 0 | 7 | 0 | 1 | 0.58 | 1 | 1 | 0 | 0 | 1 | 2 | 1 | 1 | 22 | 3 | 12 | 8 | 7 | 7 | 6 | 5 | 4 | 1 | 1 | 0 | 1 |
10,716 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportDatasetConfiguration
|
class ExportDatasetConfiguration(msrest.serialization.Model):
"""The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.
:param columns: Array of column names to be included in the export. If not provided then the
export will include all available columns. The available columns can vary by customer channel
(see examples).
:type columns: list[str]
"""
_attribute_map = {
'columns': {'key': 'columns', 'type': '[str]'},
}
def __init__(
self,
**kwargs
):
super(ExportDatasetConfiguration, self).__init__(**kwargs)
self.columns = kwargs.get('columns', None)
|
class ExportDatasetConfiguration(msrest.serialization.Model):
'''The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.
:param columns: Array of column names to be included in the export. If not provided then the
export will include all available columns. The available columns can vary by customer channel
(see examples).
:type columns: list[str]
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 6 | 0 | 6 | 0 | 1 | 0.6 | 1 | 1 | 0 | 0 | 1 | 1 | 1 | 1 | 19 | 3 | 10 | 7 | 5 | 6 | 5 | 4 | 3 | 1 | 1 | 0 | 1 |
10,717 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportDefinition
|
class ExportDefinition(msrest.serialization.Model):
"""The definition of an export.
All required parameters must be populated in order to send to Azure.
:param type: Required. The type of the export. Note that 'Usage' is equivalent to 'ActualCost'
and is applicable to exports that do not yet provide data for charges or amortization for
service reservations. Possible values include: "Usage", "ActualCost", "AmortizedCost".
:type type: str or ~azure.mgmt.costmanagement.models.ExportType
:param timeframe: Required. The time frame for pulling data for the export. If custom, then a
specific time period must be provided. Possible values include: "MonthToDate",
"BillingMonthToDate", "TheLastMonth", "TheLastBillingMonth", "WeekToDate", "Custom".
:type timeframe: str or ~azure.mgmt.costmanagement.models.TimeframeType
:param time_period: Has time period for pulling data for the export.
:type time_period: ~azure.mgmt.costmanagement.models.ExportTimePeriod
:param data_set: The definition for data in the export.
:type data_set: ~azure.mgmt.costmanagement.models.ExportDataset
"""
_validation = {
'type': {'required': True},
'timeframe': {'required': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'timeframe': {'key': 'timeframe', 'type': 'str'},
'time_period': {'key': 'timePeriod', 'type': 'ExportTimePeriod'},
'data_set': {'key': 'dataSet', 'type': 'ExportDataset'},
}
def __init__(
self,
**kwargs
):
super(ExportDefinition, self).__init__(**kwargs)
self.type = kwargs['type']
self.timeframe = kwargs['timeframe']
self.time_period = kwargs.get('time_period', None)
self.data_set = kwargs.get('data_set', None)
|
class ExportDefinition(msrest.serialization.Model):
'''The definition of an export.
All required parameters must be populated in order to send to Azure.
:param type: Required. The type of the export. Note that 'Usage' is equivalent to 'ActualCost'
and is applicable to exports that do not yet provide data for charges or amortization for
service reservations. Possible values include: "Usage", "ActualCost", "AmortizedCost".
:type type: str or ~azure.mgmt.costmanagement.models.ExportType
:param timeframe: Required. The time frame for pulling data for the export. If custom, then a
specific time period must be provided. Possible values include: "MonthToDate",
"BillingMonthToDate", "TheLastMonth", "TheLastBillingMonth", "WeekToDate", "Custom".
:type timeframe: str or ~azure.mgmt.costmanagement.models.TimeframeType
:param time_period: Has time period for pulling data for the export.
:type time_period: ~azure.mgmt.costmanagement.models.ExportTimePeriod
:param data_set: The definition for data in the export.
:type data_set: ~azure.mgmt.costmanagement.models.ExportDataset
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 9 | 0 | 9 | 0 | 1 | 0.75 | 1 | 1 | 0 | 0 | 1 | 4 | 1 | 1 | 40 | 5 | 20 | 11 | 15 | 15 | 9 | 8 | 7 | 1 | 1 | 0 | 1 |
10,718 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportDeliveryDestination
|
class ExportDeliveryDestination(msrest.serialization.Model):
"""The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .
All required parameters must be populated in order to send to Azure.
:param resource_id: Required. The resource id of the storage account where exports will be
delivered.
:type resource_id: str
:param container: Required. The name of the container where exports will be uploaded.
:type container: str
:param root_folder_path: The name of the directory where exports will be uploaded.
:type root_folder_path: str
"""
_validation = {
'resource_id': {'required': True},
'container': {'required': True},
}
_attribute_map = {
'resource_id': {'key': 'resourceId', 'type': 'str'},
'container': {'key': 'container', 'type': 'str'},
'root_folder_path': {'key': 'rootFolderPath', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(ExportDeliveryDestination, self).__init__(**kwargs)
self.resource_id = kwargs['resource_id']
self.container = kwargs['container']
self.root_folder_path = kwargs.get('root_folder_path', None)
|
class ExportDeliveryDestination(msrest.serialization.Model):
'''The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .
All required parameters must be populated in order to send to Azure.
:param resource_id: Required. The resource id of the storage account where exports will be
delivered.
:type resource_id: str
:param container: Required. The name of the container where exports will be uploaded.
:type container: str
:param root_folder_path: The name of the directory where exports will be uploaded.
:type root_folder_path: str
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 8 | 0 | 8 | 0 | 1 | 0.56 | 1 | 1 | 0 | 0 | 1 | 3 | 1 | 1 | 33 | 5 | 18 | 10 | 13 | 10 | 8 | 7 | 6 | 1 | 1 | 0 | 1 |
10,719 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportDeliveryInfo
|
class ExportDeliveryInfo(msrest.serialization.Model):
"""The delivery information associated with a export.
All required parameters must be populated in order to send to Azure.
:param destination: Required. Has destination for the export being delivered.
:type destination: ~azure.mgmt.costmanagement.models.ExportDeliveryDestination
"""
_validation = {
'destination': {'required': True},
}
_attribute_map = {
'destination': {'key': 'destination', 'type': 'ExportDeliveryDestination'},
}
def __init__(
self,
**kwargs
):
super(ExportDeliveryInfo, self).__init__(**kwargs)
self.destination = kwargs['destination']
|
class ExportDeliveryInfo(msrest.serialization.Model):
'''The delivery information associated with a export.
All required parameters must be populated in order to send to Azure.
:param destination: Required. Has destination for the export being delivered.
:type destination: ~azure.mgmt.costmanagement.models.ExportDeliveryDestination
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 6 | 0 | 6 | 0 | 1 | 0.38 | 1 | 1 | 0 | 0 | 1 | 1 | 1 | 1 | 23 | 5 | 13 | 8 | 8 | 5 | 6 | 5 | 4 | 1 | 1 | 0 | 1 |
10,720 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportExecution
|
class ExportExecution(ProxyResource):
"""An export execution.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param e_tag: eTag of the resource. To handle concurrent update scenario, this field will be
used to determine whether the user is updating the latest version or not.
:type e_tag: str
:param execution_type: The type of the export execution. Possible values include: "OnDemand",
"Scheduled".
:type execution_type: str or ~azure.mgmt.costmanagement.models.ExecutionType
:param status: The last known status of the export execution. Possible values include:
"Queued", "InProgress", "Completed", "Failed", "Timeout", "NewDataNotAvailable",
"DataNotAvailable".
:type status: str or ~azure.mgmt.costmanagement.models.ExecutionStatus
:param submitted_by: The identifier for the entity that executed the export. For OnDemand
executions it is the user email. For scheduled executions it is 'System'.
:type submitted_by: str
:param submitted_time: The time when export was queued to be executed.
:type submitted_time: ~datetime.datetime
:param processing_start_time: The time when export was picked up to be executed.
:type processing_start_time: ~datetime.datetime
:param processing_end_time: The time when the export execution finished.
:type processing_end_time: ~datetime.datetime
:param file_name: The name of the exported file.
:type file_name: str
:param run_settings: The export settings that were in effect for this execution.
:type run_settings: ~azure.mgmt.costmanagement.models.CommonExportProperties
:param error: The details of any error.
:type error: ~azure.mgmt.costmanagement.models.ErrorDetails
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'e_tag': {'key': 'eTag', 'type': 'str'},
'execution_type': {'key': 'properties.executionType', 'type': 'str'},
'status': {'key': 'properties.status', 'type': 'str'},
'submitted_by': {'key': 'properties.submittedBy', 'type': 'str'},
'submitted_time': {'key': 'properties.submittedTime', 'type': 'iso-8601'},
'processing_start_time': {'key': 'properties.processingStartTime', 'type': 'iso-8601'},
'processing_end_time': {'key': 'properties.processingEndTime', 'type': 'iso-8601'},
'file_name': {'key': 'properties.fileName', 'type': 'str'},
'run_settings': {'key': 'properties.runSettings', 'type': 'CommonExportProperties'},
'error': {'key': 'properties.error', 'type': 'ErrorDetails'},
}
def __init__(
self,
**kwargs
):
super(ExportExecution, self).__init__(**kwargs)
self.execution_type = kwargs.get('execution_type', None)
self.status = kwargs.get('status', None)
self.submitted_by = kwargs.get('submitted_by', None)
self.submitted_time = kwargs.get('submitted_time', None)
self.processing_start_time = kwargs.get('processing_start_time', None)
self.processing_end_time = kwargs.get('processing_end_time', None)
self.file_name = kwargs.get('file_name', None)
self.run_settings = kwargs.get('run_settings', None)
self.error = kwargs.get('error', None)
|
class ExportExecution(ProxyResource):
'''An export execution.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:param e_tag: eTag of the resource. To handle concurrent update scenario, this field will be
used to determine whether the user is updating the latest version or not.
:type e_tag: str
:param execution_type: The type of the export execution. Possible values include: "OnDemand",
"Scheduled".
:type execution_type: str or ~azure.mgmt.costmanagement.models.ExecutionType
:param status: The last known status of the export execution. Possible values include:
"Queued", "InProgress", "Completed", "Failed", "Timeout", "NewDataNotAvailable",
"DataNotAvailable".
:type status: str or ~azure.mgmt.costmanagement.models.ExecutionStatus
:param submitted_by: The identifier for the entity that executed the export. For OnDemand
executions it is the user email. For scheduled executions it is 'System'.
:type submitted_by: str
:param submitted_time: The time when export was queued to be executed.
:type submitted_time: ~datetime.datetime
:param processing_start_time: The time when export was picked up to be executed.
:type processing_start_time: ~datetime.datetime
:param processing_end_time: The time when the export execution finished.
:type processing_end_time: ~datetime.datetime
:param file_name: The name of the exported file.
:type file_name: str
:param run_settings: The export settings that were in effect for this execution.
:type run_settings: ~azure.mgmt.costmanagement.models.CommonExportProperties
:param error: The details of any error.
:type error: ~azure.mgmt.costmanagement.models.ErrorDetails
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 14 | 0 | 14 | 0 | 1 | 0.97 | 1 | 1 | 0 | 0 | 1 | 9 | 1 | 2 | 74 | 5 | 35 | 16 | 30 | 34 | 14 | 13 | 12 | 1 | 2 | 0 | 1 |
10,721 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportProperties
|
class ExportProperties(CommonExportProperties):
"""The properties of the export.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:param format: The format of the export being delivered. Currently only 'Csv' is supported.
Possible values include: "Csv".
:type format: str or ~azure.mgmt.costmanagement.models.FormatType
:param delivery_info: Required. Has delivery information for the export.
:type delivery_info: ~azure.mgmt.costmanagement.models.ExportDeliveryInfo
:param definition: Required. Has the definition for the export.
:type definition: ~azure.mgmt.costmanagement.models.ExportDefinition
:param run_history: If requested, has the most recent execution history for the export.
:type run_history: ~azure.mgmt.costmanagement.models.ExportExecutionListResult
:ivar next_run_time_estimate: If the export has an active schedule, provides an estimate of the
next execution time.
:vartype next_run_time_estimate: ~datetime.datetime
:param schedule: Has schedule information for the export.
:type schedule: ~azure.mgmt.costmanagement.models.ExportSchedule
"""
_validation = {
'delivery_info': {'required': True},
'definition': {'required': True},
'next_run_time_estimate': {'readonly': True},
}
_attribute_map = {
'format': {'key': 'format', 'type': 'str'},
'delivery_info': {'key': 'deliveryInfo', 'type': 'ExportDeliveryInfo'},
'definition': {'key': 'definition', 'type': 'ExportDefinition'},
'run_history': {'key': 'runHistory', 'type': 'ExportExecutionListResult'},
'next_run_time_estimate': {'key': 'nextRunTimeEstimate', 'type': 'iso-8601'},
'schedule': {'key': 'schedule', 'type': 'ExportSchedule'},
}
def __init__(
self,
**kwargs
):
super(ExportProperties, self).__init__(**kwargs)
self.schedule = kwargs.get('schedule', None)
|
class ExportProperties(CommonExportProperties):
'''The properties of the export.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:param format: The format of the export being delivered. Currently only 'Csv' is supported.
Possible values include: "Csv".
:type format: str or ~azure.mgmt.costmanagement.models.FormatType
:param delivery_info: Required. Has delivery information for the export.
:type delivery_info: ~azure.mgmt.costmanagement.models.ExportDeliveryInfo
:param definition: Required. Has the definition for the export.
:type definition: ~azure.mgmt.costmanagement.models.ExportDefinition
:param run_history: If requested, has the most recent execution history for the export.
:type run_history: ~azure.mgmt.costmanagement.models.ExportExecutionListResult
:ivar next_run_time_estimate: If the export has an active schedule, provides an estimate of the
next execution time.
:vartype next_run_time_estimate: ~datetime.datetime
:param schedule: Has schedule information for the export.
:type schedule: ~azure.mgmt.costmanagement.models.ExportSchedule
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 6 | 0 | 6 | 0 | 1 | 0.9 | 1 | 1 | 0 | 0 | 1 | 1 | 1 | 2 | 44 | 6 | 20 | 8 | 15 | 18 | 6 | 5 | 4 | 1 | 2 | 0 | 1 |
10,722 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportRecurrencePeriod
|
class ExportRecurrencePeriod(msrest.serialization.Model):
"""The start and end date for recurrence schedule.
All required parameters must be populated in order to send to Azure.
:param from_property: Required. The start date of recurrence.
:type from_property: ~datetime.datetime
:param to: The end date of recurrence.
:type to: ~datetime.datetime
"""
_validation = {
'from_property': {'required': True},
}
_attribute_map = {
'from_property': {'key': 'from', 'type': 'iso-8601'},
'to': {'key': 'to', 'type': 'iso-8601'},
}
def __init__(
self,
**kwargs
):
super(ExportRecurrencePeriod, self).__init__(**kwargs)
self.from_property = kwargs['from_property']
self.to = kwargs.get('to', None)
|
class ExportRecurrencePeriod(msrest.serialization.Model):
'''The start and end date for recurrence schedule.
All required parameters must be populated in order to send to Azure.
:param from_property: Required. The start date of recurrence.
:type from_property: ~datetime.datetime
:param to: The end date of recurrence.
:type to: ~datetime.datetime
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 7 | 0 | 7 | 0 | 1 | 0.47 | 1 | 1 | 0 | 0 | 1 | 2 | 1 | 1 | 27 | 5 | 15 | 9 | 10 | 7 | 7 | 6 | 5 | 1 | 1 | 0 | 1 |
10,723 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportSchedule
|
class ExportSchedule(msrest.serialization.Model):
"""The schedule associated with the export.
:param status: The status of the export's schedule. If 'Inactive', the export's schedule is
paused. Possible values include: "Active", "Inactive".
:type status: str or ~azure.mgmt.costmanagement.models.StatusType
:param recurrence: The schedule recurrence. Possible values include: "Daily", "Weekly",
"Monthly", "Annually".
:type recurrence: str or ~azure.mgmt.costmanagement.models.RecurrenceType
:param recurrence_period: Has start and end date of the recurrence. The start date must be in
future. If present, the end date must be greater than start date.
:type recurrence_period: ~azure.mgmt.costmanagement.models.ExportRecurrencePeriod
"""
_attribute_map = {
'status': {'key': 'status', 'type': 'str'},
'recurrence': {'key': 'recurrence', 'type': 'str'},
'recurrence_period': {'key': 'recurrencePeriod', 'type': 'ExportRecurrencePeriod'},
}
def __init__(
self,
**kwargs
):
super(ExportSchedule, self).__init__(**kwargs)
self.status = kwargs.get('status', None)
self.recurrence = kwargs.get('recurrence', None)
self.recurrence_period = kwargs.get('recurrence_period', None)
|
class ExportSchedule(msrest.serialization.Model):
'''The schedule associated with the export.
:param status: The status of the export's schedule. If 'Inactive', the export's schedule is
paused. Possible values include: "Active", "Inactive".
:type status: str or ~azure.mgmt.costmanagement.models.StatusType
:param recurrence: The schedule recurrence. Possible values include: "Daily", "Weekly",
"Monthly", "Annually".
:type recurrence: str or ~azure.mgmt.costmanagement.models.RecurrenceType
:param recurrence_period: Has start and end date of the recurrence. The start date must be in
future. If present, the end date must be greater than start date.
:type recurrence_period: ~azure.mgmt.costmanagement.models.ExportRecurrencePeriod
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 8 | 0 | 8 | 0 | 1 | 0.79 | 1 | 1 | 0 | 0 | 1 | 3 | 1 | 1 | 28 | 3 | 14 | 9 | 9 | 11 | 7 | 6 | 5 | 1 | 1 | 0 | 1 |
10,724 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ExportTimePeriod
|
class ExportTimePeriod(msrest.serialization.Model):
"""The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.
All required parameters must be populated in order to send to Azure.
:param from_property: Required. The start date for export data.
:type from_property: ~datetime.datetime
:param to: Required. The end date for export data.
:type to: ~datetime.datetime
"""
_validation = {
'from_property': {'required': True},
'to': {'required': True},
}
_attribute_map = {
'from_property': {'key': 'from', 'type': 'iso-8601'},
'to': {'key': 'to', 'type': 'iso-8601'},
}
def __init__(
self,
**kwargs
):
super(ExportTimePeriod, self).__init__(**kwargs)
self.from_property = kwargs['from_property']
self.to = kwargs['to']
|
class ExportTimePeriod(msrest.serialization.Model):
'''The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.
All required parameters must be populated in order to send to Azure.
:param from_property: Required. The start date for export data.
:type from_property: ~datetime.datetime
:param to: Required. The end date for export data.
:type to: ~datetime.datetime
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 7 | 0 | 7 | 0 | 1 | 0.44 | 1 | 1 | 0 | 0 | 1 | 2 | 1 | 1 | 28 | 5 | 16 | 9 | 11 | 7 | 7 | 6 | 5 | 1 | 1 | 0 | 1 |
10,725 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ForecastDataset
|
class ForecastDataset(msrest.serialization.Model):
"""The definition of data present in the forecast.
:param granularity: The granularity of rows in the forecast. Possible values include: "Daily".
:type granularity: str or ~azure.mgmt.costmanagement.models.GranularityType
:param configuration: Has configuration information for the data in the export. The
configuration will be ignored if aggregation and grouping are provided.
:type configuration: ~azure.mgmt.costmanagement.models.QueryDatasetConfiguration
:param aggregation: Dictionary of aggregation expression to use in the forecast. The key of
each item in the dictionary is the alias for the aggregated column. forecast can have up to 2
aggregation clauses.
:type aggregation: dict[str, ~azure.mgmt.costmanagement.models.QueryAggregation]
:param filter: Has filter expression to use in the forecast.
:type filter: ~azure.mgmt.costmanagement.models.QueryFilter
"""
_attribute_map = {
'granularity': {'key': 'granularity', 'type': 'str'},
'configuration': {'key': 'configuration', 'type': 'QueryDatasetConfiguration'},
'aggregation': {'key': 'aggregation', 'type': '{QueryAggregation}'},
'filter': {'key': 'filter', 'type': 'QueryFilter'},
}
def __init__(
self,
**kwargs
):
super(ForecastDataset, self).__init__(**kwargs)
self.granularity = kwargs.get('granularity', None)
self.configuration = kwargs.get('configuration', None)
self.aggregation = kwargs.get('aggregation', None)
self.filter = kwargs.get('filter', None)
|
class ForecastDataset(msrest.serialization.Model):
'''The definition of data present in the forecast.
:param granularity: The granularity of rows in the forecast. Possible values include: "Daily".
:type granularity: str or ~azure.mgmt.costmanagement.models.GranularityType
:param configuration: Has configuration information for the data in the export. The
configuration will be ignored if aggregation and grouping are provided.
:type configuration: ~azure.mgmt.costmanagement.models.QueryDatasetConfiguration
:param aggregation: Dictionary of aggregation expression to use in the forecast. The key of
each item in the dictionary is the alias for the aggregated column. forecast can have up to 2
aggregation clauses.
:type aggregation: dict[str, ~azure.mgmt.costmanagement.models.QueryAggregation]
:param filter: Has filter expression to use in the forecast.
:type filter: ~azure.mgmt.costmanagement.models.QueryFilter
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 9 | 0 | 9 | 0 | 1 | 0.81 | 1 | 1 | 0 | 0 | 1 | 4 | 1 | 1 | 32 | 3 | 16 | 10 | 11 | 13 | 8 | 7 | 6 | 1 | 1 | 0 | 1 |
10,726 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.ForecastDefinition
|
class ForecastDefinition(msrest.serialization.Model):
"""The definition of a forecast.
All required parameters must be populated in order to send to Azure.
:param type: Required. The type of the forecast. Possible values include: "Usage",
"ActualCost", "AmortizedCost".
:type type: str or ~azure.mgmt.costmanagement.models.ForecastType
:param timeframe: Required. The time frame for pulling data for the forecast. If custom, then a
specific time period must be provided. Possible values include: "MonthToDate",
"BillingMonthToDate", "TheLastMonth", "TheLastBillingMonth", "WeekToDate", "Custom".
:type timeframe: str or ~azure.mgmt.costmanagement.models.ForecastTimeframeType
:param time_period: Has time period for pulling data for the forecast.
:type time_period: ~azure.mgmt.costmanagement.models.QueryTimePeriod
:param dataset: Has definition for data in this forecast.
:type dataset: ~azure.mgmt.costmanagement.models.ForecastDataset
:param include_actual_cost: a boolean determining if actualCost will be included.
:type include_actual_cost: bool
:param include_fresh_partial_cost: a boolean determining if FreshPartialCost will be included.
:type include_fresh_partial_cost: bool
"""
_validation = {
'type': {'required': True},
'timeframe': {'required': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'timeframe': {'key': 'timeframe', 'type': 'str'},
'time_period': {'key': 'timePeriod', 'type': 'QueryTimePeriod'},
'dataset': {'key': 'dataset', 'type': 'ForecastDataset'},
'include_actual_cost': {'key': 'includeActualCost', 'type': 'bool'},
'include_fresh_partial_cost': {'key': 'includeFreshPartialCost', 'type': 'bool'},
}
def __init__(
self,
**kwargs
):
super(ForecastDefinition, self).__init__(**kwargs)
self.type = kwargs['type']
self.timeframe = kwargs['timeframe']
self.time_period = kwargs.get('time_period', None)
self.dataset = kwargs.get('dataset', None)
self.include_actual_cost = kwargs.get('include_actual_cost', None)
self.include_fresh_partial_cost = kwargs.get('include_fresh_partial_cost', None)
|
class ForecastDefinition(msrest.serialization.Model):
'''The definition of a forecast.
All required parameters must be populated in order to send to Azure.
:param type: Required. The type of the forecast. Possible values include: "Usage",
"ActualCost", "AmortizedCost".
:type type: str or ~azure.mgmt.costmanagement.models.ForecastType
:param timeframe: Required. The time frame for pulling data for the forecast. If custom, then a
specific time period must be provided. Possible values include: "MonthToDate",
"BillingMonthToDate", "TheLastMonth", "TheLastBillingMonth", "WeekToDate", "Custom".
:type timeframe: str or ~azure.mgmt.costmanagement.models.ForecastTimeframeType
:param time_period: Has time period for pulling data for the forecast.
:type time_period: ~azure.mgmt.costmanagement.models.QueryTimePeriod
:param dataset: Has definition for data in this forecast.
:type dataset: ~azure.mgmt.costmanagement.models.ForecastDataset
:param include_actual_cost: a boolean determining if actualCost will be included.
:type include_actual_cost: bool
:param include_fresh_partial_cost: a boolean determining if FreshPartialCost will be included.
:type include_fresh_partial_cost: bool
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 11 | 0 | 11 | 0 | 1 | 0.75 | 1 | 1 | 0 | 0 | 1 | 6 | 1 | 1 | 47 | 5 | 24 | 13 | 19 | 18 | 11 | 10 | 9 | 1 | 1 | 0 | 1 |
10,727 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.KpiProperties
|
class KpiProperties(msrest.serialization.Model):
"""Each KPI must contain a 'type' and 'enabled' key.
:param type: KPI type (Forecast, Budget). Possible values include: "Forecast", "Budget".
:type type: str or ~azure.mgmt.costmanagement.models.KpiType
:param id: ID of resource related to metric (budget).
:type id: str
:param enabled: show the KPI in the UI?.
:type enabled: bool
"""
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'id': {'key': 'id', 'type': 'str'},
'enabled': {'key': 'enabled', 'type': 'bool'},
}
def __init__(
self,
**kwargs
):
super(KpiProperties, self).__init__(**kwargs)
self.type = kwargs.get('type', None)
self.id = kwargs.get('id', None)
self.enabled = kwargs.get('enabled', None)
|
class KpiProperties(msrest.serialization.Model):
'''Each KPI must contain a 'type' and 'enabled' key.
:param type: KPI type (Forecast, Budget). Possible values include: "Forecast", "Budget".
:type type: str or ~azure.mgmt.costmanagement.models.KpiType
:param id: ID of resource related to metric (budget).
:type id: str
:param enabled: show the KPI in the UI?.
:type enabled: bool
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 8 | 0 | 8 | 0 | 1 | 0.57 | 1 | 1 | 0 | 0 | 1 | 3 | 1 | 1 | 25 | 3 | 14 | 9 | 9 | 8 | 7 | 6 | 5 | 1 | 1 | 0 | 1 |
10,728 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.CommonExportProperties
|
class CommonExportProperties(msrest.serialization.Model):
"""The common properties of the export.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:param format: The format of the export being delivered. Currently only 'Csv' is supported.
Possible values include: "Csv".
:type format: str or ~azure.mgmt.costmanagement.models.FormatType
:param delivery_info: Required. Has delivery information for the export.
:type delivery_info: ~azure.mgmt.costmanagement.models.ExportDeliveryInfo
:param definition: Required. Has the definition for the export.
:type definition: ~azure.mgmt.costmanagement.models.ExportDefinition
:param run_history: If requested, has the most recent execution history for the export.
:type run_history: ~azure.mgmt.costmanagement.models.ExportExecutionListResult
:ivar next_run_time_estimate: If the export has an active schedule, provides an estimate of the
next execution time.
:vartype next_run_time_estimate: ~datetime.datetime
"""
_validation = {
'delivery_info': {'required': True},
'definition': {'required': True},
'next_run_time_estimate': {'readonly': True},
}
_attribute_map = {
'format': {'key': 'format', 'type': 'str'},
'delivery_info': {'key': 'deliveryInfo', 'type': 'ExportDeliveryInfo'},
'definition': {'key': 'definition', 'type': 'ExportDefinition'},
'run_history': {'key': 'runHistory', 'type': 'ExportExecutionListResult'},
'next_run_time_estimate': {'key': 'nextRunTimeEstimate', 'type': 'iso-8601'},
}
def __init__(
self,
**kwargs
):
super(CommonExportProperties, self).__init__(**kwargs)
self.format = kwargs.get('format', None)
self.delivery_info = kwargs['delivery_info']
self.definition = kwargs['definition']
self.run_history = kwargs.get('run_history', None)
self.next_run_time_estimate = None
|
class CommonExportProperties(msrest.serialization.Model):
'''The common properties of the export.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
:param format: The format of the export being delivered. Currently only 'Csv' is supported.
Possible values include: "Csv".
:type format: str or ~azure.mgmt.costmanagement.models.FormatType
:param delivery_info: Required. Has delivery information for the export.
:type delivery_info: ~azure.mgmt.costmanagement.models.ExportDeliveryInfo
:param definition: Required. Has the definition for the export.
:type definition: ~azure.mgmt.costmanagement.models.ExportDefinition
:param run_history: If requested, has the most recent execution history for the export.
:type run_history: ~azure.mgmt.costmanagement.models.ExportExecutionListResult
:ivar next_run_time_estimate: If the export has an active schedule, provides an estimate of the
next execution time.
:vartype next_run_time_estimate: ~datetime.datetime
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 10 | 0 | 10 | 0 | 1 | 0.7 | 1 | 1 | 0 | 1 | 1 | 5 | 1 | 1 | 45 | 6 | 23 | 12 | 18 | 16 | 10 | 9 | 8 | 1 | 1 | 0 | 1 |
10,729 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.AlertPropertiesDetails
|
class AlertPropertiesDetails(msrest.serialization.Model):
"""Alert details.
:param time_grain_type: Type of timegrain cadence. Possible values include: "None", "Monthly",
"Quarterly", "Annually", "BillingMonth", "BillingQuarter", "BillingAnnual".
:type time_grain_type: str or ~azure.mgmt.costmanagement.models.AlertTimeGrainType
:param period_start_date: datetime of periodStartDate.
:type period_start_date: str
:param triggered_by: notificationId that triggered this alert.
:type triggered_by: str
:param resource_group_filter: array of resourceGroups to filter by.
:type resource_group_filter: list[object]
:param resource_filter: array of resources to filter by.
:type resource_filter: list[object]
:param meter_filter: array of meters to filter by.
:type meter_filter: list[object]
:param tag_filter: tags to filter by.
:type tag_filter: object
:param threshold: notification threshold percentage as a decimal which activated this alert.
:type threshold: float
:param operator: operator used to compare currentSpend with amount. Possible values include:
"None", "EqualTo", "GreaterThan", "GreaterThanOrEqualTo", "LessThan", "LessThanOrEqualTo".
:type operator: str or ~azure.mgmt.costmanagement.models.AlertOperator
:param amount: budget threshold amount.
:type amount: float
:param unit: unit of currency being used.
:type unit: str
:param current_spend: current spend.
:type current_spend: float
:param contact_emails: list of emails to contact.
:type contact_emails: list[str]
:param contact_groups: list of action groups to broadcast to.
:type contact_groups: list[str]
:param contact_roles: list of contact roles.
:type contact_roles: list[str]
:param overriding_alert: overriding alert.
:type overriding_alert: str
"""
_attribute_map = {
'time_grain_type': {'key': 'timeGrainType', 'type': 'str'},
'period_start_date': {'key': 'periodStartDate', 'type': 'str'},
'triggered_by': {'key': 'triggeredBy', 'type': 'str'},
'resource_group_filter': {'key': 'resourceGroupFilter', 'type': '[object]'},
'resource_filter': {'key': 'resourceFilter', 'type': '[object]'},
'meter_filter': {'key': 'meterFilter', 'type': '[object]'},
'tag_filter': {'key': 'tagFilter', 'type': 'object'},
'threshold': {'key': 'threshold', 'type': 'float'},
'operator': {'key': 'operator', 'type': 'str'},
'amount': {'key': 'amount', 'type': 'float'},
'unit': {'key': 'unit', 'type': 'str'},
'current_spend': {'key': 'currentSpend', 'type': 'float'},
'contact_emails': {'key': 'contactEmails', 'type': '[str]'},
'contact_groups': {'key': 'contactGroups', 'type': '[str]'},
'contact_roles': {'key': 'contactRoles', 'type': '[str]'},
'overriding_alert': {'key': 'overridingAlert', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(AlertPropertiesDetails, self).__init__(**kwargs)
self.time_grain_type = kwargs.get('time_grain_type', None)
self.period_start_date = kwargs.get('period_start_date', None)
self.triggered_by = kwargs.get('triggered_by', None)
self.resource_group_filter = kwargs.get('resource_group_filter', None)
self.resource_filter = kwargs.get('resource_filter', None)
self.meter_filter = kwargs.get('meter_filter', None)
self.tag_filter = kwargs.get('tag_filter', None)
self.threshold = kwargs.get('threshold', None)
self.operator = kwargs.get('operator', None)
self.amount = kwargs.get('amount', None)
self.unit = kwargs.get('unit', None)
self.current_spend = kwargs.get('current_spend', None)
self.contact_emails = kwargs.get('contact_emails', None)
self.contact_groups = kwargs.get('contact_groups', None)
self.contact_roles = kwargs.get('contact_roles', None)
self.overriding_alert = kwargs.get('overriding_alert', None)
|
class AlertPropertiesDetails(msrest.serialization.Model):
'''Alert details.
:param time_grain_type: Type of timegrain cadence. Possible values include: "None", "Monthly",
"Quarterly", "Annually", "BillingMonth", "BillingQuarter", "BillingAnnual".
:type time_grain_type: str or ~azure.mgmt.costmanagement.models.AlertTimeGrainType
:param period_start_date: datetime of periodStartDate.
:type period_start_date: str
:param triggered_by: notificationId that triggered this alert.
:type triggered_by: str
:param resource_group_filter: array of resourceGroups to filter by.
:type resource_group_filter: list[object]
:param resource_filter: array of resources to filter by.
:type resource_filter: list[object]
:param meter_filter: array of meters to filter by.
:type meter_filter: list[object]
:param tag_filter: tags to filter by.
:type tag_filter: object
:param threshold: notification threshold percentage as a decimal which activated this alert.
:type threshold: float
:param operator: operator used to compare currentSpend with amount. Possible values include:
"None", "EqualTo", "GreaterThan", "GreaterThanOrEqualTo", "LessThan", "LessThanOrEqualTo".
:type operator: str or ~azure.mgmt.costmanagement.models.AlertOperator
:param amount: budget threshold amount.
:type amount: float
:param unit: unit of currency being used.
:type unit: str
:param current_spend: current spend.
:type current_spend: float
:param contact_emails: list of emails to contact.
:type contact_emails: list[str]
:param contact_groups: list of action groups to broadcast to.
:type contact_groups: list[str]
:param contact_roles: list of contact roles.
:type contact_roles: list[str]
:param overriding_alert: overriding alert.
:type overriding_alert: str
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 21 | 0 | 21 | 0 | 1 | 0.9 | 1 | 1 | 0 | 0 | 1 | 16 | 1 | 1 | 79 | 3 | 40 | 22 | 35 | 36 | 20 | 19 | 18 | 1 | 1 | 0 | 1 |
10,730 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.AlertPropertiesDefinition
|
class AlertPropertiesDefinition(msrest.serialization.Model):
"""defines the type of alert.
:param type: type of alert. Possible values include: "Budget", "Invoice", "Credit", "Quota",
"General", "xCloud", "BudgetForecast".
:type type: str or ~azure.mgmt.costmanagement.models.AlertType
:param category: Alert category. Possible values include: "Cost", "Usage", "Billing", "System".
:type category: str or ~azure.mgmt.costmanagement.models.AlertCategory
:param criteria: Criteria that triggered alert. Possible values include:
"CostThresholdExceeded", "UsageThresholdExceeded", "CreditThresholdApproaching",
"CreditThresholdReached", "QuotaThresholdApproaching", "QuotaThresholdReached",
"MultiCurrency", "ForecastCostThresholdExceeded", "ForecastUsageThresholdExceeded",
"InvoiceDueDateApproaching", "InvoiceDueDateReached", "CrossCloudNewDataAvailable",
"CrossCloudCollectionError", "GeneralThresholdError".
:type criteria: str or ~azure.mgmt.costmanagement.models.AlertCriteria
"""
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'category': {'key': 'category', 'type': 'str'},
'criteria': {'key': 'criteria', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(AlertPropertiesDefinition, self).__init__(**kwargs)
self.type = kwargs.get('type', None)
self.category = kwargs.get('category', None)
self.criteria = kwargs.get('criteria', None)
|
class AlertPropertiesDefinition(msrest.serialization.Model):
'''defines the type of alert.
:param type: type of alert. Possible values include: "Budget", "Invoice", "Credit", "Quota",
"General", "xCloud", "BudgetForecast".
:type type: str or ~azure.mgmt.costmanagement.models.AlertType
:param category: Alert category. Possible values include: "Cost", "Usage", "Billing", "System".
:type category: str or ~azure.mgmt.costmanagement.models.AlertCategory
:param criteria: Criteria that triggered alert. Possible values include:
"CostThresholdExceeded", "UsageThresholdExceeded", "CreditThresholdApproaching",
"CreditThresholdReached", "QuotaThresholdApproaching", "QuotaThresholdReached",
"MultiCurrency", "ForecastCostThresholdExceeded", "ForecastUsageThresholdExceeded",
"InvoiceDueDateApproaching", "InvoiceDueDateReached", "CrossCloudNewDataAvailable",
"CrossCloudCollectionError", "GeneralThresholdError".
:type criteria: str or ~azure.mgmt.costmanagement.models.AlertCriteria
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 8 | 0 | 8 | 0 | 1 | 1 | 1 | 1 | 0 | 0 | 1 | 3 | 1 | 1 | 31 | 3 | 14 | 9 | 9 | 14 | 7 | 6 | 5 | 1 | 1 | 0 | 1 |
10,731 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.Alert
|
class Alert(Resource):
"""An individual alert.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:param definition: defines the type of alert.
:type definition: ~azure.mgmt.costmanagement.models.AlertPropertiesDefinition
:param description: Alert description.
:type description: str
:param source: Source of alert. Possible values include: "Preset", "User".
:type source: str or ~azure.mgmt.costmanagement.models.AlertSource
:param details: Alert details.
:type details: ~azure.mgmt.costmanagement.models.AlertPropertiesDetails
:param cost_entity_id: related budget.
:type cost_entity_id: str
:param status: alert status. Possible values include: "None", "Active", "Overridden",
"Resolved", "Dismissed".
:type status: str or ~azure.mgmt.costmanagement.models.AlertStatus
:param creation_time: dateTime in which alert was created.
:type creation_time: str
:param close_time: dateTime in which alert was closed.
:type close_time: str
:param modification_time: dateTime in which alert was last modified.
:type modification_time: str
:param status_modification_user_name:
:type status_modification_user_name: str
:param status_modification_time: dateTime in which the alert status was last modified.
:type status_modification_time: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'tags': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'definition': {'key': 'properties.definition', 'type': 'AlertPropertiesDefinition'},
'description': {'key': 'properties.description', 'type': 'str'},
'source': {'key': 'properties.source', 'type': 'str'},
'details': {'key': 'properties.details', 'type': 'AlertPropertiesDetails'},
'cost_entity_id': {'key': 'properties.costEntityId', 'type': 'str'},
'status': {'key': 'properties.status', 'type': 'str'},
'creation_time': {'key': 'properties.creationTime', 'type': 'str'},
'close_time': {'key': 'properties.closeTime', 'type': 'str'},
'modification_time': {'key': 'properties.modificationTime', 'type': 'str'},
'status_modification_user_name': {'key': 'properties.statusModificationUserName', 'type': 'str'},
'status_modification_time': {'key': 'properties.statusModificationTime', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(Alert, self).__init__(**kwargs)
self.definition = kwargs.get('definition', None)
self.description = kwargs.get('description', None)
self.source = kwargs.get('source', None)
self.details = kwargs.get('details', None)
self.cost_entity_id = kwargs.get('cost_entity_id', None)
self.status = kwargs.get('status', None)
self.creation_time = kwargs.get('creation_time', None)
self.close_time = kwargs.get('close_time', None)
self.modification_time = kwargs.get('modification_time', None)
self.status_modification_user_name = kwargs.get('status_modification_user_name', None)
self.status_modification_time = kwargs.get('status_modification_time', None)
|
class Alert(Resource):
'''An individual alert.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Resource Id.
:vartype id: str
:ivar name: Resource name.
:vartype name: str
:ivar type: Resource type.
:vartype type: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:param definition: defines the type of alert.
:type definition: ~azure.mgmt.costmanagement.models.AlertPropertiesDefinition
:param description: Alert description.
:type description: str
:param source: Source of alert. Possible values include: "Preset", "User".
:type source: str or ~azure.mgmt.costmanagement.models.AlertSource
:param details: Alert details.
:type details: ~azure.mgmt.costmanagement.models.AlertPropertiesDetails
:param cost_entity_id: related budget.
:type cost_entity_id: str
:param status: alert status. Possible values include: "None", "Active", "Overridden",
"Resolved", "Dismissed".
:type status: str or ~azure.mgmt.costmanagement.models.AlertStatus
:param creation_time: dateTime in which alert was created.
:type creation_time: str
:param close_time: dateTime in which alert was closed.
:type close_time: str
:param modification_time: dateTime in which alert was last modified.
:type modification_time: str
:param status_modification_user_name:
:type status_modification_user_name: str
:param status_modification_time: dateTime in which the alert status was last modified.
:type status_modification_time: str
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 16 | 0 | 16 | 0 | 1 | 0.85 | 1 | 1 | 0 | 0 | 1 | 11 | 1 | 2 | 79 | 5 | 40 | 18 | 35 | 34 | 16 | 15 | 14 | 1 | 2 | 0 | 1 |
10,732 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ForecastType
|
class ForecastType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The type of the forecast.
"""
USAGE = "Usage"
ACTUAL_COST = "ActualCost"
AMORTIZED_COST = "AmortizedCost"
|
class ForecastType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The type of the forecast.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.5 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 7 | 1 | 4 | 4 | 3 | 2 | 4 | 4 | 3 | 0 | 1 | 0 | 0 |
10,733 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.FormatType
|
class FormatType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The format of the export being delivered. Currently only 'Csv' is supported.
"""
CSV = "Csv"
|
class FormatType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The format of the export being delivered. Currently only 'Csv' is supported.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 5 | 1 | 2 | 2 | 1 | 2 | 2 | 2 | 1 | 0 | 1 | 0 | 0 |
10,734 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.FunctionType
|
class FunctionType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The name of the aggregation function to use.
"""
SUM = "Sum"
|
class FunctionType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The name of the aggregation function to use.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 5 | 1 | 2 | 2 | 1 | 2 | 2 | 2 | 1 | 0 | 1 | 0 | 0 |
10,735 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.GranularityType
|
class GranularityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The granularity of rows in the forecast.
"""
DAILY = "Daily"
|
class GranularityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The granularity of rows in the forecast.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 5 | 1 | 2 | 2 | 1 | 2 | 2 | 2 | 1 | 0 | 1 | 0 | 0 |
10,736 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.KpiType
|
class KpiType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""KPI type (Forecast, Budget).
"""
FORECAST = "Forecast"
BUDGET = "Budget"
|
class KpiType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''KPI type (Forecast, Budget).
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,737 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.MetricType
|
class MetricType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Metric to use when displaying costs.
"""
ACTUAL_COST = "ActualCost"
AMORTIZED_COST = "AmortizedCost"
AHUB = "AHUB"
|
class MetricType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''Metric to use when displaying costs.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.5 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 7 | 1 | 4 | 4 | 3 | 2 | 4 | 4 | 3 | 0 | 1 | 0 | 0 |
10,738 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.OperatorType
|
class OperatorType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The operator to use for comparison.
"""
IN_ENUM = "In"
CONTAINS = "Contains"
|
class OperatorType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The operator to use for comparison.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,739 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.PivotType
|
class PivotType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Data type to show in view.
"""
DIMENSION = "Dimension"
TAG_KEY = "TagKey"
|
class PivotType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''Data type to show in view.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,740 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/operations/_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.operations._operations.Operations
|
class Operations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s
:attr:`operations` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.Operation"]:
"""List the operations for the provider.
:return: An iterator like instance of either Operation or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.Operation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.OperationListResult] = kwargs.pop("cls", None)
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("OperationListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class Operations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s
:attr:`operations` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.Operation"]:
'''List the operations for the provider.
:return: An iterator like instance of either Operation or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.Operation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 26 | 3 | 21 | 2 | 2 | 0.23 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 94 | 16 | 65 | 28 | 58 | 15 | 45 | 27 | 39 | 5 | 0 | 1 | 12 |
10,741 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.QueryColumnType
|
class QueryColumnType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The type of the column in the export.
"""
TAG = "Tag"
DIMENSION = "Dimension"
|
class QueryColumnType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The type of the column in the export.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,742 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.RecurrenceType
|
class RecurrenceType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The schedule recurrence.
"""
DAILY = "Daily"
WEEKLY = "Weekly"
MONTHLY = "Monthly"
ANNUALLY = "Annually"
|
class RecurrenceType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The schedule recurrence.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.4 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 8 | 1 | 5 | 5 | 4 | 2 | 5 | 5 | 4 | 0 | 1 | 0 | 0 |
10,743 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ReportConfigColumnType
|
class ReportConfigColumnType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The type of the column in the report.
"""
TAG = "Tag"
DIMENSION = "Dimension"
|
class ReportConfigColumnType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The type of the column in the report.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,744 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ReportConfigSortingDirection
|
class ReportConfigSortingDirection(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""Direction of sort.
"""
ASCENDING = "Ascending"
DESCENDING = "Descending"
|
class ReportConfigSortingDirection(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''Direction of sort.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,745 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ReportGranularityType
|
class ReportGranularityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The granularity of rows in the report.
"""
DAILY = "Daily"
MONTHLY = "Monthly"
|
class ReportGranularityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The granularity of rows in the report.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,746 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ReportTimeframeType
|
class ReportTimeframeType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The time frame for pulling data for the report. If custom, then a specific time period must be
provided.
"""
WEEK_TO_DATE = "WeekToDate"
MONTH_TO_DATE = "MonthToDate"
YEAR_TO_DATE = "YearToDate"
CUSTOM = "Custom"
|
class ReportTimeframeType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The time frame for pulling data for the report. If custom, then a specific time period must be
provided.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.6 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 9 | 1 | 5 | 5 | 4 | 3 | 5 | 5 | 4 | 0 | 1 | 0 | 0 |
10,747 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.ReportType
|
class ReportType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The type of the report. Usage represents actual usage, forecast represents forecasted data and
UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data
can be differentiated based on dates.
"""
USAGE = "Usage"
|
class ReportType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The type of the report. Usage represents actual usage, forecast represents forecasted data and
UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data
can be differentiated based on dates.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 2 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 7 | 1 | 2 | 2 | 1 | 4 | 2 | 2 | 1 | 0 | 1 | 0 | 0 |
10,748 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.StatusType
|
class StatusType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The status of the export's schedule. If 'Inactive', the export's schedule is paused.
"""
ACTIVE = "Active"
INACTIVE = "Inactive"
|
class StatusType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The status of the export's schedule. If 'Inactive', the export's schedule is paused.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.67 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 6 | 1 | 3 | 3 | 2 | 2 | 3 | 3 | 2 | 0 | 1 | 0 | 0 |
10,749 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.TimeframeType
|
class TimeframeType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The time frame for pulling data for the query. If custom, then a specific time period must be
provided.
"""
MONTH_TO_DATE = "MonthToDate"
BILLING_MONTH_TO_DATE = "BillingMonthToDate"
THE_LAST_MONTH = "TheLastMonth"
THE_LAST_BILLING_MONTH = "TheLastBillingMonth"
WEEK_TO_DATE = "WeekToDate"
CUSTOM = "Custom"
|
class TimeframeType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The time frame for pulling data for the query. If custom, then a specific time period must be
provided.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0.43 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 11 | 1 | 7 | 7 | 6 | 3 | 7 | 7 | 6 | 0 | 1 | 0 | 0 |
10,750 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_cost_management_client_enums.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._cost_management_client_enums.QueryOperatorType
|
class QueryOperatorType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
"""The operator to use for comparison.
"""
IN_ENUM = "In"
|
class QueryOperatorType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
'''The operator to use for comparison.
'''
pass
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 5 | 1 | 2 | 2 | 1 | 2 | 2 | 2 | 1 | 0 | 1 | 0 | 0 |
10,751 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/operations/_mongo_clusters_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.operations._mongo_clusters_operations.MongoClustersOperations
|
class MongoClustersOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s
:attr:`mongo_clusters` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@overload
def check_name_availability(
self,
location: str,
body: _models.CheckNameAvailabilityRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CheckNameAvailabilityResponse:
"""Check if mongo cluster name is available for use.
:param location: The name of the Azure region. Required.
:type location: str
:param body: The CheckAvailability request. Required.
:type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: CheckNameAvailabilityResponse or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def check_name_availability(
self, location: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any
) -> _models.CheckNameAvailabilityResponse:
"""Check if mongo cluster name is available for use.
:param location: The name of the Azure region. Required.
:type location: str
:param body: The CheckAvailability request. Required.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: CheckNameAvailabilityResponse or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def check_name_availability(
self, location: str, body: Union[_models.CheckNameAvailabilityRequest, IO[bytes]], **kwargs: Any
) -> _models.CheckNameAvailabilityResponse:
"""Check if mongo cluster name is available for use.
:param location: The name of the Azure region. Required.
:type location: str
:param body: The CheckAvailability request. Is either a CheckNameAvailabilityRequest type or a
IO[bytes] type. Required.
:type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest or IO[bytes]
:return: CheckNameAvailabilityResponse or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.CheckNameAvailabilityResponse] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(body, (IOBase, bytes)):
_content = body
else:
_json = self._serialize.body(body, "CheckNameAvailabilityRequest")
_request = build_check_name_availability_request(
location=location,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("CheckNameAvailabilityResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.MongoCluster"]:
"""List all the mongo clusters in a given subscription.
:return: An iterator like instance of either MongoCluster or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.MongoClusterListResult] = kwargs.pop("cls", None)
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("MongoClusterListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Iterable["_models.MongoCluster"]:
"""List all the mongo clusters in a given resource group.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:return: An iterator like instance of either MongoCluster or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.MongoClusterListResult] = kwargs.pop("cls", None)
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_resource_group_request(
resource_group_name=resource_group_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("MongoClusterListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> _models.MongoCluster:
"""Gets information about a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: MongoCluster or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.MongoCluster
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.MongoCluster] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("MongoCluster", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_or_update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: Union[_models.MongoCluster, IO[bytes]],
**kwargs: Any
) -> _models.MongoCluster:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.MongoCluster] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(resource, (IOBase, bytes)):
_content = resource
else:
_json = self._serialize.body(resource, "MongoCluster")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 200:
deserialized = self._deserialize("MongoCluster", pipeline_response)
if response.status_code == 201:
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
deserialized = self._deserialize("MongoCluster", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: _models.MongoCluster,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
"""Create or update a mongo cluster. Update overwrites all properties for the resource. To only
modify some of the properties, use PATCH.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param resource: Resource create parameters. Required.
:type resource: ~azure.mgmt.mongocluster.models.MongoCluster
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
"""Create or update a mongo cluster. Update overwrites all properties for the resource. To only
modify some of the properties, use PATCH.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param resource: Resource create parameters. Required.
:type resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: Union[_models.MongoCluster, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
"""Create or update a mongo cluster. Update overwrites all properties for the resource. To only
modify some of the properties, use PATCH.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param resource: Resource create parameters. Is either a MongoCluster type or a IO[bytes] type.
Required.
:type resource: ~azure.mgmt.mongocluster.models.MongoCluster or IO[bytes]
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.MongoCluster] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
resource=resource,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("MongoCluster", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.MongoCluster].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.MongoCluster](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: Union[_models.MongoClusterUpdate, IO[bytes]],
**kwargs: Any
) -> Optional[_models.MongoCluster]:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Optional[_models.MongoCluster]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(properties, (IOBase, bytes)):
_content = properties
else:
_json = self._serialize.body(properties, "MongoClusterUpdate")
_request = build_update_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = None
response_headers = {}
if response.status_code == 200:
deserialized = self._deserialize("MongoCluster", pipeline_response)
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: _models.MongoClusterUpdate,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
"""Updates an existing mongo cluster. The request body can contain one to many of the properties
present in the normal mongo cluster definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param properties: The resource properties to be updated. Required.
:type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
"""Updates an existing mongo cluster. The request body can contain one to many of the properties
present in the normal mongo cluster definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param properties: The resource properties to be updated. Required.
:type properties: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: Union[_models.MongoClusterUpdate, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
"""Updates an existing mongo cluster. The request body can contain one to many of the properties
present in the normal mongo cluster definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param properties: The resource properties to be updated. Is either a MongoClusterUpdate type
or a IO[bytes] type. Required.
:type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate or IO[bytes]
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.MongoCluster] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._update_initial(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
properties=properties,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("MongoCluster", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.MongoCluster].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.MongoCluster](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> None:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
if cls:
return cls(pipeline_response, None, response_headers) # type: ignore
@distributed_trace
def begin_delete(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> LROPoller[None]:
"""Deletes a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial( # type: ignore
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_connection_strings(
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> _models.ListConnectionStringsResult:
"""List mongo cluster connection strings. This includes the default connection string using
SCRAM-SHA-256, as well as other connection strings supported by the cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: ListConnectionStringsResult or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.ListConnectionStringsResult
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ListConnectionStringsResult] = kwargs.pop("cls", None)
_request = build_list_connection_strings_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("ListConnectionStringsResult", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
|
class MongoClustersOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s
:attr:`mongo_clusters` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@overload
def check_name_availability(
self,
location: str,
body: _models.CheckNameAvailabilityRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CheckNameAvailabilityResponse:
'''Check if mongo cluster name is available for use.
:param location: The name of the Azure region. Required.
:type location: str
:param body: The CheckAvailability request. Required.
:type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: CheckNameAvailabilityResponse or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def check_name_availability(
self,
location: str,
body: _models.CheckNameAvailabilityRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CheckNameAvailabilityResponse:
'''Check if mongo cluster name is available for use.
:param location: The name of the Azure region. Required.
:type location: str
:param body: The CheckAvailability request. Required.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: CheckNameAvailabilityResponse or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def check_name_availability(
self,
location: str,
body: _models.CheckNameAvailabilityRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CheckNameAvailabilityResponse:
'''Check if mongo cluster name is available for use.
:param location: The name of the Azure region. Required.
:type location: str
:param body: The CheckAvailability request. Is either a CheckNameAvailabilityRequest type or a
IO[bytes] type. Required.
:type body: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityRequest or IO[bytes]
:return: CheckNameAvailabilityResponse or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.CheckNameAvailabilityResponse
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.MongoCluster"]:
'''List all the mongo clusters in a given subscription.
:return: An iterator like instance of either MongoCluster or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> Iterable["_models.MongoCluster"]:
'''List all the mongo clusters in a given resource group.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:return: An iterator like instance of either MongoCluster or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_next(next_link=None):
'''Gets information about a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: MongoCluster or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.MongoCluster
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_or_update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: Union[_models.MongoCluster, IO[bytes]],
**kwargs: Any
) -> _models.MongoCluster:
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: _models.MongoCluster,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
'''Create or update a mongo cluster. Update overwrites all properties for the resource. To only
modify some of the properties, use PATCH.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param resource: Resource create parameters. Required.
:type resource: ~azure.mgmt.mongocluster.models.MongoCluster
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: _models.MongoCluster,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
'''Create or update a mongo cluster. Update overwrites all properties for the resource. To only
modify some of the properties, use PATCH.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param resource: Resource create parameters. Required.
:type resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
resource: _models.MongoCluster,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
'''Create or update a mongo cluster. Update overwrites all properties for the resource. To only
modify some of the properties, use PATCH.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param resource: Resource create parameters. Is either a MongoCluster type or a IO[bytes] type.
Required.
:type resource: ~azure.mgmt.mongocluster.models.MongoCluster or IO[bytes]
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: Union[_models.MongoClusterUpdate, IO[bytes]],
**kwargs: Any
) -> Optional[_models.MongoCluster]:
pass
@overload
def begin_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: _models.MongoClusterUpdate,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
'''Updates an existing mongo cluster. The request body can contain one to many of the properties
present in the normal mongo cluster definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param properties: The resource properties to be updated. Required.
:type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: _models.MongoClusterUpdate,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
'''Updates an existing mongo cluster. The request body can contain one to many of the properties
present in the normal mongo cluster definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param properties: The resource properties to be updated. Required.
:type properties: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
properties: _models.MongoClusterUpdate,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.MongoCluster]:
'''Updates an existing mongo cluster. The request body can contain one to many of the properties
present in the normal mongo cluster definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param properties: The resource properties to be updated. Is either a MongoClusterUpdate type
or a IO[bytes] type. Required.
:type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate or IO[bytes]
:return: An instance of LROPoller that returns either MongoCluster or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.MongoCluster]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> None:
pass
@distributed_trace
def begin_delete(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> LROPoller[None]:
'''Deletes a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_connection_strings(
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> _models.ListConnectionStringsResult:
'''List mongo cluster connection strings. This includes the default connection string using
SCRAM-SHA-256, as well as other connection strings supported by the cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: ListConnectionStringsResult or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.ListConnectionStringsResult
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
| 42 | 15 | 36 | 4 | 25 | 8 | 3 | 0.36 | 0 | 9 | 0 | 0 | 18 | 4 | 18 | 18 | 906 | 124 | 597 | 257 | 484 | 215 | 317 | 172 | 289 | 6 | 0 | 1 | 72 |
10,752 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/operations/_firewall_rules_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.operations._firewall_rules_operations.FirewallRulesOperations
|
class FirewallRulesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s
:attr:`firewall_rules` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_by_mongo_cluster(
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> Iterable["_models.FirewallRule"]:
"""List all the firewall rules in a given mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: An iterator like instance of either FirewallRule or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.FirewallRuleListResult] = kwargs.pop("cls", None)
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_mongo_cluster_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("FirewallRuleListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get(
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> _models.FirewallRule:
"""Gets information about a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: FirewallRule or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.FirewallRule
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.FirewallRule] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("FirewallRule", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_or_update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: Union[_models.FirewallRule, IO[bytes]],
**kwargs: Any
) -> Optional[_models.FirewallRule]:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Optional[_models.FirewallRule]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(resource, (IOBase, bytes)):
_content = resource
else:
_json = self._serialize.body(resource, "FirewallRule")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201, 202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = None
response_headers = {}
if response.status_code == 200:
deserialized = self._deserialize("FirewallRule", pipeline_response)
if response.status_code == 201:
deserialized = self._deserialize("FirewallRule", pipeline_response)
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.FirewallRule]:
"""Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.FirewallRule]:
"""Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: Union[_models.FirewallRule, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.FirewallRule]:
"""Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Is either a FirewallRule type or a IO[bytes] type.
Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule or IO[bytes]
:return: An instance of LROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.FirewallRule] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
resource=resource,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("FirewallRule", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.FirewallRule].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.FirewallRule](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> None:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
if cls:
return cls(pipeline_response, None, response_headers) # type: ignore
@distributed_trace
def begin_delete(
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial( # type: ignore
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class FirewallRulesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.MongoClusterMgmtClient`'s
:attr:`firewall_rules` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_by_mongo_cluster(
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> Iterable["_models.FirewallRule"]:
'''List all the firewall rules in a given mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: An iterator like instance of either FirewallRule or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_next(next_link=None):
'''Gets information about a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: FirewallRule or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.FirewallRule
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_or_update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: Union[_models.FirewallRule, IO[bytes]],
**kwargs: Any
) -> Optional[_models.FirewallRule]:
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.FirewallRule]:
'''Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.FirewallRule]:
'''Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.FirewallRule]:
'''Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Is either a FirewallRule type or a IO[bytes] type.
Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule or IO[bytes]
:return: An instance of LROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> None:
pass
@distributed_trace
def begin_delete(
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 21 | 7 | 37 | 4 | 27 | 8 | 3 | 0.34 | 0 | 9 | 0 | 0 | 9 | 4 | 9 | 9 | 486 | 63 | 329 | 139 | 268 | 111 | 172 | 93 | 157 | 7 | 0 | 1 | 42 |
10,753 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/models/_mongo_cluster_mgmt_client_enums.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.models._mongo_cluster_mgmt_client_enums.PublicNetworkAccess
|
class PublicNetworkAccess(str, Enum, metaclass=CaseInsensitiveEnumMeta):
"""Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and
default value is 'Enabled'.
"""
ENABLED = "Enabled"
"""If set, mongo cluster can be accessed through private and public methods."""
DISABLED = "Disabled"
"""If set, the private endpoints are the exclusive access method."""
|
class PublicNetworkAccess(str, Enum, metaclass=CaseInsensitiveEnumMeta):
'''Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and
default value is 'Enabled'.
'''
| 1 | 1 | 0 | 0 | 0 | 0 | 0 | 1.67 | 3 | 0 | 0 | 0 | 0 | 0 | 0 | 115 | 9 | 1 | 3 | 3 | 2 | 5 | 3 | 3 | 2 | 0 | 4 | 0 | 0 |
10,754 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_mongodb_databases_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_mongodb_databases_operations.RestorableMongodbDatabasesOperations
|
class RestorableMongodbDatabasesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_mongodb_databases` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self, location: str, instance_id: str, **kwargs: Any
) -> Iterable["_models.RestorableMongodbDatabaseGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under
the restorable account. This helps in scenario where database was accidentally deleted to get
the deletion time. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: An iterator like instance of either RestorableMongodbDatabaseGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableMongodbDatabaseGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableMongodbDatabasesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableMongodbDatabasesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableMongodbDatabasesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_mongodb_databases` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self, location: str, instance_id: str, **kwargs: Any
) -> Iterable["_models.RestorableMongodbDatabaseGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under
the restorable account. This helps in scenario where database was accidentally deleted to get
the deletion time. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: An iterator like instance of either RestorableMongodbDatabaseGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableMongodbDatabaseGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 28 | 3 | 21 | 4 | 2 | 0.37 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 106 | 16 | 67 | 29 | 58 | 25 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,755 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_mongodb_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_mongodb_resources_operations.RestorableMongodbResourcesOperations
|
class RestorableMongodbResourcesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_mongodb_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableMongodbResourcesGetResult"]:
"""Return a list of database and collection combo that exist on the account at the given timestamp
and location. This helps in scenarios to validate what resources exist at given timestamp and
location. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableMongodbResourcesGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableMongodbResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableMongodbResourcesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restore_location=restore_location,
restore_timestamp_in_utc=restore_timestamp_in_utc,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableMongodbResourcesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableMongodbResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_mongodb_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableMongodbResourcesGetResult"]:
'''Return a list of database and collection combo that exist on the account at the given timestamp
and location. This helps in scenarios to validate what resources exist at given timestamp and
location. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableMongodbResourcesGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableMongodbResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 31 | 3 | 23 | 5 | 2 | 0.42 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 119 | 16 | 74 | 34 | 60 | 31 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,756 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_sql_containers_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_sql_containers_operations.RestorableSqlContainersOperations
|
class RestorableSqlContainersOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_sql_containers` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restorable_sql_database_rid: Optional[str] = None,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableSqlContainerGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a
specific database. This helps in scenario where container was accidentally deleted. This API
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restorable_sql_database_rid: The resource ID of the SQL database. Default value is None.
:type restorable_sql_database_rid: str
:param start_time: Restorable Sql containers event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable Sql containers event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableSqlContainerGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableSqlContainerGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableSqlContainersListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restorable_sql_database_rid=restorable_sql_database_rid,
start_time=start_time,
end_time=end_time,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableSqlContainersListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableSqlContainersOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_sql_containers` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restorable_sql_database_rid: Optional[str] = None,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableSqlContainerGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a
specific database. This helps in scenario where container was accidentally deleted. This API
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restorable_sql_database_rid: The resource ID of the SQL database. Default value is None.
:type restorable_sql_database_rid: str
:param start_time: Restorable Sql containers event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable Sql containers event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableSqlContainerGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableSqlContainerGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 32 | 3 | 24 | 5 | 2 | 0.39 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 120 | 16 | 76 | 35 | 61 | 30 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,757 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_sql_databases_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_sql_databases_operations.RestorableSqlDatabasesOperations
|
class RestorableSqlDatabasesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_sql_databases` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self, location: str, instance_id: str, **kwargs: Any
) -> Iterable["_models.RestorableSqlDatabaseGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the
restorable account. This helps in scenario where database was accidentally deleted to get the
deletion time. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: An iterator like instance of either RestorableSqlDatabaseGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableSqlDatabaseGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableSqlDatabasesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableSqlDatabasesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableSqlDatabasesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_sql_databases` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self, location: str, instance_id: str, **kwargs: Any
) -> Iterable["_models.RestorableSqlDatabaseGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the
restorable account. This helps in scenario where database was accidentally deleted to get the
deletion time. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: An iterator like instance of either RestorableSqlDatabaseGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableSqlDatabaseGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 28 | 3 | 21 | 4 | 2 | 0.37 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 106 | 16 | 67 | 29 | 58 | 25 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,758 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_sql_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_sql_resources_operations.RestorableSqlResourcesOperations
|
class RestorableSqlResourcesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_sql_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableSqlResourcesGetResult"]:
"""Return a list of database and container combo that exist on the account at the given timestamp
and location. This helps in scenarios to validate what resources exist at given timestamp and
location. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableSqlResourcesGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableSqlResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableSqlResourcesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restore_location=restore_location,
restore_timestamp_in_utc=restore_timestamp_in_utc,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableSqlResourcesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableSqlResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_sql_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableSqlResourcesGetResult"]:
'''Return a list of database and container combo that exist on the account at the given timestamp
and location. This helps in scenarios to validate what resources exist at given timestamp and
location. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableSqlResourcesGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableSqlResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 31 | 3 | 23 | 5 | 2 | 0.42 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 119 | 16 | 74 | 34 | 60 | 31 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,759 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_table_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_table_resources_operations.RestorableTableResourcesOperations
|
class RestorableTableResourcesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_table_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableTableResourcesGetResult"]:
"""Return a list of tables that exist on the account at the given timestamp and location. This
helps in scenarios to validate what resources exist at given timestamp and location. This API
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableTableResourcesGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableTableResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableTableResourcesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restore_location=restore_location,
restore_timestamp_in_utc=restore_timestamp_in_utc,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableTableResourcesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableTableResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_table_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableTableResourcesGetResult"]:
'''Return a list of tables that exist on the account at the given timestamp and location. This
helps in scenarios to validate what resources exist at given timestamp and location. This API
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableTableResourcesGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableTableResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 31 | 3 | 23 | 5 | 2 | 0.41 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 118 | 16 | 74 | 34 | 60 | 30 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,760 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_tables_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_tables_operations.RestorableTablesOperations
|
class RestorableTablesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_tables` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableTableGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB Tables. This helps in
scenario where table was accidentally deleted. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param start_time: Restorable Tables event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable Tables event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableTableGetResult or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableTableGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableTablesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
start_time=start_time,
end_time=end_time,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableTablesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableTablesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_tables` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableTableGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB Tables. This helps in
scenario where table was accidentally deleted. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param start_time: Restorable Tables event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable Tables event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableTableGetResult or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableTableGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 30 | 3 | 23 | 5 | 2 | 0.36 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 115 | 16 | 74 | 34 | 60 | 27 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,761 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_service_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._service_operations.ServiceOperations
|
class ServiceOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`service` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(self, resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable["_models.ServiceResource"]:
"""Gets the status of service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either ServiceResource or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ServiceResourceListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("ServiceResourceListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
def _create_initial(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: Union[_models.ServiceResourceCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_parameters, (IOBase, bytes)):
_content = create_update_parameters
else:
_json = self._serialize.body(create_update_parameters, "ServiceResourceCreateUpdateParameters")
_request = build_create_request(
resource_group_name=resource_group_name,
account_name=account_name,
service_name=service_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: _models.ServiceResourceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ServiceResource]:
"""Creates a service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:param create_update_parameters: The Service resource parameters. Required.
:type create_update_parameters:
~azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ServiceResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ServiceResource]:
"""Creates a service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:param create_update_parameters: The Service resource parameters. Required.
:type create_update_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ServiceResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: Union[_models.ServiceResourceCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.ServiceResource]:
"""Creates a service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:param create_update_parameters: The Service resource parameters. Is either a
ServiceResourceCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_parameters:
~azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ServiceResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ServiceResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_initial(
resource_group_name=resource_group_name,
account_name=account_name,
service_name=service_name,
create_update_parameters=create_update_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ServiceResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ServiceResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ServiceResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@distributed_trace
def get(
self, resource_group_name: str, account_name: str, service_name: str, **kwargs: Any
) -> _models.ServiceResource:
"""Gets the status of service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:return: ServiceResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ServiceResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ServiceResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
account_name=account_name,
service_name=service_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ServiceResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _delete_initial(
self, resource_group_name: str, account_name: str, service_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
account_name=account_name,
service_name=service_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete(
self, resource_group_name: str, account_name: str, service_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes service with the given serviceName.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial(
resource_group_name=resource_group_name,
account_name=account_name,
service_name=service_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class ServiceOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`service` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(self, resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable["_models.ServiceResource"]:
'''Gets the status of service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either ServiceResource or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
def _create_initial(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: Union[_models.ServiceResourceCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: _models.ServiceResourceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ServiceResource]:
'''Creates a service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:param create_update_parameters: The Service resource parameters. Required.
:type create_update_parameters:
~azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ServiceResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: _models.ServiceResourceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ServiceResource]:
'''Creates a service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:param create_update_parameters: The Service resource parameters. Required.
:type create_update_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ServiceResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create(
self,
resource_group_name: str,
account_name: str,
service_name: str,
create_update_parameters: _models.ServiceResourceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ServiceResource]:
'''Creates a service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:param create_update_parameters: The Service resource parameters. Is either a
ServiceResourceCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_parameters:
~azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ServiceResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ServiceResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def get_next(next_link=None):
'''Gets the status of service.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:return: ServiceResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ServiceResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _delete_initial(
self, resource_group_name: str, account_name: str, service_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete(
self, resource_group_name: str, account_name: str, service_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes service with the given serviceName.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param service_name: Cosmos DB service name. Required.
:type service_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 21 | 7 | 37 | 4 | 26 | 8 | 3 | 0.36 | 0 | 8 | 0 | 0 | 9 | 4 | 9 | 9 | 481 | 63 | 322 | 135 | 263 | 116 | 169 | 91 | 154 | 5 | 0 | 2 | 41 |
10,762 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_sql_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._sql_resources_operations.SqlResourcesOperations
|
class SqlResourcesOperations: # pylint: disable=too-many-public-methods
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`sql_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_sql_databases(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.SqlDatabaseGetResults"]:
"""Lists the SQL databases under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlDatabaseListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_databases_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlDatabaseListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_sql_database(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> _models.SqlDatabaseGetResults:
"""Gets the SQL database under an existing Azure Cosmos DB database account with the provided
name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: SqlDatabaseGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlDatabaseGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_database_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlDatabaseGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_database_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: Union[_models.SqlDatabaseCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_database_parameters, (IOBase, bytes)):
_content = create_update_sql_database_parameters
else:
_json = self._serialize.body(create_update_sql_database_parameters, "SqlDatabaseCreateUpdateParameters")
_request = build_create_update_sql_database_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_database(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: _models.SqlDatabaseCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlDatabaseGetResults]:
"""Create or update an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param create_update_sql_database_parameters: The parameters to provide for the current SQL
database. Required.
:type create_update_sql_database_parameters:
~azure.mgmt.cosmosdb.models.SqlDatabaseCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_database(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlDatabaseGetResults]:
"""Create or update an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param create_update_sql_database_parameters: The parameters to provide for the current SQL
database. Required.
:type create_update_sql_database_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_database(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: Union[_models.SqlDatabaseCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.SqlDatabaseGetResults]:
"""Create or update an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param create_update_sql_database_parameters: The parameters to provide for the current SQL
database. Is either a SqlDatabaseCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_sql_database_parameters:
~azure.mgmt.cosmosdb.models.SqlDatabaseCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlDatabaseGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_database_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
create_update_sql_database_parameters=create_update_sql_database_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlDatabaseGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlDatabaseGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlDatabaseGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_database_initial(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_database_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_database(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_database_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def get_sql_database_throughput(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> _models.ThroughputSettingsGetResults:
"""Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account
with the provided name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: ThroughputSettingsGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_database_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _update_sql_database_throughput_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(update_throughput_parameters, (IOBase, bytes)):
_content = update_throughput_parameters
else:
_json = self._serialize.body(update_throughput_parameters, "ThroughputSettingsUpdateParameters")
_request = build_update_sql_database_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_update_sql_database_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL database. Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_update_sql_database_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL database. Required.
:type update_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_update_sql_database_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL database. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type.
Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._update_sql_database_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
update_throughput_parameters=update_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _migrate_sql_database_to_autoscale_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_migrate_sql_database_to_autoscale_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_migrate_sql_database_to_autoscale(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._migrate_sql_database_to_autoscale_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _migrate_sql_database_to_manual_throughput_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_migrate_sql_database_to_manual_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_migrate_sql_database_to_manual_throughput( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._migrate_sql_database_to_manual_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@distributed_trace
def list_client_encryption_keys(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterable["_models.ClientEncryptionKeyGetResults"]:
"""Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An iterator like instance of either ClientEncryptionKeyGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ClientEncryptionKeysListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_client_encryption_keys_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("ClientEncryptionKeysListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_client_encryption_key(
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
**kwargs: Any
) -> _models.ClientEncryptionKeyGetResults:
"""Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:return: ClientEncryptionKeyGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ClientEncryptionKeyGetResults] = kwargs.pop("cls", None)
_request = build_get_client_encryption_key_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
client_encryption_key_name=client_encryption_key_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ClientEncryptionKeyGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_client_encryption_key_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: Union[
_models.ClientEncryptionKeyCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_client_encryption_key_parameters, (IOBase, bytes)):
_content = create_update_client_encryption_key_parameters
else:
_json = self._serialize.body(
create_update_client_encryption_key_parameters, "ClientEncryptionKeyCreateUpdateParameters"
)
_request = build_create_update_client_encryption_key_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
client_encryption_key_name=client_encryption_key_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_client_encryption_key( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: _models.ClientEncryptionKeyCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ClientEncryptionKeyGetResults]:
"""Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the
Azure Powershell (instead of directly).
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:param create_update_client_encryption_key_parameters: The parameters to provide for the client
encryption key. Required.
:type create_update_client_encryption_key_parameters:
~azure.mgmt.cosmosdb.models.ClientEncryptionKeyCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_client_encryption_key( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ClientEncryptionKeyGetResults]:
"""Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the
Azure Powershell (instead of directly).
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:param create_update_client_encryption_key_parameters: The parameters to provide for the client
encryption key. Required.
:type create_update_client_encryption_key_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_client_encryption_key( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: Union[
_models.ClientEncryptionKeyCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> LROPoller[_models.ClientEncryptionKeyGetResults]:
"""Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the
Azure Powershell (instead of directly).
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:param create_update_client_encryption_key_parameters: The parameters to provide for the client
encryption key. Is either a ClientEncryptionKeyCreateUpdateParameters type or a IO[bytes] type.
Required.
:type create_update_client_encryption_key_parameters:
~azure.mgmt.cosmosdb.models.ClientEncryptionKeyCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ClientEncryptionKeyGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_client_encryption_key_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
client_encryption_key_name=client_encryption_key_name,
create_update_client_encryption_key_parameters=create_update_client_encryption_key_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ClientEncryptionKeyGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ClientEncryptionKeyGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ClientEncryptionKeyGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@distributed_trace
def list_sql_containers(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterable["_models.SqlContainerGetResults"]:
"""Lists the SQL container under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An iterator like instance of either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlContainerListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_containers_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlContainerListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_sql_container(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> _models.SqlContainerGetResults:
"""Gets the SQL container under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: SqlContainerGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlContainerGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlContainerGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_container_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlContainerGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_container_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: Union[_models.SqlContainerCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_container_parameters, (IOBase, bytes)):
_content = create_update_sql_container_parameters
else:
_json = self._serialize.body(create_update_sql_container_parameters, "SqlContainerCreateUpdateParameters")
_request = build_create_update_sql_container_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_container(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: _models.SqlContainerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlContainerGetResults]:
"""Create or update an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param create_update_sql_container_parameters: The parameters to provide for the current SQL
container. Required.
:type create_update_sql_container_parameters:
~azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_container(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlContainerGetResults]:
"""Create or update an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param create_update_sql_container_parameters: The parameters to provide for the current SQL
container. Required.
:type create_update_sql_container_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_container(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: Union[_models.SqlContainerCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.SqlContainerGetResults]:
"""Create or update an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param create_update_sql_container_parameters: The parameters to provide for the current SQL
container. Is either a SqlContainerCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_sql_container_parameters:
~azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlContainerGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_container_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
create_update_sql_container_parameters=create_update_sql_container_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlContainerGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlContainerGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlContainerGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_container_initial(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_container_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_container(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_container_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
def _sql_database_partition_merge_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: Union[_models.MergeParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(merge_parameters, (IOBase, bytes)):
_content = merge_parameters
else:
_json = self._serialize.body(merge_parameters, "MergeParameters")
_request = build_sql_database_partition_merge_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_sql_database_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
"""Merges the partitions of a SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_sql_database_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
"""Merges the partitions of a SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_sql_database_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: Union[_models.MergeParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
"""Merges the partitions of a SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param merge_parameters: The parameters for the merge operation. Is either a MergeParameters
type or a IO[bytes] type. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PhysicalPartitionStorageInfoCollection] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._sql_database_partition_merge_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
merge_parameters=merge_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PhysicalPartitionStorageInfoCollection", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PhysicalPartitionStorageInfoCollection].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PhysicalPartitionStorageInfoCollection](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _list_sql_container_partition_merge_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: Union[_models.MergeParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(merge_parameters, (IOBase, bytes)):
_content = merge_parameters
else:
_json = self._serialize.body(merge_parameters, "MergeParameters")
_request = build_list_sql_container_partition_merge_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_list_sql_container_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
"""Merges the partitions of a SQL Container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_list_sql_container_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
"""Merges the partitions of a SQL Container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_list_sql_container_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: Union[_models.MergeParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
"""Merges the partitions of a SQL Container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param merge_parameters: The parameters for the merge operation. Is either a MergeParameters
type or a IO[bytes] type. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PhysicalPartitionStorageInfoCollection] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._list_sql_container_partition_merge_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
merge_parameters=merge_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PhysicalPartitionStorageInfoCollection", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PhysicalPartitionStorageInfoCollection].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PhysicalPartitionStorageInfoCollection](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@distributed_trace
def get_sql_container_throughput(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> _models.ThroughputSettingsGetResults:
"""Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database
account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: ThroughputSettingsGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_container_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _update_sql_container_throughput_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(update_throughput_parameters, (IOBase, bytes)):
_content = update_throughput_parameters
else:
_json = self._serialize.body(update_throughput_parameters, "ThroughputSettingsUpdateParameters")
_request = build_update_sql_container_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_update_sql_container_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL container. Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_update_sql_container_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL container. Required.
:type update_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_update_sql_container_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL container. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type.
Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._update_sql_container_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
update_throughput_parameters=update_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _migrate_sql_container_to_autoscale_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_migrate_sql_container_to_autoscale_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_migrate_sql_container_to_autoscale(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._migrate_sql_container_to_autoscale_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _migrate_sql_container_to_manual_throughput_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_migrate_sql_container_to_manual_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_migrate_sql_container_to_manual_throughput( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._migrate_sql_container_to_manual_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _sql_database_retrieve_throughput_distribution_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: Union[_models.RetrieveThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(retrieve_throughput_parameters, (IOBase, bytes)):
_content = retrieve_throughput_parameters
else:
_json = self._serialize.body(retrieve_throughput_parameters, "RetrieveThroughputParameters")
_request = build_sql_database_retrieve_throughput_distribution_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_sql_database_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Retrieve throughput distribution for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL database. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_sql_database_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Retrieve throughput distribution for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL database. Required.
:type retrieve_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_sql_database_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: Union[_models.RetrieveThroughputParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Retrieve throughput distribution for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL database. Is either a RetrieveThroughputParameters type or a
IO[bytes] type. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PhysicalPartitionThroughputInfoResult] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._sql_database_retrieve_throughput_distribution_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
retrieve_throughput_parameters=retrieve_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PhysicalPartitionThroughputInfoResult", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PhysicalPartitionThroughputInfoResult].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PhysicalPartitionThroughputInfoResult](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _sql_database_redistribute_throughput_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: Union[_models.RedistributeThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(redistribute_throughput_parameters, (IOBase, bytes)):
_content = redistribute_throughput_parameters
else:
_json = self._serialize.body(redistribute_throughput_parameters, "RedistributeThroughputParameters")
_request = build_sql_database_redistribute_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_sql_database_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Redistribute throughput for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL database. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_sql_database_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Redistribute throughput for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL database. Required.
:type redistribute_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_sql_database_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: Union[_models.RedistributeThroughputParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Redistribute throughput for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL database. Is either a RedistributeThroughputParameters type or a
IO[bytes] type. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PhysicalPartitionThroughputInfoResult] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._sql_database_redistribute_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
redistribute_throughput_parameters=redistribute_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PhysicalPartitionThroughputInfoResult", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PhysicalPartitionThroughputInfoResult].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PhysicalPartitionThroughputInfoResult](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _sql_container_retrieve_throughput_distribution_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: Union[_models.RetrieveThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(retrieve_throughput_parameters, (IOBase, bytes)):
_content = retrieve_throughput_parameters
else:
_json = self._serialize.body(retrieve_throughput_parameters, "RetrieveThroughputParameters")
_request = build_sql_container_retrieve_throughput_distribution_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_sql_container_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Retrieve throughput distribution for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL container. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_sql_container_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Retrieve throughput distribution for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL container. Required.
:type retrieve_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_sql_container_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: Union[_models.RetrieveThroughputParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Retrieve throughput distribution for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL container. Is either a RetrieveThroughputParameters type or a
IO[bytes] type. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PhysicalPartitionThroughputInfoResult] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._sql_container_retrieve_throughput_distribution_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
retrieve_throughput_parameters=retrieve_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PhysicalPartitionThroughputInfoResult", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PhysicalPartitionThroughputInfoResult].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PhysicalPartitionThroughputInfoResult](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _sql_container_redistribute_throughput_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: Union[_models.RedistributeThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(redistribute_throughput_parameters, (IOBase, bytes)):
_content = redistribute_throughput_parameters
else:
_json = self._serialize.body(redistribute_throughput_parameters, "RedistributeThroughputParameters")
_request = build_sql_container_redistribute_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_sql_container_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Redistribute throughput for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL container. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_sql_container_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Redistribute throughput for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL container. Required.
:type redistribute_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_sql_container_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: Union[_models.RedistributeThroughputParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
"""Redistribute throughput for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL container. Is either a RedistributeThroughputParameters type or
a IO[bytes] type. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PhysicalPartitionThroughputInfoResult] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._sql_container_redistribute_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
redistribute_throughput_parameters=redistribute_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PhysicalPartitionThroughputInfoResult", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PhysicalPartitionThroughputInfoResult].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PhysicalPartitionThroughputInfoResult](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@distributed_trace
def list_sql_stored_procedures(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterable["_models.SqlStoredProcedureGetResults"]:
"""Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An iterator like instance of either SqlStoredProcedureGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlStoredProcedureListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_stored_procedures_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlStoredProcedureListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
**kwargs: Any
) -> _models.SqlStoredProcedureGetResults:
"""Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:return: SqlStoredProcedureGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlStoredProcedureGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_stored_procedure_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
stored_procedure_name=stored_procedure_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlStoredProcedureGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_stored_procedure_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: Union[
_models.SqlStoredProcedureCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_stored_procedure_parameters, (IOBase, bytes)):
_content = create_update_sql_stored_procedure_parameters
else:
_json = self._serialize.body(
create_update_sql_stored_procedure_parameters, "SqlStoredProcedureCreateUpdateParameters"
)
_request = build_create_update_sql_stored_procedure_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
stored_procedure_name=stored_procedure_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: _models.SqlStoredProcedureCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlStoredProcedureGetResults]:
"""Create or update an Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:param create_update_sql_stored_procedure_parameters: The parameters to provide for the current
SQL storedProcedure. Required.
:type create_update_sql_stored_procedure_parameters:
~azure.mgmt.cosmosdb.models.SqlStoredProcedureCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlStoredProcedureGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlStoredProcedureGetResults]:
"""Create or update an Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:param create_update_sql_stored_procedure_parameters: The parameters to provide for the current
SQL storedProcedure. Required.
:type create_update_sql_stored_procedure_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlStoredProcedureGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: Union[
_models.SqlStoredProcedureCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> LROPoller[_models.SqlStoredProcedureGetResults]:
"""Create or update an Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:param create_update_sql_stored_procedure_parameters: The parameters to provide for the current
SQL storedProcedure. Is either a SqlStoredProcedureCreateUpdateParameters type or a IO[bytes]
type. Required.
:type create_update_sql_stored_procedure_parameters:
~azure.mgmt.cosmosdb.models.SqlStoredProcedureCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlStoredProcedureGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlStoredProcedureGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_stored_procedure_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
stored_procedure_name=stored_procedure_name,
create_update_sql_stored_procedure_parameters=create_update_sql_stored_procedure_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlStoredProcedureGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlStoredProcedureGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlStoredProcedureGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_stored_procedure_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_stored_procedure_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
stored_procedure_name=stored_procedure_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
**kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_stored_procedure_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
stored_procedure_name=stored_procedure_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_sql_user_defined_functions(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterable["_models.SqlUserDefinedFunctionGetResults"]:
"""Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An iterator like instance of either SqlUserDefinedFunctionGetResults or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlUserDefinedFunctionListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_user_defined_functions_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlUserDefinedFunctionListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_sql_user_defined_function(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
**kwargs: Any
) -> _models.SqlUserDefinedFunctionGetResults:
"""Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:return: SqlUserDefinedFunctionGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlUserDefinedFunctionGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_user_defined_function_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
user_defined_function_name=user_defined_function_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlUserDefinedFunctionGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_user_defined_function_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: Union[
_models.SqlUserDefinedFunctionCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_user_defined_function_parameters, (IOBase, bytes)):
_content = create_update_sql_user_defined_function_parameters
else:
_json = self._serialize.body(
create_update_sql_user_defined_function_parameters, "SqlUserDefinedFunctionCreateUpdateParameters"
)
_request = build_create_update_sql_user_defined_function_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
user_defined_function_name=user_defined_function_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_user_defined_function( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: _models.SqlUserDefinedFunctionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlUserDefinedFunctionGetResults]:
"""Create or update an Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:param create_update_sql_user_defined_function_parameters: The parameters to provide for the
current SQL userDefinedFunction. Required.
:type create_update_sql_user_defined_function_parameters:
~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_user_defined_function( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlUserDefinedFunctionGetResults]:
"""Create or update an Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:param create_update_sql_user_defined_function_parameters: The parameters to provide for the
current SQL userDefinedFunction. Required.
:type create_update_sql_user_defined_function_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_user_defined_function( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: Union[
_models.SqlUserDefinedFunctionCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> LROPoller[_models.SqlUserDefinedFunctionGetResults]:
"""Create or update an Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:param create_update_sql_user_defined_function_parameters: The parameters to provide for the
current SQL userDefinedFunction. Is either a SqlUserDefinedFunctionCreateUpdateParameters type
or a IO[bytes] type. Required.
:type create_update_sql_user_defined_function_parameters:
~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlUserDefinedFunctionGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_user_defined_function_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
user_defined_function_name=user_defined_function_name,
create_update_sql_user_defined_function_parameters=create_update_sql_user_defined_function_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlUserDefinedFunctionGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlUserDefinedFunctionGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlUserDefinedFunctionGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_user_defined_function_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_user_defined_function_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
user_defined_function_name=user_defined_function_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_user_defined_function(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
**kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_user_defined_function_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
user_defined_function_name=user_defined_function_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_sql_triggers(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterable["_models.SqlTriggerGetResults"]:
"""Lists the SQL trigger under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An iterator like instance of either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlTriggerListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_triggers_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlTriggerListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
**kwargs: Any
) -> _models.SqlTriggerGetResults:
"""Gets the SQL trigger under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:return: SqlTriggerGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlTriggerGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlTriggerGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_trigger_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
trigger_name=trigger_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlTriggerGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_trigger_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: Union[_models.SqlTriggerCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_trigger_parameters, (IOBase, bytes)):
_content = create_update_sql_trigger_parameters
else:
_json = self._serialize.body(create_update_sql_trigger_parameters, "SqlTriggerCreateUpdateParameters")
_request = build_create_update_sql_trigger_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
trigger_name=trigger_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: _models.SqlTriggerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlTriggerGetResults]:
"""Create or update an Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:param create_update_sql_trigger_parameters: The parameters to provide for the current SQL
trigger. Required.
:type create_update_sql_trigger_parameters:
~azure.mgmt.cosmosdb.models.SqlTriggerCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlTriggerGetResults]:
"""Create or update an Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:param create_update_sql_trigger_parameters: The parameters to provide for the current SQL
trigger. Required.
:type create_update_sql_trigger_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: Union[_models.SqlTriggerCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.SqlTriggerGetResults]:
"""Create or update an Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:param create_update_sql_trigger_parameters: The parameters to provide for the current SQL
trigger. Is either a SqlTriggerCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_sql_trigger_parameters:
~azure.mgmt.cosmosdb.models.SqlTriggerCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlTriggerGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_trigger_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
trigger_name=trigger_name,
create_update_sql_trigger_parameters=create_update_sql_trigger_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlTriggerGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlTriggerGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlTriggerGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_trigger_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_trigger_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
trigger_name=trigger_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
**kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_trigger_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
trigger_name=trigger_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def get_sql_role_definition(
self, role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> _models.SqlRoleDefinitionGetResults:
"""Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: SqlRoleDefinitionGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlRoleDefinitionGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_role_definition_request(
role_definition_id=role_definition_id,
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlRoleDefinitionGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_role_definition_initial( # pylint: disable=name-too-long
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: Union[_models.SqlRoleDefinitionCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_role_definition_parameters, (IOBase, bytes)):
_content = create_update_sql_role_definition_parameters
else:
_json = self._serialize.body(
create_update_sql_role_definition_parameters, "SqlRoleDefinitionCreateUpdateParameters"
)
_request = build_create_update_sql_role_definition_request(
role_definition_id=role_definition_id,
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_role_definition(
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: _models.SqlRoleDefinitionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleDefinitionGetResults]:
"""Creates or updates an Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_sql_role_definition_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleDefinitionCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_role_definition(
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleDefinitionGetResults]:
"""Creates or updates an Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_sql_role_definition_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_role_definition(
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: Union[_models.SqlRoleDefinitionCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.SqlRoleDefinitionGetResults]:
"""Creates or updates an Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_definition_parameters: The properties required to create or
update a Role Definition. Is either a SqlRoleDefinitionCreateUpdateParameters type or a
IO[bytes] type. Required.
:type create_update_sql_role_definition_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleDefinitionCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlRoleDefinitionGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_role_definition_initial(
role_definition_id=role_definition_id,
resource_group_name=resource_group_name,
account_name=account_name,
create_update_sql_role_definition_parameters=create_update_sql_role_definition_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlRoleDefinitionGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlRoleDefinitionGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlRoleDefinitionGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_role_definition_initial(
self, role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_role_definition_request(
role_definition_id=role_definition_id,
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_role_definition(
self, role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_role_definition_initial(
role_definition_id=role_definition_id,
resource_group_name=resource_group_name,
account_name=account_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_sql_role_definitions(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.SqlRoleDefinitionGetResults"]:
"""Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either SqlRoleDefinitionGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlRoleDefinitionListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_role_definitions_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlRoleDefinitionListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_sql_role_assignment(
self, role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> _models.SqlRoleAssignmentGetResults:
"""Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: SqlRoleAssignmentGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlRoleAssignmentGetResults] = kwargs.pop("cls", None)
_request = build_get_sql_role_assignment_request(
role_assignment_id=role_assignment_id,
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SqlRoleAssignmentGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_sql_role_assignment_initial( # pylint: disable=name-too-long
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: Union[_models.SqlRoleAssignmentCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_sql_role_assignment_parameters, (IOBase, bytes)):
_content = create_update_sql_role_assignment_parameters
else:
_json = self._serialize.body(
create_update_sql_role_assignment_parameters, "SqlRoleAssignmentCreateUpdateParameters"
)
_request = build_create_update_sql_role_assignment_request(
role_assignment_id=role_assignment_id,
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_sql_role_assignment(
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: _models.SqlRoleAssignmentCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleAssignmentGetResults]:
"""Creates or updates an Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_sql_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleAssignmentCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_sql_role_assignment(
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleAssignmentGetResults]:
"""Creates or updates an Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_sql_role_assignment_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_sql_role_assignment(
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: Union[_models.SqlRoleAssignmentCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.SqlRoleAssignmentGetResults]:
"""Creates or updates an Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_assignment_parameters: The properties required to create or
update a Role Assignment. Is either a SqlRoleAssignmentCreateUpdateParameters type or a
IO[bytes] type. Required.
:type create_update_sql_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleAssignmentCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SqlRoleAssignmentGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_sql_role_assignment_initial(
role_assignment_id=role_assignment_id,
resource_group_name=resource_group_name,
account_name=account_name,
create_update_sql_role_assignment_parameters=create_update_sql_role_assignment_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SqlRoleAssignmentGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SqlRoleAssignmentGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SqlRoleAssignmentGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_sql_role_assignment_initial(
self, role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_sql_role_assignment_request(
role_assignment_id=role_assignment_id,
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_sql_role_assignment(
self, role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_sql_role_assignment_initial(
role_assignment_id=role_assignment_id,
resource_group_name=resource_group_name,
account_name=account_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_sql_role_assignments(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.SqlRoleAssignmentGetResults"]:
"""Retrieves the list of all Azure Cosmos DB SQL Role Assignments.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either SqlRoleAssignmentGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SqlRoleAssignmentListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_sql_role_assignments_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SqlRoleAssignmentListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
def _retrieve_continuous_backup_information_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: Union[_models.ContinuousBackupRestoreLocation, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(location, (IOBase, bytes)):
_content = location
else:
_json = self._serialize.body(location, "ContinuousBackupRestoreLocation")
_request = build_retrieve_continuous_backup_information_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
"""Retrieves continuous backup information for a container resource.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
"""Retrieves continuous backup information for a container resource.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: Union[_models.ContinuousBackupRestoreLocation, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
"""Retrieves continuous backup information for a container resource.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param location: The name of the continuous backup restore location. Is either a
ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation or IO[bytes]
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.BackupInformation] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._retrieve_continuous_backup_information_initial(
resource_group_name=resource_group_name,
account_name=account_name,
database_name=database_name,
container_name=container_name,
location=location,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("BackupInformation", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.BackupInformation].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.BackupInformation](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
|
class SqlResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`sql_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_sql_databases(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.SqlDatabaseGetResults"]:
'''Lists the SQL databases under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_sql_database(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> _models.SqlDatabaseGetResults:
'''Gets the SQL database under an existing Azure Cosmos DB database account with the provided
name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: SqlDatabaseGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_database_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: Union[_models.SqlDatabaseCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_database(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: _models.SqlDatabaseCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlDatabaseGetResults]:
'''Create or update an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param create_update_sql_database_parameters: The parameters to provide for the current SQL
database. Required.
:type create_update_sql_database_parameters:
~azure.mgmt.cosmosdb.models.SqlDatabaseCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_database(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: _models.SqlDatabaseCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlDatabaseGetResults]:
'''Create or update an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param create_update_sql_database_parameters: The parameters to provide for the current SQL
database. Required.
:type create_update_sql_database_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_database(
self,
resource_group_name: str,
account_name: str,
database_name: str,
create_update_sql_database_parameters: _models.SqlDatabaseCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlDatabaseGetResults]:
'''Create or update an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param create_update_sql_database_parameters: The parameters to provide for the current SQL
database. Is either a SqlDatabaseCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_sql_database_parameters:
~azure.mgmt.cosmosdb.models.SqlDatabaseCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlDatabaseGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlDatabaseGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_database_initial(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_database(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def get_sql_database_throughput(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> _models.ThroughputSettingsGetResults:
'''Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account
with the provided name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: ThroughputSettingsGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _update_sql_database_throughput_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_update_sql_database_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL database. Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_update_sql_database_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL database. Required.
:type update_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_update_sql_database_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL database. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type.
Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _migrate_sql_database_to_autoscale_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_migrate_sql_database_to_autoscale(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _migrate_sql_database_to_manual_throughput_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_migrate_sql_database_to_manual_throughput( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_client_encryption_keys(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterable["_models.ClientEncryptionKeyGetResults"]:
'''Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An iterator like instance of either ClientEncryptionKeyGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_client_encryption_key(
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
**kwargs: Any
) -> _models.ClientEncryptionKeyGetResults:
'''Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:return: ClientEncryptionKeyGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_client_encryption_key_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: Union[
_models.ClientEncryptionKeyCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_client_encryption_key( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: _models.ClientEncryptionKeyCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ClientEncryptionKeyGetResults]:
'''Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the
Azure Powershell (instead of directly).
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:param create_update_client_encryption_key_parameters: The parameters to provide for the client
encryption key. Required.
:type create_update_client_encryption_key_parameters:
~azure.mgmt.cosmosdb.models.ClientEncryptionKeyCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_client_encryption_key( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: _models.ClientEncryptionKeyCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ClientEncryptionKeyGetResults]:
'''Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the
Azure Powershell (instead of directly).
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:param create_update_client_encryption_key_parameters: The parameters to provide for the client
encryption key. Required.
:type create_update_client_encryption_key_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_client_encryption_key( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
client_encryption_key_name: str,
create_update_client_encryption_key_parameters: _models.ClientEncryptionKeyCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ClientEncryptionKeyGetResults]:
'''Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the
Azure Powershell (instead of directly).
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param client_encryption_key_name: Cosmos DB ClientEncryptionKey name. Required.
:type client_encryption_key_name: str
:param create_update_client_encryption_key_parameters: The parameters to provide for the client
encryption key. Is either a ClientEncryptionKeyCreateUpdateParameters type or a IO[bytes] type.
Required.
:type create_update_client_encryption_key_parameters:
~azure.mgmt.cosmosdb.models.ClientEncryptionKeyCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ClientEncryptionKeyGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ClientEncryptionKeyGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_sql_containers(
self, resource_group_name: str, account_name: str, database_name: str, **kwargs: Any
) -> Iterable["_models.SqlContainerGetResults"]:
'''Lists the SQL container under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:return: An iterator like instance of either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_sql_container(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> _models.SqlContainerGetResults:
'''Gets the SQL container under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: SqlContainerGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlContainerGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_container_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: Union[_models.SqlContainerCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_container(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: _models.SqlContainerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlContainerGetResults]:
'''Create or update an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param create_update_sql_container_parameters: The parameters to provide for the current SQL
container. Required.
:type create_update_sql_container_parameters:
~azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_container(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: _models.SqlContainerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlContainerGetResults]:
'''Create or update an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param create_update_sql_container_parameters: The parameters to provide for the current SQL
container. Required.
:type create_update_sql_container_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_container(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
create_update_sql_container_parameters: _models.SqlContainerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlContainerGetResults]:
'''Create or update an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param create_update_sql_container_parameters: The parameters to provide for the current SQL
container. Is either a SqlContainerCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_sql_container_parameters:
~azure.mgmt.cosmosdb.models.SqlContainerCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlContainerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlContainerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_container_initial(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_container(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _sql_database_partition_merge_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: Union[_models.MergeParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_sql_database_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
'''Merges the partitions of a SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_sql_database_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
'''Merges the partitions of a SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_sql_database_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
'''Merges the partitions of a SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param merge_parameters: The parameters for the merge operation. Is either a MergeParameters
type or a IO[bytes] type. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _list_sql_container_partition_merge_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: Union[_models.MergeParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_list_sql_container_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
'''Merges the partitions of a SQL Container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_list_sql_container_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
'''Merges the partitions of a SQL Container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param merge_parameters: The parameters for the merge operation. Required.
:type merge_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_list_sql_container_partition_merge(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
merge_parameters: _models.MergeParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionStorageInfoCollection]:
'''Merges the partitions of a SQL Container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param merge_parameters: The parameters for the merge operation. Is either a MergeParameters
type or a IO[bytes] type. Required.
:type merge_parameters: ~azure.mgmt.cosmosdb.models.MergeParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionStorageInfoCollection or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionStorageInfoCollection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def get_sql_container_throughput(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> _models.ThroughputSettingsGetResults:
'''Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database
account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: ThroughputSettingsGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _update_sql_container_throughput_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_update_sql_container_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL container. Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_update_sql_container_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL container. Required.
:type update_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_update_sql_container_throughput(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current SQL container. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type.
Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _migrate_sql_container_to_autoscale_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_migrate_sql_container_to_autoscale(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _migrate_sql_container_to_manual_throughput_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_migrate_sql_container_to_manual_throughput( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _sql_database_retrieve_throughput_distribution_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: Union[_models.RetrieveThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_sql_database_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Retrieve throughput distribution for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL database. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_sql_database_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Retrieve throughput distribution for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL database. Required.
:type retrieve_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_sql_database_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Retrieve throughput distribution for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL database. Is either a RetrieveThroughputParameters type or a
IO[bytes] type. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _sql_database_redistribute_throughput_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: Union[_models.RedistributeThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_sql_database_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Redistribute throughput for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL database. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_sql_database_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Redistribute throughput for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL database. Required.
:type redistribute_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_sql_database_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Redistribute throughput for an Azure Cosmos DB SQL database.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL database. Is either a RedistributeThroughputParameters type or a
IO[bytes] type. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _sql_container_retrieve_throughput_distribution_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: Union[_models.RetrieveThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_sql_container_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Retrieve throughput distribution for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL container. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_sql_container_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Retrieve throughput distribution for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL container. Required.
:type retrieve_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_sql_container_retrieve_throughput_distribution( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
retrieve_throughput_parameters: _models.RetrieveThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Retrieve throughput distribution for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param retrieve_throughput_parameters: The parameters to provide for retrieving throughput
distribution for the current SQL container. Is either a RetrieveThroughputParameters type or a
IO[bytes] type. Required.
:type retrieve_throughput_parameters: ~azure.mgmt.cosmosdb.models.RetrieveThroughputParameters
or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _sql_container_redistribute_throughput_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: Union[_models.RedistributeThroughputParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_sql_container_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Redistribute throughput for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL container. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_sql_container_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Redistribute throughput for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL container. Required.
:type redistribute_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_sql_container_redistribute_throughput( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
redistribute_throughput_parameters: _models.RedistributeThroughputParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PhysicalPartitionThroughputInfoResult]:
'''Redistribute throughput for an Azure Cosmos DB SQL container.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param redistribute_throughput_parameters: The parameters to provide for redistributing
throughput for the current SQL container. Is either a RedistributeThroughputParameters type or
a IO[bytes] type. Required.
:type redistribute_throughput_parameters:
~azure.mgmt.cosmosdb.models.RedistributeThroughputParameters or IO[bytes]
:return: An instance of LROPoller that returns either PhysicalPartitionThroughputInfoResult or
the result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PhysicalPartitionThroughputInfoResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_sql_stored_procedures(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterable["_models.SqlStoredProcedureGetResults"]:
'''Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An iterator like instance of either SqlStoredProcedureGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
**kwargs: Any
) -> _models.SqlStoredProcedureGetResults:
'''Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:return: SqlStoredProcedureGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_stored_procedure_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: Union[
_models.SqlStoredProcedureCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: _models.SqlStoredProcedureCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlStoredProcedureGetResults]:
'''Create or update an Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:param create_update_sql_stored_procedure_parameters: The parameters to provide for the current
SQL storedProcedure. Required.
:type create_update_sql_stored_procedure_parameters:
~azure.mgmt.cosmosdb.models.SqlStoredProcedureCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlStoredProcedureGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: _models.SqlStoredProcedureCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlStoredProcedureGetResults]:
'''Create or update an Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:param create_update_sql_stored_procedure_parameters: The parameters to provide for the current
SQL storedProcedure. Required.
:type create_update_sql_stored_procedure_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlStoredProcedureGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
create_update_sql_stored_procedure_parameters: _models.SqlStoredProcedureCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlStoredProcedureGetResults]:
'''Create or update an Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:param create_update_sql_stored_procedure_parameters: The parameters to provide for the current
SQL storedProcedure. Is either a SqlStoredProcedureCreateUpdateParameters type or a IO[bytes]
type. Required.
:type create_update_sql_stored_procedure_parameters:
~azure.mgmt.cosmosdb.models.SqlStoredProcedureCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlStoredProcedureGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlStoredProcedureGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_stored_procedure_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
**kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_stored_procedure(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
stored_procedure_name: str,
**kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL storedProcedure.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param stored_procedure_name: Cosmos DB storedProcedure name. Required.
:type stored_procedure_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_sql_user_defined_functions(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterable["_models.SqlUserDefinedFunctionGetResults"]:
'''Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An iterator like instance of either SqlUserDefinedFunctionGetResults or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_sql_user_defined_function(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
**kwargs: Any
) -> _models.SqlUserDefinedFunctionGetResults:
'''Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:return: SqlUserDefinedFunctionGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_user_defined_function_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: Union[
_models.SqlUserDefinedFunctionCreateUpdateParameters, IO[bytes]
],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_user_defined_function( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: _models.SqlUserDefinedFunctionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlUserDefinedFunctionGetResults]:
'''Create or update an Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:param create_update_sql_user_defined_function_parameters: The parameters to provide for the
current SQL userDefinedFunction. Required.
:type create_update_sql_user_defined_function_parameters:
~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_user_defined_function( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: _models.SqlUserDefinedFunctionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlUserDefinedFunctionGetResults]:
'''Create or update an Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:param create_update_sql_user_defined_function_parameters: The parameters to provide for the
current SQL userDefinedFunction. Required.
:type create_update_sql_user_defined_function_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_user_defined_function( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
create_update_sql_user_defined_function_parameters: _models.SqlUserDefinedFunctionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlUserDefinedFunctionGetResults]:
'''Create or update an Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:param create_update_sql_user_defined_function_parameters: The parameters to provide for the
current SQL userDefinedFunction. Is either a SqlUserDefinedFunctionCreateUpdateParameters type
or a IO[bytes] type. Required.
:type create_update_sql_user_defined_function_parameters:
~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlUserDefinedFunctionGetResults or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlUserDefinedFunctionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_user_defined_function_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
**kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_user_defined_function(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
user_defined_function_name: str,
**kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL userDefinedFunction.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param user_defined_function_name: Cosmos DB userDefinedFunction name. Required.
:type user_defined_function_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_sql_triggers(
self, resource_group_name: str, account_name: str, database_name: str, container_name: str, **kwargs: Any
) -> Iterable["_models.SqlTriggerGetResults"]:
'''Lists the SQL trigger under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:return: An iterator like instance of either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
**kwargs: Any
) -> _models.SqlTriggerGetResults:
'''Gets the SQL trigger under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:return: SqlTriggerGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlTriggerGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_trigger_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: Union[_models.SqlTriggerCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: _models.SqlTriggerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlTriggerGetResults]:
'''Create or update an Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:param create_update_sql_trigger_parameters: The parameters to provide for the current SQL
trigger. Required.
:type create_update_sql_trigger_parameters:
~azure.mgmt.cosmosdb.models.SqlTriggerCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: _models.SqlTriggerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlTriggerGetResults]:
'''Create or update an Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:param create_update_sql_trigger_parameters: The parameters to provide for the current SQL
trigger. Required.
:type create_update_sql_trigger_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
create_update_sql_trigger_parameters: _models.SqlTriggerCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlTriggerGetResults]:
'''Create or update an Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:param create_update_sql_trigger_parameters: The parameters to provide for the current SQL
trigger. Is either a SqlTriggerCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_sql_trigger_parameters:
~azure.mgmt.cosmosdb.models.SqlTriggerCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlTriggerGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlTriggerGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_trigger_initial(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
**kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_trigger(
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
trigger_name: str,
**kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL trigger.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param trigger_name: Cosmos DB trigger name. Required.
:type trigger_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def get_sql_role_definition(
self, role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> _models.SqlRoleDefinitionGetResults:
'''Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: SqlRoleDefinitionGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_role_definition_initial( # pylint: disable=name-too-long
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: Union[_models.SqlRoleDefinitionCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_role_definition(
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: _models.SqlRoleDefinitionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleDefinitionGetResults]:
'''Creates or updates an Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_sql_role_definition_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleDefinitionCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_role_definition(
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: _models.SqlRoleDefinitionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleDefinitionGetResults]:
'''Creates or updates an Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_sql_role_definition_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_role_definition(
self,
role_definition_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_definition_parameters: _models.SqlRoleDefinitionCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleDefinitionGetResults]:
'''Creates or updates an Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_definition_parameters: The properties required to create or
update a Role Definition. Is either a SqlRoleDefinitionCreateUpdateParameters type or a
IO[bytes] type. Required.
:type create_update_sql_role_definition_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleDefinitionCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlRoleDefinitionGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_role_definition_initial(
self, role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_role_definition(
self, role_definition_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL Role Definition.
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_sql_role_definitions(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.SqlRoleDefinitionGetResults"]:
'''Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either SqlRoleDefinitionGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlRoleDefinitionGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_sql_role_assignment(
self, role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> _models.SqlRoleAssignmentGetResults:
'''Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: SqlRoleAssignmentGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_sql_role_assignment_initial( # pylint: disable=name-too-long
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: Union[_models.SqlRoleAssignmentCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_sql_role_assignment(
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: _models.SqlRoleAssignmentCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleAssignmentGetResults]:
'''Creates or updates an Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_sql_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleAssignmentCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_sql_role_assignment(
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: _models.SqlRoleAssignmentCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleAssignmentGetResults]:
'''Creates or updates an Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_sql_role_assignment_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_sql_role_assignment(
self,
role_assignment_id: str,
resource_group_name: str,
account_name: str,
create_update_sql_role_assignment_parameters: _models.SqlRoleAssignmentCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SqlRoleAssignmentGetResults]:
'''Creates or updates an Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param create_update_sql_role_assignment_parameters: The properties required to create or
update a Role Assignment. Is either a SqlRoleAssignmentCreateUpdateParameters type or a
IO[bytes] type. Required.
:type create_update_sql_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.SqlRoleAssignmentCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either SqlRoleAssignmentGetResults or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_sql_role_assignment_initial(
self, role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_sql_role_assignment(
self, role_assignment_id: str, resource_group_name: str, account_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB SQL Role Assignment.
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_sql_role_assignments(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.SqlRoleAssignmentGetResults"]:
'''Retrieves the list of all Azure Cosmos DB SQL Role Assignments.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either SqlRoleAssignmentGetResults or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.SqlRoleAssignmentGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
def _retrieve_continuous_backup_information_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: Union[_models.ContinuousBackupRestoreLocation, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
'''Retrieves continuous backup information for a container resource.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
'''Retrieves continuous backup information for a container resource.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
database_name: str,
container_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
'''Retrieves continuous backup information for a container resource.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_name: Cosmos DB database name. Required.
:type database_name: str
:param container_name: Cosmos DB container name. Required.
:type container_name: str
:param location: The name of the continuous backup restore location. Is either a
ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation or IO[bytes]
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 242 | 81 | 43 | 4 | 30 | 11 | 3 | 0.4 | 0 | 8 | 0 | 0 | 109 | 4 | 109 | 109 | 6,572 | 745 | 4,358 | 1,879 | 3,369 | 1,758 | 2,062 | 1,052 | 1,900 | 6 | 0 | 2 | 473 |
10,763 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_table_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._table_resources_operations.TableResourcesOperations
|
class TableResourcesOperations: # pylint: disable=too-many-public-methods
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`table_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_tables(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.TableGetResults"]:
"""Lists the Tables under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either TableGetResults or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.TableListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_tables_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("TableListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_table(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> _models.TableGetResults:
"""Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: TableGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.TableGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.TableGetResults] = kwargs.pop("cls", None)
_request = build_get_table_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("TableGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_table_initial(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: Union[_models.TableCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_table_parameters, (IOBase, bytes)):
_content = create_update_table_parameters
else:
_json = self._serialize.body(create_update_table_parameters, "TableCreateUpdateParameters")
_request = build_create_update_table_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_table(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: _models.TableCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableGetResults]:
"""Create or update an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param create_update_table_parameters: The parameters to provide for the current Table.
Required.
:type create_update_table_parameters: ~azure.mgmt.cosmosdb.models.TableCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_table(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableGetResults]:
"""Create or update an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param create_update_table_parameters: The parameters to provide for the current Table.
Required.
:type create_update_table_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_table(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: Union[_models.TableCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.TableGetResults]:
"""Create or update an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param create_update_table_parameters: The parameters to provide for the current Table. Is
either a TableCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_table_parameters: ~azure.mgmt.cosmosdb.models.TableCreateUpdateParameters
or IO[bytes]
:return: An instance of LROPoller that returns either TableGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.TableGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_table_initial(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
create_update_table_parameters=create_update_table_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("TableGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.TableGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.TableGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_table_initial(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_table_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_table(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_table_initial(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def get_table_throughput(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> _models.ThroughputSettingsGetResults:
"""Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with
the provided name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: ThroughputSettingsGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
_request = build_get_table_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _update_table_throughput_initial(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(update_throughput_parameters, (IOBase, bytes)):
_content = update_throughput_parameters
else:
_json = self._serialize.body(update_throughput_parameters, "ThroughputSettingsUpdateParameters")
_request = build_update_table_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_update_table_throughput(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current Table. Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_update_table_throughput(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current Table. Required.
:type update_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_update_table_throughput(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Update RUs per second of an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current Table. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type.
Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._update_table_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
update_throughput_parameters=update_throughput_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _migrate_table_to_autoscale_initial(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_migrate_table_to_autoscale_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_migrate_table_to_autoscale(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Migrate an Azure Cosmos DB Table from manual throughput to autoscale.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._migrate_table_to_autoscale_initial(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _migrate_table_to_manual_throughput_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_migrate_table_to_manual_throughput_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_migrate_table_to_manual_throughput(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
"""Migrate an Azure Cosmos DB Table from autoscale to manual throughput.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputSettingsGetResults] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._migrate_table_to_manual_throughput_initial(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputSettingsGetResults", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputSettingsGetResults].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputSettingsGetResults](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _retrieve_continuous_backup_information_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: Union[_models.ContinuousBackupRestoreLocation, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(location, (IOBase, bytes)):
_content = location
else:
_json = self._serialize.body(location, "ContinuousBackupRestoreLocation")
_request = build_retrieve_continuous_backup_information_request(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
"""Retrieves continuous backup information for a table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
"""Retrieves continuous backup information for a table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: Union[_models.ContinuousBackupRestoreLocation, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
"""Retrieves continuous backup information for a table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param location: The name of the continuous backup restore location. Is either a
ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation or IO[bytes]
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.BackupInformation] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._retrieve_continuous_backup_information_initial(
resource_group_name=resource_group_name,
account_name=account_name,
table_name=table_name,
location=location,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("BackupInformation", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.BackupInformation].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.BackupInformation](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@distributed_trace
def get_table_role_definition(
self, resource_group_name: str, account_name: str, role_definition_id: str, **kwargs: Any
) -> _models.TableRoleDefinitionResource:
"""Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given
Id.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:return: TableRoleDefinitionResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.TableRoleDefinitionResource] = kwargs.pop("cls", None)
_request = build_get_table_role_definition_request(
resource_group_name=resource_group_name,
account_name=account_name,
role_definition_id=role_definition_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("TableRoleDefinitionResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_table_role_definition_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: Union[_models.TableRoleDefinitionResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_table_role_definition_parameters, (IOBase, bytes)):
_content = create_update_table_role_definition_parameters
else:
_json = self._serialize.body(create_update_table_role_definition_parameters, "TableRoleDefinitionResource")
_request = build_create_update_table_role_definition_request(
resource_group_name=resource_group_name,
account_name=account_name,
role_definition_id=role_definition_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_table_role_definition( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: _models.TableRoleDefinitionResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleDefinitionResource]:
"""Creates or updates an Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param create_update_table_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_table_role_definition_parameters:
~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleDefinitionResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_table_role_definition( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleDefinitionResource]:
"""Creates or updates an Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param create_update_table_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_table_role_definition_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleDefinitionResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_table_role_definition( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: Union[_models.TableRoleDefinitionResource, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.TableRoleDefinitionResource]:
"""Creates or updates an Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param create_update_table_role_definition_parameters: The properties required to create or
update a Role Definition. Is either a TableRoleDefinitionResource type or a IO[bytes] type.
Required.
:type create_update_table_role_definition_parameters:
~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource or IO[bytes]
:return: An instance of LROPoller that returns either TableRoleDefinitionResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.TableRoleDefinitionResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_table_role_definition_initial(
resource_group_name=resource_group_name,
account_name=account_name,
role_definition_id=role_definition_id,
create_update_table_role_definition_parameters=create_update_table_role_definition_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("TableRoleDefinitionResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.TableRoleDefinitionResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.TableRoleDefinitionResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_table_role_definition_initial(
self, resource_group_name: str, account_name: str, role_definition_id: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_table_role_definition_request(
resource_group_name=resource_group_name,
account_name=account_name,
role_definition_id=role_definition_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_table_role_definition(
self, resource_group_name: str, account_name: str, role_definition_id: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_table_role_definition_initial(
resource_group_name=resource_group_name,
account_name=account_name,
role_definition_id=role_definition_id,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_table_role_definitions(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.TableRoleDefinitionResource"]:
"""Retrieves the list of all Azure Cosmos DB Table Role Definitions.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either TableRoleDefinitionResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.TableRoleDefinitionListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_table_role_definitions_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("TableRoleDefinitionListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_table_role_assignment(
self, resource_group_name: str, account_name: str, role_assignment_id: str, **kwargs: Any
) -> _models.TableRoleAssignmentResource:
"""Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given
Id.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:return: TableRoleAssignmentResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.TableRoleAssignmentResource] = kwargs.pop("cls", None)
_request = build_get_table_role_assignment_request(
resource_group_name=resource_group_name,
account_name=account_name,
role_assignment_id=role_assignment_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("TableRoleAssignmentResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_update_table_role_assignment_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: Union[_models.TableRoleAssignmentResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_update_table_role_assignment_parameters, (IOBase, bytes)):
_content = create_update_table_role_assignment_parameters
else:
_json = self._serialize.body(create_update_table_role_assignment_parameters, "TableRoleAssignmentResource")
_request = build_create_update_table_role_assignment_request(
resource_group_name=resource_group_name,
account_name=account_name,
role_assignment_id=role_assignment_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_update_table_role_assignment( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: _models.TableRoleAssignmentResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleAssignmentResource]:
"""Creates or updates an Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param create_update_table_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_table_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleAssignmentResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_update_table_role_assignment( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleAssignmentResource]:
"""Creates or updates an Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param create_update_table_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_table_role_assignment_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleAssignmentResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_update_table_role_assignment( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: Union[_models.TableRoleAssignmentResource, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.TableRoleAssignmentResource]:
"""Creates or updates an Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param create_update_table_role_assignment_parameters: The properties required to create or
update a Role Assignment. Is either a TableRoleAssignmentResource type or a IO[bytes] type.
Required.
:type create_update_table_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource or IO[bytes]
:return: An instance of LROPoller that returns either TableRoleAssignmentResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.TableRoleAssignmentResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_update_table_role_assignment_initial(
resource_group_name=resource_group_name,
account_name=account_name,
role_assignment_id=role_assignment_id,
create_update_table_role_assignment_parameters=create_update_table_role_assignment_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("TableRoleAssignmentResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.TableRoleAssignmentResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.TableRoleAssignmentResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_table_role_assignment_initial(
self, resource_group_name: str, account_name: str, role_assignment_id: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_table_role_assignment_request(
resource_group_name=resource_group_name,
account_name=account_name,
role_assignment_id=role_assignment_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete_table_role_assignment(
self, resource_group_name: str, account_name: str, role_assignment_id: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_table_role_assignment_initial(
resource_group_name=resource_group_name,
account_name=account_name,
role_assignment_id=role_assignment_id,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_table_role_assignments(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.TableRoleAssignmentResource"]:
"""Retrieves the list of all Azure Cosmos DB Table Role Assignments.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either TableRoleAssignmentResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.TableRoleAssignmentListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_table_role_assignments_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("TableRoleAssignmentListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class TableResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`table_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_tables(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.TableGetResults"]:
'''Lists the Tables under an existing Azure Cosmos DB database account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either TableGetResults or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_table(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> _models.TableGetResults:
'''Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: TableGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.TableGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_table_initial(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: Union[_models.TableCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_table(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: _models.TableCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableGetResults]:
'''Create or update an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param create_update_table_parameters: The parameters to provide for the current Table.
Required.
:type create_update_table_parameters: ~azure.mgmt.cosmosdb.models.TableCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_table(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: _models.TableCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableGetResults]:
'''Create or update an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param create_update_table_parameters: The parameters to provide for the current Table.
Required.
:type create_update_table_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_table(
self,
resource_group_name: str,
account_name: str,
table_name: str,
create_update_table_parameters: _models.TableCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableGetResults]:
'''Create or update an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param create_update_table_parameters: The parameters to provide for the current Table. Is
either a TableCreateUpdateParameters type or a IO[bytes] type. Required.
:type create_update_table_parameters: ~azure.mgmt.cosmosdb.models.TableCreateUpdateParameters
or IO[bytes]
:return: An instance of LROPoller that returns either TableGetResults or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_table_initial(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_table(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def get_table_throughput(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> _models.ThroughputSettingsGetResults:
'''Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with
the provided name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: ThroughputSettingsGetResults or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _update_table_throughput_initial(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: Union[_models.ThroughputSettingsUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_update_table_throughput(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current Table. Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_update_table_throughput(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current Table. Required.
:type update_throughput_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_update_table_throughput(
self,
resource_group_name: str,
account_name: str,
table_name: str,
update_throughput_parameters: _models.ThroughputSettingsUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Update RUs per second of an Azure Cosmos DB Table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param update_throughput_parameters: The parameters to provide for the RUs per second of the
current Table. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type.
Required.
:type update_throughput_parameters:
~azure.mgmt.cosmosdb.models.ThroughputSettingsUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _migrate_table_to_autoscale_initial(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_migrate_table_to_autoscale(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Migrate an Azure Cosmos DB Table from manual throughput to autoscale.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _migrate_table_to_manual_throughput_initial( # pylint: disable=name-too-long
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_migrate_table_to_manual_throughput(
self, resource_group_name: str, account_name: str, table_name: str, **kwargs: Any
) -> LROPoller[_models.ThroughputSettingsGetResults]:
'''Migrate an Azure Cosmos DB Table from autoscale to manual throughput.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:return: An instance of LROPoller that returns either ThroughputSettingsGetResults or the
result of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputSettingsGetResults]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _retrieve_continuous_backup_information_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: Union[_models.ContinuousBackupRestoreLocation, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
'''Retrieves continuous backup information for a table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
'''Retrieves continuous backup information for a table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param location: The name of the continuous backup restore location. Required.
:type location: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_retrieve_continuous_backup_information( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
table_name: str,
location: _models.ContinuousBackupRestoreLocation,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.BackupInformation]:
'''Retrieves continuous backup information for a table.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param table_name: Cosmos DB table name. Required.
:type table_name: str
:param location: The name of the continuous backup restore location. Is either a
ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.
:type location: ~azure.mgmt.cosmosdb.models.ContinuousBackupRestoreLocation or IO[bytes]
:return: An instance of LROPoller that returns either BackupInformation or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.BackupInformation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def get_table_role_definition(
self, resource_group_name: str, account_name: str, role_definition_id: str, **kwargs: Any
) -> _models.TableRoleDefinitionResource:
'''Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given
Id.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:return: TableRoleDefinitionResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_table_role_definition_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: Union[_models.TableRoleDefinitionResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_table_role_definition( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: _models.TableRoleDefinitionResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleDefinitionResource]:
'''Creates or updates an Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param create_update_table_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_table_role_definition_parameters:
~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleDefinitionResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_table_role_definition( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: _models.TableRoleDefinitionResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleDefinitionResource]:
'''Creates or updates an Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param create_update_table_role_definition_parameters: The properties required to create or
update a Role Definition. Required.
:type create_update_table_role_definition_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleDefinitionResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_table_role_definition( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_definition_id: str,
create_update_table_role_definition_parameters: _models.TableRoleDefinitionResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleDefinitionResource]:
'''Creates or updates an Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:param create_update_table_role_definition_parameters: The properties required to create or
update a Role Definition. Is either a TableRoleDefinitionResource type or a IO[bytes] type.
Required.
:type create_update_table_role_definition_parameters:
~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource or IO[bytes]
:return: An instance of LROPoller that returns either TableRoleDefinitionResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_table_role_definition_initial(
self, resource_group_name: str, account_name: str, role_definition_id: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_table_role_definition(
self, resource_group_name: str, account_name: str, role_definition_id: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB Table Role Definition.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_definition_id: The GUID for the Role Definition. Required.
:type role_definition_id: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_table_role_definitions(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.TableRoleDefinitionResource"]:
'''Retrieves the list of all Azure Cosmos DB Table Role Definitions.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either TableRoleDefinitionResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.TableRoleDefinitionResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_table_role_assignment(
self, resource_group_name: str, account_name: str, role_assignment_id: str, **kwargs: Any
) -> _models.TableRoleAssignmentResource:
'''Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given
Id.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:return: TableRoleAssignmentResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_update_table_role_assignment_initial( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: Union[_models.TableRoleAssignmentResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_update_table_role_assignment( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: _models.TableRoleAssignmentResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleAssignmentResource]:
'''Creates or updates an Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param create_update_table_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_table_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleAssignmentResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_update_table_role_assignment( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: _models.TableRoleAssignmentResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleAssignmentResource]:
'''Creates or updates an Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param create_update_table_role_assignment_parameters: The properties required to create or
update a Role Assignment. Required.
:type create_update_table_role_assignment_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either TableRoleAssignmentResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_update_table_role_assignment( # pylint: disable=name-too-long
self,
resource_group_name: str,
account_name: str,
role_assignment_id: str,
create_update_table_role_assignment_parameters: _models.TableRoleAssignmentResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.TableRoleAssignmentResource]:
'''Creates or updates an Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:param create_update_table_role_assignment_parameters: The properties required to create or
update a Role Assignment. Is either a TableRoleAssignmentResource type or a IO[bytes] type.
Required.
:type create_update_table_role_assignment_parameters:
~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource or IO[bytes]
:return: An instance of LROPoller that returns either TableRoleAssignmentResource or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_table_role_assignment_initial(
self, resource_group_name: str, account_name: str, role_assignment_id: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete_table_role_assignment(
self, resource_group_name: str, account_name: str, role_assignment_id: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB Table Role Assignment.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param role_assignment_id: The GUID for the Role Assignment. Required.
:type role_assignment_id: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_table_role_assignments(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.TableRoleAssignmentResource"]:
'''Retrieves the list of all Azure Cosmos DB Table Role Assignments.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either TableRoleAssignmentResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.TableRoleAssignmentResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 85 | 28 | 40 | 4 | 28 | 10 | 3 | 0.36 | 0 | 8 | 0 | 0 | 38 | 4 | 38 | 38 | 2,184 | 276 | 1,475 | 611 | 1,196 | 538 | 754 | 390 | 696 | 6 | 0 | 2 | 172 |
10,764 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_throughput_pool_account_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._throughput_pool_account_operations.ThroughputPoolAccountOperations
|
class ThroughputPoolAccountOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pool_account` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def get(
self, resource_group_name: str, throughput_pool_name: str, throughput_pool_account_name: str, **kwargs: Any
) -> _models.ThroughputPoolAccountResource:
"""Retrieves the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:return: ThroughputPoolAccountResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputPoolAccountResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
throughput_pool_account_name=throughput_pool_account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("ThroughputPoolAccountResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_initial(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: Union[_models.ThroughputPoolAccountResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(body, (IOBase, bytes)):
_content = body
else:
_json = self._serialize.body(body, "ThroughputPoolAccountResource")
_request = build_create_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
throughput_pool_account_name=throughput_pool_account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: _models.ThroughputPoolAccountResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolAccountResource]:
"""Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:param body: The parameters to provide for the current ThroughputPoolAccount. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolAccountResource or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolAccountResource]:
"""Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:param body: The parameters to provide for the current ThroughputPoolAccount. Required.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolAccountResource or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: Union[_models.ThroughputPoolAccountResource, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolAccountResource]:
"""Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:param body: The parameters to provide for the current ThroughputPoolAccount. Is either a
ThroughputPoolAccountResource type or a IO[bytes] type. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputPoolAccountResource or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ThroughputPoolAccountResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_initial(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
throughput_pool_account_name=throughput_pool_account_name,
body=body,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputPoolAccountResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputPoolAccountResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputPoolAccountResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial(
self, resource_group_name: str, throughput_pool_name: str, throughput_pool_account_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
throughput_pool_account_name=throughput_pool_account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete(
self, resource_group_name: str, throughput_pool_name: str, throughput_pool_account_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Removes an existing Azure Cosmos DB database account from a throughput pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
throughput_pool_account_name=throughput_pool_account_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class ThroughputPoolAccountOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pool_account` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def get(
self, resource_group_name: str, throughput_pool_name: str, throughput_pool_account_name: str, **kwargs: Any
) -> _models.ThroughputPoolAccountResource:
'''Retrieves the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:return: ThroughputPoolAccountResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_initial(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: Union[_models.ThroughputPoolAccountResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: _models.ThroughputPoolAccountResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolAccountResource]:
'''Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:param body: The parameters to provide for the current ThroughputPoolAccount. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolAccountResource or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: _models.ThroughputPoolAccountResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolAccountResource]:
'''Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:param body: The parameters to provide for the current ThroughputPoolAccount. Required.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolAccountResource or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create(
self,
resource_group_name: str,
throughput_pool_name: str,
throughput_pool_account_name: str,
body: _models.ThroughputPoolAccountResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolAccountResource]:
'''Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:param body: The parameters to provide for the current ThroughputPoolAccount. Is either a
ThroughputPoolAccountResource type or a IO[bytes] type. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputPoolAccountResource or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial(
self, resource_group_name: str, throughput_pool_name: str, throughput_pool_account_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete(
self, resource_group_name: str, throughput_pool_name: str, throughput_pool_account_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Removes an existing Azure Cosmos DB database account from a throughput pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param throughput_pool_account_name: Cosmos DB global database account in a Throughput Pool.
Required.
:type throughput_pool_account_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 16 | 6 | 40 | 4 | 27 | 11 | 3 | 0.41 | 0 | 8 | 0 | 0 | 8 | 4 | 8 | 8 | 414 | 50 | 270 | 119 | 216 | 112 | 138 | 76 | 127 | 5 | 0 | 2 | 34 |
10,765 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_throughput_pool_accounts_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._throughput_pool_accounts_operations.ThroughputPoolAccountsOperations
|
class ThroughputPoolAccountsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pool_accounts` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any
) -> Iterable["_models.ThroughputPoolAccountResource"]:
"""Lists all the Azure Cosmos DB accounts available under the subscription.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:return: An iterator like instance of either ThroughputPoolAccountResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputPoolAccountsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("ThroughputPoolAccountsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class ThroughputPoolAccountsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pool_accounts` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any
) -> Iterable["_models.ThroughputPoolAccountResource"]:
'''Lists all the Azure Cosmos DB accounts available under the subscription.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:return: An iterator like instance of either ThroughputPoolAccountResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ThroughputPoolAccountResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 28 | 3 | 22 | 3 | 2 | 0.31 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 103 | 16 | 68 | 30 | 59 | 21 | 43 | 27 | 37 | 5 | 0 | 1 | 12 |
10,766 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_throughput_pool_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._throughput_pool_operations.ThroughputPoolOperations
|
class ThroughputPoolOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pool` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def get(self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any) -> _models.ThroughputPoolResource:
"""Retrieves the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:return: ThroughputPoolResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputPoolResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputPoolResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("ThroughputPoolResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_or_update_initial(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Union[_models.ThroughputPoolResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(body, (IOBase, bytes)):
_content = body
else:
_json = self._serialize.body(body, "ThroughputPoolResource")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: _models.ThroughputPoolResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
"""Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current ThroughputPool. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
"""Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current ThroughputPool. Required.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Union[_models.ThroughputPoolResource, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
"""Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current ThroughputPool. Is either a
ThroughputPoolResource type or a IO[bytes] type. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolResource or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ThroughputPoolResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
body=body,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputPoolResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputPoolResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputPoolResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _update_initial(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[Union[_models.ThroughputPoolUpdate, IO[bytes]]] = None,
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(body, (IOBase, bytes)):
_content = body
else:
if body is not None:
_json = self._serialize.body(body, "ThroughputPoolUpdate")
else:
_json = None
_request = build_update_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
def begin_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[_models.ThroughputPoolUpdate] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
"""Updates the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current Throughput Pool. Default value is None.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolUpdate
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[IO[bytes]] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
"""Updates the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current Throughput Pool. Default value is None.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[Union[_models.ThroughputPoolUpdate, IO[bytes]]] = None,
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
"""Updates the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current Throughput Pool. Is either a
ThroughputPoolUpdate type or a IO[bytes] type. Default value is None.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolUpdate or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ThroughputPoolResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._update_initial(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
body=body,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ThroughputPoolResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.ThroughputPoolResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.ThroughputPoolResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial(self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["azure-AsyncOperation"] = self._deserialize(
"str", response.headers.get("azure-AsyncOperation")
)
response_headers["location"] = self._deserialize("str", response.headers.get("location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete(self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any) -> LROPoller[None]:
"""Deletes an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial(
resource_group_name=resource_group_name,
throughput_pool_name=throughput_pool_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class ThroughputPoolOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pool` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def get(self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any) -> _models.ThroughputPoolResource:
'''Retrieves the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:return: ThroughputPoolResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.ThroughputPoolResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_or_update_initial(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Union[_models.ThroughputPoolResource, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: _models.ThroughputPoolResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
'''Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current ThroughputPool. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: _models.ThroughputPoolResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
'''Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current ThroughputPool. Required.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: _models.ThroughputPoolResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
'''Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred
when performing updates on an account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current ThroughputPool. Is either a
ThroughputPoolResource type or a IO[bytes] type. Required.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolResource or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _update_initial(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[Union[_models.ThroughputPoolUpdate, IO[bytes]]] = None,
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[_models.ThroughputPoolUpdate] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
'''Updates the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current Throughput Pool. Default value is None.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolUpdate
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[_models.ThroughputPoolUpdate] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
'''Updates the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current Throughput Pool. Default value is None.
:type body: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_update(
self,
resource_group_name: str,
throughput_pool_name: str,
body: Optional[_models.ThroughputPoolUpdate] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.ThroughputPoolResource]:
'''Updates the properties of an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:param body: The parameters to provide for the current Throughput Pool. Is either a
ThroughputPoolUpdate type or a IO[bytes] type. Default value is None.
:type body: ~azure.mgmt.cosmosdb.models.ThroughputPoolUpdate or IO[bytes]
:return: An instance of LROPoller that returns either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial(self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete(self, resource_group_name: str, throughput_pool_name: str, **kwargs: Any) -> LROPoller[None]:
'''Deletes an existing Azure Cosmos DB Throughput Pool.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param throughput_pool_name: Cosmos DB Throughput Pool name. Required.
:type throughput_pool_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 24 | 9 | 38 | 4 | 26 | 10 | 3 | 0.37 | 0 | 8 | 0 | 0 | 12 | 4 | 12 | 12 | 586 | 71 | 393 | 172 | 313 | 147 | 203 | 108 | 187 | 7 | 0 | 2 | 50 |
10,767 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_throughput_pools_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._throughput_pools_operations.ThroughputPoolsOperations
|
class ThroughputPoolsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pools` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.ThroughputPoolResource"]:
"""Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
:return: An iterator like instance of either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputPoolsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("ThroughputPoolsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def list_by_resource_group(
self, resource_group_name: str, **kwargs: Any
) -> Iterable["_models.ThroughputPoolResource"]:
"""List all the ThroughputPools in a given resource group.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:return: An iterator like instance of either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.ThroughputPoolsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_resource_group_request(
resource_group_name=resource_group_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("ThroughputPoolsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class ThroughputPoolsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`throughput_pools` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.ThroughputPoolResource"]:
'''Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
:return: An iterator like instance of either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def list_by_resource_group(
self, resource_group_name: str, **kwargs: Any
) -> Iterable["_models.ThroughputPoolResource"]:
'''List all the ThroughputPools in a given resource group.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:return: An iterator like instance of either ThroughputPoolResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.ThroughputPoolResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 12 | 3 | 29 | 4 | 23 | 3 | 2 | 0.23 | 0 | 4 | 0 | 0 | 3 | 4 | 3 | 3 | 176 | 29 | 123 | 50 | 109 | 28 | 78 | 46 | 68 | 5 | 0 | 1 | 19 |
10,768 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/_configuration.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster._configuration.MongoClusterMgmtClientConfiguration
|
class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
"""Configuration for MongoClusterMgmtClient.
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: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2024-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:
api_version: str = kwargs.pop("api_version", "2024-03-01-preview")
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-mongocluster/{}".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
)
|
class MongoClusterMgmtClientConfiguration:
'''Configuration for MongoClusterMgmtClient.
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: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2024-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:
pass
def _configure(self, **kwargs: Any) -> None:
pass
| 3 | 1 | 15 | 1 | 14 | 0 | 3 | 0.43 | 0 | 3 | 0 | 0 | 2 | 14 | 2 | 2 | 45 | 6 | 28 | 18 | 25 | 12 | 26 | 18 | 23 | 3 | 0 | 1 | 5 |
10,769 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/_mongo_cluster_mgmt_client.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster._mongo_cluster_mgmt_client.MongoClusterMgmtClient
|
class MongoClusterMgmtClient: # pylint: disable=client-accepts-api-version-keyword
"""The Microsoft Azure management API provides create, read, update, and delete functionality for
Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.
:ivar operations: Operations operations
:vartype operations: azure.mgmt.mongocluster.operations.Operations
:ivar mongo_clusters: MongoClustersOperations operations
:vartype mongo_clusters: azure.mgmt.mongocluster.operations.MongoClustersOperations
:ivar firewall_rules: FirewallRulesOperations operations
:vartype firewall_rules: azure.mgmt.mongocluster.operations.FirewallRulesOperations
:ivar private_endpoint_connections: PrivateEndpointConnectionsOperations operations
:vartype private_endpoint_connections:
azure.mgmt.mongocluster.operations.PrivateEndpointConnectionsOperations
:ivar private_links: PrivateLinksOperations operations
:vartype private_links: azure.mgmt.mongocluster.operations.PrivateLinksOperations
: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 target subscription. The value must be an UUID. 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 "2024-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
) -> None:
self._config = MongoClusterMgmtClientConfiguration(
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.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
self.mongo_clusters = MongoClustersOperations(self._client, self._config, self._serialize, self._deserialize)
self.firewall_rules = FirewallRulesOperations(self._client, self._config, self._serialize, self._deserialize)
self.private_endpoint_connections = PrivateEndpointConnectionsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.private_links = PrivateLinksOperations(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) -> "MongoClusterMgmtClient":
self._client.__enter__()
return self
def __exit__(self, *exc_details: Any) -> None:
self._client.__exit__(*exc_details)
|
class MongoClusterMgmtClient:
'''The Microsoft Azure management API provides create, read, update, and delete functionality for
Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.
:ivar operations: Operations operations
:vartype operations: azure.mgmt.mongocluster.operations.Operations
:ivar mongo_clusters: MongoClustersOperations operations
:vartype mongo_clusters: azure.mgmt.mongocluster.operations.MongoClustersOperations
:ivar firewall_rules: FirewallRulesOperations operations
:vartype firewall_rules: azure.mgmt.mongocluster.operations.FirewallRulesOperations
:ivar private_endpoint_connections: PrivateEndpointConnectionsOperations operations
:vartype private_endpoint_connections:
azure.mgmt.mongocluster.operations.PrivateEndpointConnectionsOperations
:ivar private_links: PrivateLinksOperations operations
:vartype private_links: azure.mgmt.mongocluster.operations.PrivateLinksOperations
: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 target subscription. The value must be an UUID. 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 "2024-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
) -> None:
pass
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
'''
pass
def close(self) -> None:
pass
def __enter__(self) -> "MongoClusterMgmtClient":
pass
def __exit__(self, *exc_details: Any) -> None:
pass
| 6 | 2 | 14 | 1 | 10 | 3 | 1 | 0.77 | 0 | 12 | 8 | 0 | 5 | 9 | 5 | 5 | 101 | 11 | 52 | 24 | 40 | 40 | 27 | 18 | 21 | 3 | 0 | 1 | 7 |
10,770 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/aio/_configuration.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.aio._configuration.MongoClusterMgmtClientConfiguration
|
class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
"""Configuration for MongoClusterMgmtClient.
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_async.AsyncTokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2024-03-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
"""
def __init__(self, credential: "AsyncTokenCredential", subscription_id: str, **kwargs: Any) -> None:
api_version: str = kwargs.pop("api_version", "2024-03-01-preview")
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-mongocluster/{}".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.AsyncRedirectPolicy(**kwargs)
self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs)
self.authentication_policy = kwargs.get("authentication_policy")
if self.credential and not self.authentication_policy:
self.authentication_policy = AsyncARMChallengeAuthenticationPolicy(
self.credential, *self.credential_scopes, **kwargs
)
|
class MongoClusterMgmtClientConfiguration:
'''Configuration for MongoClusterMgmtClient.
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_async.AsyncTokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2024-03-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
'''
def __init__(self, credential: "AsyncTokenCredential", subscription_id: str, **kwargs: Any) -> None:
pass
def _configure(self, **kwargs: Any) -> None:
pass
| 3 | 1 | 15 | 1 | 14 | 0 | 3 | 0.43 | 0 | 3 | 0 | 0 | 2 | 14 | 2 | 2 | 45 | 6 | 28 | 18 | 25 | 12 | 26 | 18 | 23 | 3 | 0 | 1 | 5 |
10,771 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_mongodb_collections_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_mongodb_collections_operations.RestorableMongodbCollectionsOperations
|
class RestorableMongodbCollectionsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_mongodb_collections` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restorable_mongodb_database_rid: Optional[str] = None,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableMongodbCollectionGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under
a specific database. This helps in scenario where container was accidentally deleted. This
API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restorable_mongodb_database_rid: The resource ID of the MongoDB database. Default value
is None.
:type restorable_mongodb_database_rid: str
:param start_time: Restorable MongoDB collections event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable MongoDB collections event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableMongodbCollectionGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableMongodbCollectionGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableMongodbCollectionsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restorable_mongodb_database_rid=restorable_mongodb_database_rid,
start_time=start_time,
end_time=end_time,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableMongodbCollectionsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableMongodbCollectionsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_mongodb_collections` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restorable_mongodb_database_rid: Optional[str] = None,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableMongodbCollectionGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under
a specific database. This helps in scenario where container was accidentally deleted. This
API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restorable_mongodb_database_rid: The resource ID of the MongoDB database. Default value
is None.
:type restorable_mongodb_database_rid: str
:param start_time: Restorable MongoDB collections event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable MongoDB collections event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableMongodbCollectionGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableMongodbCollectionGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 32 | 3 | 24 | 5 | 2 | 0.41 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 121 | 16 | 76 | 35 | 61 | 31 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,772 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_gremlin_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_gremlin_resources_operations.RestorableGremlinResourcesOperations
|
class RestorableGremlinResourcesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_gremlin_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableGremlinResourcesGetResult"]:
"""Return a list of gremlin database and graphs combo that exist on the account at the given
timestamp and location. This helps in scenarios to validate what resources exist at given
timestamp and location. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableGremlinResourcesGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableGremlinResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableGremlinResourcesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restore_location=restore_location,
restore_timestamp_in_utc=restore_timestamp_in_utc,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableGremlinResourcesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableGremlinResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_gremlin_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restore_location: Optional[str] = None,
restore_timestamp_in_utc: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableGremlinResourcesGetResult"]:
'''Return a list of gremlin database and graphs combo that exist on the account at the given
timestamp and location. This helps in scenarios to validate what resources exist at given
timestamp and location. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restore_location: The location where the restorable resources are located. Default value
is None.
:type restore_location: str
:param restore_timestamp_in_utc: The timestamp when the restorable resources existed. Default
value is None.
:type restore_timestamp_in_utc: str
:return: An iterator like instance of either RestorableGremlinResourcesGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableGremlinResourcesGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 31 | 3 | 23 | 5 | 2 | 0.42 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 119 | 16 | 74 | 34 | 60 | 31 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,773 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_gremlin_graphs_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_gremlin_graphs_operations.RestorableGremlinGraphsOperations
|
class RestorableGremlinGraphsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_gremlin_graphs` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restorable_gremlin_database_rid: Optional[str] = None,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableGremlinGraphGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a
specific database. This helps in scenario where container was accidentally deleted. This API
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restorable_gremlin_database_rid: The resource ID of the Gremlin database. Default value
is None.
:type restorable_gremlin_database_rid: str
:param start_time: Restorable Gremlin graphs event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable Gremlin graphs event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableGremlinGraphGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableGremlinGraphGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableGremlinGraphsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
restorable_gremlin_database_rid=restorable_gremlin_database_rid,
start_time=start_time,
end_time=end_time,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableGremlinGraphsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableGremlinGraphsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_gremlin_graphs` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self,
location: str,
instance_id: str,
restorable_gremlin_database_rid: Optional[str] = None,
start_time: Optional[str] = None,
end_time: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.RestorableGremlinGraphGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a
specific database. This helps in scenario where container was accidentally deleted. This API
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:param restorable_gremlin_database_rid: The resource ID of the Gremlin database. Default value
is None.
:type restorable_gremlin_database_rid: str
:param start_time: Restorable Gremlin graphs event feed start time. Default value is None.
:type start_time: str
:param end_time: Restorable Gremlin graphs event feed end time. Default value is None.
:type end_time: str
:return: An iterator like instance of either RestorableGremlinGraphGetResult or the result of
cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableGremlinGraphGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 32 | 3 | 24 | 5 | 2 | 0.41 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 121 | 16 | 76 | 35 | 61 | 31 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,774 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_gremlin_databases_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_gremlin_databases_operations.RestorableGremlinDatabasesOperations
|
class RestorableGremlinDatabasesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_gremlin_databases` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(
self, location: str, instance_id: str, **kwargs: Any
) -> Iterable["_models.RestorableGremlinDatabaseGetResult"]:
"""Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under
the restorable account. This helps in scenario where database was accidentally deleted to get
the deletion time. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: An iterator like instance of either RestorableGremlinDatabaseGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableGremlinDatabaseGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableGremlinDatabasesListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableGremlinDatabasesListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class RestorableGremlinDatabasesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_gremlin_databases` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(
self, location: str, instance_id: str, **kwargs: Any
) -> Iterable["_models.RestorableGremlinDatabaseGetResult"]:
'''Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under
the restorable account. This helps in scenario where database was accidentally deleted to get
the deletion time. This API requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: An iterator like instance of either RestorableGremlinDatabaseGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableGremlinDatabaseGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 28 | 3 | 21 | 4 | 2 | 0.37 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 106 | 16 | 67 | 29 | 58 | 25 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,775 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2024_05_01_preview/aio/operations/_api_portals_operations.py
|
azext_spring.vendored_sdks.appplatform.v2024_05_01_preview.aio.operations._api_portals_operations.ApiPortalsOperations
|
class ApiPortalsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2024_05_01_preview.aio.AppPlatformManagementClient`'s
:attr:`api_portals` attribute.
"""
models = _models
def __init__(self, *args, **kwargs) -> None:
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
self._api_version = input_args.pop(0) if input_args else kwargs.pop("api_version")
@distributed_trace_async
async def get(
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> _models.ApiPortalResource:
"""Get the API portal and its properties.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:return: ApiPortalResource or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[_models.ApiPortalResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ApiPortalResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
async def _create_or_update_initial(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: Union[_models.ApiPortalResource, IO[bytes]],
**kwargs: Any
) -> _models.ApiPortalResource:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ApiPortalResource] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(api_portal_resource, (IOBase, bytes)):
_content = api_portal_resource
else:
_json = self._serialize.body(api_portal_resource, "ApiPortalResource")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if response.status_code == 200:
deserialized = self._deserialize("ApiPortalResource", pipeline_response)
if response.status_code == 201:
deserialized = self._deserialize("ApiPortalResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: _models.ApiPortalResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalResource]:
"""Create the default API portal or update the existing API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param api_portal_resource: The API portal for the create or update operation. Required.
:type api_portal_resource: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalResource or the result of
cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalResource]:
"""Create the default API portal or update the existing API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param api_portal_resource: The API portal for the create or update operation. Required.
:type api_portal_resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalResource or the result of
cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace_async
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: Union[_models.ApiPortalResource, IO[bytes]],
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalResource]:
"""Create the default API portal or update the existing API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param api_portal_resource: The API portal for the create or update operation. Is either a
ApiPortalResource type or a IO[bytes] type. Required.
:type api_portal_resource: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource
or IO[bytes]
:return: An instance of AsyncLROPoller that returns either ApiPortalResource or the result of
cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ApiPortalResource] = kwargs.pop("cls", None)
polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = await self._create_or_update_initial(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
api_portal_resource=api_portal_resource,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ApiPortalResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(AsyncPollingMethod, AsyncNoPolling())
else:
polling_method = polling
if cont_token:
return AsyncLROPoller[_models.ApiPortalResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return AsyncLROPoller[_models.ApiPortalResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
async def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> None:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {}) # type: ignore
@distributed_trace_async
async def begin_delete(
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> AsyncLROPoller[None]:
"""Delete the default API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = await self._delete_initial( # type: ignore
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(AsyncPollingMethod, AsyncNoPolling())
else:
polling_method = polling
if cont_token:
return AsyncLROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list(
self, resource_group_name: str, service_name: str, **kwargs: Any
) -> AsyncIterable["_models.ApiPortalResource"]:
"""Handles requests to list all resources in a Service.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:return: An iterator like instance of either ApiPortalResource or the result of cls(response)
:rtype:
~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[_models.ApiPortalResourceCollection] = kwargs.pop("cls", None)
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
resource_group_name=resource_group_name,
service_name=service_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
async def extract_data(pipeline_response):
deserialized = self._deserialize("ApiPortalResourceCollection", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, AsyncList(list_of_elem)
async def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)
@overload
async def validate_domain(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
validate_payload: _models.CustomDomainValidatePayload,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CustomDomainValidateResult:
"""Check the domains are valid as well as not in use.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param validate_payload: Custom domain payload to be validated. Required.
:type validate_payload:
~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidatePayload
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: CustomDomainValidateResult or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidateResult
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
async def validate_domain(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
validate_payload: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CustomDomainValidateResult:
"""Check the domains are valid as well as not in use.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param validate_payload: Custom domain payload to be validated. Required.
:type validate_payload: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: CustomDomainValidateResult or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidateResult
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace_async
async def validate_domain(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
validate_payload: Union[_models.CustomDomainValidatePayload, IO[bytes]],
**kwargs: Any
) -> _models.CustomDomainValidateResult:
"""Check the domains are valid as well as not in use.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param validate_payload: Custom domain payload to be validated. Is either a
CustomDomainValidatePayload type or a IO[bytes] type. Required.
:type validate_payload:
~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidatePayload or IO[bytes]
:return: CustomDomainValidateResult or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidateResult
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.CustomDomainValidateResult] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(validate_payload, (IOBase, bytes)):
_content = validate_payload
else:
_json = self._serialize.body(validate_payload, "CustomDomainValidatePayload")
_request = build_validate_domain_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("CustomDomainValidateResult", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
|
class ApiPortalsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2024_05_01_preview.aio.AppPlatformManagementClient`'s
:attr:`api_portals` attribute.
'''
def __init__(self, *args, **kwargs) -> None:
pass
@distributed_trace_async
async def get(
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> _models.ApiPortalResource:
'''Get the API portal and its properties.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:return: ApiPortalResource or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
async def _create_or_update_initial(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: Union[_models.ApiPortalResource, IO[bytes]],
**kwargs: Any
) -> _models.ApiPortalResource:
pass
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: _models.ApiPortalResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalResource]:
'''Create the default API portal or update the existing API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param api_portal_resource: The API portal for the create or update operation. Required.
:type api_portal_resource: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalResource or the result of
cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: _models.ApiPortalResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalResource]:
'''Create the default API portal or update the existing API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param api_portal_resource: The API portal for the create or update operation. Required.
:type api_portal_resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalResource or the result of
cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace_async
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
api_portal_resource: _models.ApiPortalResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalResource]:
'''Create the default API portal or update the existing API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param api_portal_resource: The API portal for the create or update operation. Is either a
ApiPortalResource type or a IO[bytes] type. Required.
:type api_portal_resource: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource
or IO[bytes]
:return: An instance of AsyncLROPoller that returns either ApiPortalResource or the result of
cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
async def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> None:
pass
@distributed_trace_async
async def begin_delete(
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> AsyncLROPoller[None]:
'''Delete the default API portal.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list(
self, resource_group_name: str, service_name: str, **kwargs: Any
) -> AsyncIterable["_models.ApiPortalResource"]:
'''Handles requests to list all resources in a Service.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:return: An iterator like instance of either ApiPortalResource or the result of cls(response)
:rtype:
~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
async def extract_data(pipeline_response):
pass
async def get_next(next_link=None):
pass
@overload
async def validate_domain(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
validate_payload: _models.CustomDomainValidatePayload,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CustomDomainValidateResult:
'''Check the domains are valid as well as not in use.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param validate_payload: Custom domain payload to be validated. Required.
:type validate_payload:
~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidatePayload
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: CustomDomainValidateResult or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidateResult
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
async def validate_domain(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
validate_payload: _models.CustomDomainValidatePayload,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CustomDomainValidateResult:
'''Check the domains are valid as well as not in use.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param validate_payload: Custom domain payload to be validated. Required.
:type validate_payload: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: CustomDomainValidateResult or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidateResult
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace_async
async def validate_domain(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
validate_payload: _models.CustomDomainValidatePayload,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CustomDomainValidateResult:
'''Check the domains are valid as well as not in use.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param validate_payload: Custom domain payload to be validated. Is either a
CustomDomainValidatePayload type or a IO[bytes] type. Required.
:type validate_payload:
~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidatePayload or IO[bytes]
:return: CustomDomainValidateResult or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.CustomDomainValidateResult
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
| 27 | 10 | 39 | 4 | 26 | 10 | 3 | 0.42 | 0 | 7 | 0 | 0 | 12 | 5 | 12 | 12 | 630 | 77 | 403 | 178 | 311 | 170 | 189 | 104 | 171 | 6 | 0 | 1 | 47 |
10,776 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2024_05_01_preview/aio/operations/_api_portal_custom_domains_operations.py
|
azext_spring.vendored_sdks.appplatform.v2024_05_01_preview.aio.operations._api_portal_custom_domains_operations.ApiPortalCustomDomainsOperations
|
class ApiPortalCustomDomainsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2024_05_01_preview.aio.AppPlatformManagementClient`'s
:attr:`api_portal_custom_domains` attribute.
"""
models = _models
def __init__(self, *args, **kwargs) -> None:
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
self._api_version = input_args.pop(0) if input_args else kwargs.pop("api_version")
@distributed_trace_async
async def get(
self, resource_group_name: str, service_name: str, api_portal_name: str, domain_name: str, **kwargs: Any
) -> _models.ApiPortalCustomDomainResource:
"""Get the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:return: ApiPortalCustomDomainResource or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[_models.ApiPortalCustomDomainResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
domain_name=domain_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("ApiPortalCustomDomainResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
async def _create_or_update_initial(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: Union[_models.ApiPortalCustomDomainResource, IO[bytes]],
**kwargs: Any
) -> _models.ApiPortalCustomDomainResource:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ApiPortalCustomDomainResource] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(api_portal_custom_domain_resource, (IOBase, bytes)):
_content = api_portal_custom_domain_resource
else:
_json = self._serialize.body(api_portal_custom_domain_resource, "ApiPortalCustomDomainResource")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
domain_name=domain_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if response.status_code == 200:
deserialized = self._deserialize("ApiPortalCustomDomainResource", pipeline_response)
if response.status_code == 201:
deserialized = self._deserialize("ApiPortalCustomDomainResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: _models.ApiPortalCustomDomainResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalCustomDomainResource]:
"""Create or update the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:param api_portal_custom_domain_resource: The API portal custom domain for the create or update
operation. Required.
:type api_portal_custom_domain_resource:
~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalCustomDomainResource or the
result of cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalCustomDomainResource]:
"""Create or update the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:param api_portal_custom_domain_resource: The API portal custom domain for the create or update
operation. Required.
:type api_portal_custom_domain_resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalCustomDomainResource or the
result of cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace_async
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: Union[_models.ApiPortalCustomDomainResource, IO[bytes]],
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalCustomDomainResource]:
"""Create or update the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:param api_portal_custom_domain_resource: The API portal custom domain for the create or update
operation. Is either a ApiPortalCustomDomainResource type or a IO[bytes] type. Required.
:type api_portal_custom_domain_resource:
~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource or IO[bytes]
:return: An instance of AsyncLROPoller that returns either ApiPortalCustomDomainResource or the
result of cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.ApiPortalCustomDomainResource] = kwargs.pop("cls", None)
polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = await self._create_or_update_initial(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
domain_name=domain_name,
api_portal_custom_domain_resource=api_portal_custom_domain_resource,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("ApiPortalCustomDomainResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(AsyncPollingMethod, AsyncNoPolling())
else:
polling_method = polling
if cont_token:
return AsyncLROPoller[_models.ApiPortalCustomDomainResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return AsyncLROPoller[_models.ApiPortalCustomDomainResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
async def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, service_name: str, api_portal_name: str, domain_name: str, **kwargs: Any
) -> None:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
domain_name=domain_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {}) # type: ignore
@distributed_trace_async
async def begin_delete(
self, resource_group_name: str, service_name: str, api_portal_name: str, domain_name: str, **kwargs: Any
) -> AsyncLROPoller[None]:
"""Delete the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = await self._delete_initial( # type: ignore
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
domain_name=domain_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: AsyncPollingMethod = cast(AsyncPollingMethod, AsyncARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(AsyncPollingMethod, AsyncNoPolling())
else:
polling_method = polling
if cont_token:
return AsyncLROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list(
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> AsyncIterable["_models.ApiPortalCustomDomainResource"]:
"""Handle requests to list all API portal custom domains.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:return: An iterator like instance of either ApiPortalCustomDomainResource or the result of
cls(response)
:rtype:
~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop(
"api_version", _params.pop("api-version", self._api_version or "2024-05-01-preview")
)
cls: ClsType[_models.ApiPortalCustomDomainResourceCollection] = kwargs.pop("cls", None)
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
resource_group_name=resource_group_name,
service_name=service_name,
api_portal_name=api_portal_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
async def extract_data(pipeline_response):
deserialized = self._deserialize("ApiPortalCustomDomainResourceCollection", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, AsyncList(list_of_elem)
async def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)
|
class ApiPortalCustomDomainsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2024_05_01_preview.aio.AppPlatformManagementClient`'s
:attr:`api_portal_custom_domains` attribute.
'''
def __init__(self, *args, **kwargs) -> None:
pass
@distributed_trace_async
async def get(
self, resource_group_name: str, service_name: str, api_portal_name: str, domain_name: str, **kwargs: Any
) -> _models.ApiPortalCustomDomainResource:
'''Get the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:return: ApiPortalCustomDomainResource or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
async def _create_or_update_initial(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: Union[_models.ApiPortalCustomDomainResource, IO[bytes]],
**kwargs: Any
) -> _models.ApiPortalCustomDomainResource:
pass
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: _models.ApiPortalCustomDomainResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalCustomDomainResource]:
'''Create or update the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:param api_portal_custom_domain_resource: The API portal custom domain for the create or update
operation. Required.
:type api_portal_custom_domain_resource:
~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalCustomDomainResource or the
result of cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: _models.ApiPortalCustomDomainResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalCustomDomainResource]:
'''Create or update the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:param api_portal_custom_domain_resource: The API portal custom domain for the create or update
operation. Required.
:type api_portal_custom_domain_resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either ApiPortalCustomDomainResource or the
result of cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace_async
async def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
api_portal_name: str,
domain_name: str,
api_portal_custom_domain_resource: _models.ApiPortalCustomDomainResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.ApiPortalCustomDomainResource]:
'''Create or update the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:param api_portal_custom_domain_resource: The API portal custom domain for the create or update
operation. Is either a ApiPortalCustomDomainResource type or a IO[bytes] type. Required.
:type api_portal_custom_domain_resource:
~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource or IO[bytes]
:return: An instance of AsyncLROPoller that returns either ApiPortalCustomDomainResource or the
result of cls(response)
:rtype:
~azure.core.polling.AsyncLROPoller[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
async def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, service_name: str, api_portal_name: str, domain_name: str, **kwargs: Any
) -> None:
pass
@distributed_trace_async
async def begin_delete(
self, resource_group_name: str, service_name: str, api_portal_name: str, domain_name: str, **kwargs: Any
) -> AsyncLROPoller[None]:
'''Delete the API portal custom domain.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:param domain_name: The name of the API portal custom domain. Required.
:type domain_name: str
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list(
self, resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any
) -> AsyncIterable["_models.ApiPortalCustomDomainResource"]:
'''Handle requests to list all API portal custom domains.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param api_portal_name: The name of API portal. Required.
:type api_portal_name: str
:return: An iterator like instance of either ApiPortalCustomDomainResource or the result of
cls(response)
:rtype:
~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.appplatform.v2024_05_01_preview.models.ApiPortalCustomDomainResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
async def extract_data(pipeline_response):
pass
async def get_next(next_link=None):
pass
| 21 | 7 | 39 | 4 | 27 | 9 | 3 | 0.39 | 0 | 7 | 0 | 0 | 9 | 5 | 9 | 9 | 511 | 61 | 335 | 138 | 270 | 132 | 160 | 88 | 145 | 6 | 0 | 1 | 41 |
10,777 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2024_05_01_preview/aio/_configuration.py
|
azext_spring.vendored_sdks.appplatform.v2024_05_01_preview.aio._configuration.AppPlatformManagementClientConfiguration
|
class AppPlatformManagementClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
"""Configuration for AppPlatformManagementClient.
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_async.AsyncTokenCredential
:param subscription_id: Gets subscription ID which uniquely identify the 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 "2024-05-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
"""
def __init__(self, credential: "AsyncTokenCredential", subscription_id: str, **kwargs: Any) -> None:
api_version: str = kwargs.pop("api_version", "2024-05-01-preview")
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-appplatform/{}".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.AsyncRedirectPolicy(**kwargs)
self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs)
self.authentication_policy = kwargs.get("authentication_policy")
if self.credential and not self.authentication_policy:
self.authentication_policy = AsyncARMChallengeAuthenticationPolicy(
self.credential, *self.credential_scopes, **kwargs
)
|
class AppPlatformManagementClientConfiguration:
'''Configuration for AppPlatformManagementClient.
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_async.AsyncTokenCredential
:param subscription_id: Gets subscription ID which uniquely identify the 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 "2024-05-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
'''
def __init__(self, credential: "AsyncTokenCredential", subscription_id: str, **kwargs: Any) -> None:
pass
def _configure(self, **kwargs: Any) -> None:
pass
| 3 | 1 | 15 | 1 | 14 | 0 | 3 | 0.46 | 0 | 3 | 0 | 0 | 2 | 14 | 2 | 2 | 46 | 6 | 28 | 18 | 25 | 13 | 26 | 18 | 23 | 3 | 0 | 1 | 5 |
10,778 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2024_05_01_preview/aio/_app_platform_management_client.py
|
azext_spring.vendored_sdks.appplatform.v2024_05_01_preview.aio._app_platform_management_client.AppPlatformManagementClient
|
class AppPlatformManagementClient: # pylint: disable=client-accepts-api-version-keyword,too-many-instance-attributes
"""REST API for Azure Spring Apps.
:ivar services: ServicesOperations operations
:vartype services: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ServicesOperations
:ivar apms: ApmsOperations operations
:vartype apms: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApmsOperations
:ivar eureka_servers: EurekaServersOperations operations
:vartype eureka_servers:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.EurekaServersOperations
:ivar config_servers: ConfigServersOperations operations
:vartype config_servers:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ConfigServersOperations
:ivar configuration_services: ConfigurationServicesOperations operations
:vartype configuration_services:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ConfigurationServicesOperations
:ivar service_registries: ServiceRegistriesOperations operations
:vartype service_registries:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ServiceRegistriesOperations
:ivar application_live_views: ApplicationLiveViewsOperations operations
:vartype application_live_views:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApplicationLiveViewsOperations
:ivar dev_tool_portals: DevToolPortalsOperations operations
:vartype dev_tool_portals:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.DevToolPortalsOperations
:ivar container_registries: ContainerRegistriesOperations operations
:vartype container_registries:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ContainerRegistriesOperations
:ivar build_service: BuildServiceOperations operations
:vartype build_service:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildServiceOperations
:ivar buildpack_binding: BuildpackBindingOperations operations
:vartype buildpack_binding:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildpackBindingOperations
:ivar build_service_builder: BuildServiceBuilderOperations operations
:vartype build_service_builder:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildServiceBuilderOperations
:ivar build_service_agent_pool: BuildServiceAgentPoolOperations operations
:vartype build_service_agent_pool:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildServiceAgentPoolOperations
:ivar monitoring_settings: MonitoringSettingsOperations operations
:vartype monitoring_settings:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.MonitoringSettingsOperations
:ivar apps: AppsOperations operations
:vartype apps: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.AppsOperations
:ivar bindings: BindingsOperations operations
:vartype bindings: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BindingsOperations
:ivar storages: StoragesOperations operations
:vartype storages: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.StoragesOperations
:ivar certificates: CertificatesOperations operations
:vartype certificates:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.CertificatesOperations
:ivar custom_domains: CustomDomainsOperations operations
:vartype custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.CustomDomainsOperations
:ivar deployments: DeploymentsOperations operations
:vartype deployments:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.DeploymentsOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.Operations
:ivar runtime_versions: RuntimeVersionsOperations operations
:vartype runtime_versions:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.RuntimeVersionsOperations
:ivar skus: SkusOperations operations
:vartype skus: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.SkusOperations
:ivar gateways: GatewaysOperations operations
:vartype gateways: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.GatewaysOperations
:ivar gateway_route_configs: GatewayRouteConfigsOperations operations
:vartype gateway_route_configs:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.GatewayRouteConfigsOperations
:ivar gateway_custom_domains: GatewayCustomDomainsOperations operations
:vartype gateway_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.GatewayCustomDomainsOperations
:ivar api_portals: ApiPortalsOperations operations
:vartype api_portals:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApiPortalsOperations
:ivar api_portal_custom_domains: ApiPortalCustomDomainsOperations operations
:vartype api_portal_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApiPortalCustomDomainsOperations
:ivar application_accelerators: ApplicationAcceleratorsOperations operations
:vartype application_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApplicationAcceleratorsOperations
:ivar customized_accelerators: CustomizedAcceleratorsOperations operations
:vartype customized_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.CustomizedAcceleratorsOperations
:ivar predefined_accelerators: PredefinedAcceleratorsOperations operations
:vartype predefined_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.PredefinedAcceleratorsOperations
:ivar jobs: JobsOperations operations
:vartype jobs: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobsOperations
:ivar job: JobOperations operations
:vartype job: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobOperations
:ivar job_execution: JobExecutionOperations operations
:vartype job_execution:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobExecutionOperations
:ivar job_executions: JobExecutionsOperations operations
:vartype job_executions:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobExecutionsOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
:param subscription_id: Gets subscription ID which uniquely identify the 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 "2024-05-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: "AsyncTokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
) -> None:
self._config = AppPlatformManagementClientConfiguration(
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),
AsyncARMAutoResourceProviderRegistrationPolicy(),
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: AsyncARMPipelineClient = AsyncARMPipelineClient(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.services = ServicesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.apms = ApmsOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.eureka_servers = EurekaServersOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.config_servers = ConfigServersOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.configuration_services = ConfigurationServicesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.service_registries = ServiceRegistriesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.application_live_views = ApplicationLiveViewsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.dev_tool_portals = DevToolPortalsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.container_registries = ContainerRegistriesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.build_service = BuildServiceOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.buildpack_binding = BuildpackBindingOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.build_service_builder = BuildServiceBuilderOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.build_service_agent_pool = BuildServiceAgentPoolOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.monitoring_settings = MonitoringSettingsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.apps = AppsOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.bindings = BindingsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.storages = StoragesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.certificates = CertificatesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.custom_domains = CustomDomainsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.deployments = DeploymentsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.operations = Operations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.runtime_versions = RuntimeVersionsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.skus = SkusOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.gateways = GatewaysOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.gateway_route_configs = GatewayRouteConfigsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.gateway_custom_domains = GatewayCustomDomainsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.api_portals = ApiPortalsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.api_portal_custom_domains = ApiPortalCustomDomainsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.application_accelerators = ApplicationAcceleratorsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.customized_accelerators = CustomizedAcceleratorsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.predefined_accelerators = PredefinedAcceleratorsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.jobs = JobsOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.job = JobOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.job_execution = JobExecutionOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.job_executions = JobExecutionsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
def _send_request(
self, request: HttpRequest, *, stream: bool = False, **kwargs: Any
) -> Awaitable[AsyncHttpResponse]:
"""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 = await client._send_request(request)
<AsyncHttpResponse: 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.AsyncHttpResponse
"""
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
async def close(self) -> None:
await self._client.close()
async def __aenter__(self) -> "AppPlatformManagementClient":
await self._client.__aenter__()
return self
async def __aexit__(self, *exc_details: Any) -> None:
await self._client.__aexit__(*exc_details)
|
class AppPlatformManagementClient:
'''REST API for Azure Spring Apps.
:ivar services: ServicesOperations operations
:vartype services: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ServicesOperations
:ivar apms: ApmsOperations operations
:vartype apms: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApmsOperations
:ivar eureka_servers: EurekaServersOperations operations
:vartype eureka_servers:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.EurekaServersOperations
:ivar config_servers: ConfigServersOperations operations
:vartype config_servers:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ConfigServersOperations
:ivar configuration_services: ConfigurationServicesOperations operations
:vartype configuration_services:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ConfigurationServicesOperations
:ivar service_registries: ServiceRegistriesOperations operations
:vartype service_registries:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ServiceRegistriesOperations
:ivar application_live_views: ApplicationLiveViewsOperations operations
:vartype application_live_views:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApplicationLiveViewsOperations
:ivar dev_tool_portals: DevToolPortalsOperations operations
:vartype dev_tool_portals:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.DevToolPortalsOperations
:ivar container_registries: ContainerRegistriesOperations operations
:vartype container_registries:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ContainerRegistriesOperations
:ivar build_service: BuildServiceOperations operations
:vartype build_service:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildServiceOperations
:ivar buildpack_binding: BuildpackBindingOperations operations
:vartype buildpack_binding:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildpackBindingOperations
:ivar build_service_builder: BuildServiceBuilderOperations operations
:vartype build_service_builder:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildServiceBuilderOperations
:ivar build_service_agent_pool: BuildServiceAgentPoolOperations operations
:vartype build_service_agent_pool:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BuildServiceAgentPoolOperations
:ivar monitoring_settings: MonitoringSettingsOperations operations
:vartype monitoring_settings:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.MonitoringSettingsOperations
:ivar apps: AppsOperations operations
:vartype apps: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.AppsOperations
:ivar bindings: BindingsOperations operations
:vartype bindings: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.BindingsOperations
:ivar storages: StoragesOperations operations
:vartype storages: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.StoragesOperations
:ivar certificates: CertificatesOperations operations
:vartype certificates:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.CertificatesOperations
:ivar custom_domains: CustomDomainsOperations operations
:vartype custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.CustomDomainsOperations
:ivar deployments: DeploymentsOperations operations
:vartype deployments:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.DeploymentsOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.Operations
:ivar runtime_versions: RuntimeVersionsOperations operations
:vartype runtime_versions:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.RuntimeVersionsOperations
:ivar skus: SkusOperations operations
:vartype skus: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.SkusOperations
:ivar gateways: GatewaysOperations operations
:vartype gateways: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.GatewaysOperations
:ivar gateway_route_configs: GatewayRouteConfigsOperations operations
:vartype gateway_route_configs:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.GatewayRouteConfigsOperations
:ivar gateway_custom_domains: GatewayCustomDomainsOperations operations
:vartype gateway_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.GatewayCustomDomainsOperations
:ivar api_portals: ApiPortalsOperations operations
:vartype api_portals:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApiPortalsOperations
:ivar api_portal_custom_domains: ApiPortalCustomDomainsOperations operations
:vartype api_portal_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApiPortalCustomDomainsOperations
:ivar application_accelerators: ApplicationAcceleratorsOperations operations
:vartype application_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.ApplicationAcceleratorsOperations
:ivar customized_accelerators: CustomizedAcceleratorsOperations operations
:vartype customized_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.CustomizedAcceleratorsOperations
:ivar predefined_accelerators: PredefinedAcceleratorsOperations operations
:vartype predefined_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.PredefinedAcceleratorsOperations
:ivar jobs: JobsOperations operations
:vartype jobs: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobsOperations
:ivar job: JobOperations operations
:vartype job: azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobOperations
:ivar job_execution: JobExecutionOperations operations
:vartype job_execution:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobExecutionOperations
:ivar job_executions: JobExecutionsOperations operations
:vartype job_executions:
azure.mgmt.appplatform.v2024_05_01_preview.aio.operations.JobExecutionsOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
:param subscription_id: Gets subscription ID which uniquely identify the 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 "2024-05-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: "AsyncTokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
) -> None:
pass
def _send_request(
self, request: HttpRequest, *, stream: bool = False, **kwargs: Any
) -> Awaitable[AsyncHttpResponse]:
'''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 = await client._send_request(request)
<AsyncHttpResponse: 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.AsyncHttpResponse
'''
pass
async def close(self) -> None:
pass
async def __aenter__(self) -> "AppPlatformManagementClient":
pass
async def __aexit__(self, *exc_details: Any) -> None:
pass
| 6 | 2 | 32 | 1 | 28 | 3 | 1 | 0.87 | 0 | 42 | 38 | 0 | 5 | 39 | 5 | 5 | 275 | 11 | 142 | 56 | 128 | 124 | 57 | 48 | 51 | 3 | 0 | 1 | 7 |
10,779 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2024_05_01_preview/_configuration.py
|
azext_spring.vendored_sdks.appplatform.v2024_05_01_preview._configuration.AppPlatformManagementClientConfiguration
|
class AppPlatformManagementClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
"""Configuration for AppPlatformManagementClient.
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 ID which uniquely identify the 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 "2024-05-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:
api_version: str = kwargs.pop("api_version", "2024-05-01-preview")
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-appplatform/{}".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
)
|
class AppPlatformManagementClientConfiguration:
'''Configuration for AppPlatformManagementClient.
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 ID which uniquely identify the 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 "2024-05-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:
pass
def _configure(self, **kwargs: Any) -> None:
pass
| 3 | 1 | 15 | 1 | 14 | 0 | 3 | 0.46 | 0 | 3 | 0 | 0 | 2 | 14 | 2 | 2 | 46 | 6 | 28 | 18 | 25 | 13 | 26 | 18 | 23 | 3 | 0 | 1 | 5 |
10,780 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2024_05_01_preview/_app_platform_management_client.py
|
azext_spring.vendored_sdks.appplatform.v2024_05_01_preview._app_platform_management_client.AppPlatformManagementClient
|
class AppPlatformManagementClient: # pylint: disable=client-accepts-api-version-keyword,too-many-instance-attributes
"""REST API for Azure Spring Apps.
:ivar services: ServicesOperations operations
:vartype services: azure.mgmt.appplatform.v2024_05_01_preview.operations.ServicesOperations
:ivar apms: ApmsOperations operations
:vartype apms: azure.mgmt.appplatform.v2024_05_01_preview.operations.ApmsOperations
:ivar eureka_servers: EurekaServersOperations operations
:vartype eureka_servers:
azure.mgmt.appplatform.v2024_05_01_preview.operations.EurekaServersOperations
:ivar config_servers: ConfigServersOperations operations
:vartype config_servers:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ConfigServersOperations
:ivar configuration_services: ConfigurationServicesOperations operations
:vartype configuration_services:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ConfigurationServicesOperations
:ivar service_registries: ServiceRegistriesOperations operations
:vartype service_registries:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ServiceRegistriesOperations
:ivar application_live_views: ApplicationLiveViewsOperations operations
:vartype application_live_views:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApplicationLiveViewsOperations
:ivar dev_tool_portals: DevToolPortalsOperations operations
:vartype dev_tool_portals:
azure.mgmt.appplatform.v2024_05_01_preview.operations.DevToolPortalsOperations
:ivar container_registries: ContainerRegistriesOperations operations
:vartype container_registries:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ContainerRegistriesOperations
:ivar build_service: BuildServiceOperations operations
:vartype build_service:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildServiceOperations
:ivar buildpack_binding: BuildpackBindingOperations operations
:vartype buildpack_binding:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildpackBindingOperations
:ivar build_service_builder: BuildServiceBuilderOperations operations
:vartype build_service_builder:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildServiceBuilderOperations
:ivar build_service_agent_pool: BuildServiceAgentPoolOperations operations
:vartype build_service_agent_pool:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildServiceAgentPoolOperations
:ivar monitoring_settings: MonitoringSettingsOperations operations
:vartype monitoring_settings:
azure.mgmt.appplatform.v2024_05_01_preview.operations.MonitoringSettingsOperations
:ivar apps: AppsOperations operations
:vartype apps: azure.mgmt.appplatform.v2024_05_01_preview.operations.AppsOperations
:ivar bindings: BindingsOperations operations
:vartype bindings: azure.mgmt.appplatform.v2024_05_01_preview.operations.BindingsOperations
:ivar storages: StoragesOperations operations
:vartype storages: azure.mgmt.appplatform.v2024_05_01_preview.operations.StoragesOperations
:ivar certificates: CertificatesOperations operations
:vartype certificates:
azure.mgmt.appplatform.v2024_05_01_preview.operations.CertificatesOperations
:ivar custom_domains: CustomDomainsOperations operations
:vartype custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.operations.CustomDomainsOperations
:ivar deployments: DeploymentsOperations operations
:vartype deployments:
azure.mgmt.appplatform.v2024_05_01_preview.operations.DeploymentsOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.appplatform.v2024_05_01_preview.operations.Operations
:ivar runtime_versions: RuntimeVersionsOperations operations
:vartype runtime_versions:
azure.mgmt.appplatform.v2024_05_01_preview.operations.RuntimeVersionsOperations
:ivar skus: SkusOperations operations
:vartype skus: azure.mgmt.appplatform.v2024_05_01_preview.operations.SkusOperations
:ivar gateways: GatewaysOperations operations
:vartype gateways: azure.mgmt.appplatform.v2024_05_01_preview.operations.GatewaysOperations
:ivar gateway_route_configs: GatewayRouteConfigsOperations operations
:vartype gateway_route_configs:
azure.mgmt.appplatform.v2024_05_01_preview.operations.GatewayRouteConfigsOperations
:ivar gateway_custom_domains: GatewayCustomDomainsOperations operations
:vartype gateway_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.operations.GatewayCustomDomainsOperations
:ivar api_portals: ApiPortalsOperations operations
:vartype api_portals:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApiPortalsOperations
:ivar api_portal_custom_domains: ApiPortalCustomDomainsOperations operations
:vartype api_portal_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApiPortalCustomDomainsOperations
:ivar application_accelerators: ApplicationAcceleratorsOperations operations
:vartype application_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApplicationAcceleratorsOperations
:ivar customized_accelerators: CustomizedAcceleratorsOperations operations
:vartype customized_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.operations.CustomizedAcceleratorsOperations
:ivar predefined_accelerators: PredefinedAcceleratorsOperations operations
:vartype predefined_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.operations.PredefinedAcceleratorsOperations
:ivar jobs: JobsOperations operations
:vartype jobs: azure.mgmt.appplatform.v2024_05_01_preview.operations.JobsOperations
:ivar job: JobOperations operations
:vartype job: azure.mgmt.appplatform.v2024_05_01_preview.operations.JobOperations
:ivar job_execution: JobExecutionOperations operations
:vartype job_execution:
azure.mgmt.appplatform.v2024_05_01_preview.operations.JobExecutionOperations
:ivar job_executions: JobExecutionsOperations operations
:vartype job_executions:
azure.mgmt.appplatform.v2024_05_01_preview.operations.JobExecutionsOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: Gets subscription ID which uniquely identify the 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 "2024-05-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
) -> None:
self._config = AppPlatformManagementClientConfiguration(
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.services = ServicesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.apms = ApmsOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.eureka_servers = EurekaServersOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.config_servers = ConfigServersOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.configuration_services = ConfigurationServicesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.service_registries = ServiceRegistriesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.application_live_views = ApplicationLiveViewsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.dev_tool_portals = DevToolPortalsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.container_registries = ContainerRegistriesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.build_service = BuildServiceOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.buildpack_binding = BuildpackBindingOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.build_service_builder = BuildServiceBuilderOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.build_service_agent_pool = BuildServiceAgentPoolOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.monitoring_settings = MonitoringSettingsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.apps = AppsOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.bindings = BindingsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.storages = StoragesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.certificates = CertificatesOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.custom_domains = CustomDomainsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.deployments = DeploymentsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.operations = Operations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.runtime_versions = RuntimeVersionsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.skus = SkusOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.gateways = GatewaysOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.gateway_route_configs = GatewayRouteConfigsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.gateway_custom_domains = GatewayCustomDomainsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.api_portals = ApiPortalsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.api_portal_custom_domains = ApiPortalCustomDomainsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.application_accelerators = ApplicationAcceleratorsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.customized_accelerators = CustomizedAcceleratorsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.predefined_accelerators = PredefinedAcceleratorsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.jobs = JobsOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.job = JobOperations(self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview")
self.job_execution = JobExecutionOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
self.job_executions = JobExecutionsOperations(
self._client, self._config, self._serialize, self._deserialize, "2024-05-01-preview"
)
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) -> "AppPlatformManagementClient":
self._client.__enter__()
return self
def __exit__(self, *exc_details: Any) -> None:
self._client.__exit__(*exc_details)
|
class AppPlatformManagementClient:
'''REST API for Azure Spring Apps.
:ivar services: ServicesOperations operations
:vartype services: azure.mgmt.appplatform.v2024_05_01_preview.operations.ServicesOperations
:ivar apms: ApmsOperations operations
:vartype apms: azure.mgmt.appplatform.v2024_05_01_preview.operations.ApmsOperations
:ivar eureka_servers: EurekaServersOperations operations
:vartype eureka_servers:
azure.mgmt.appplatform.v2024_05_01_preview.operations.EurekaServersOperations
:ivar config_servers: ConfigServersOperations operations
:vartype config_servers:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ConfigServersOperations
:ivar configuration_services: ConfigurationServicesOperations operations
:vartype configuration_services:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ConfigurationServicesOperations
:ivar service_registries: ServiceRegistriesOperations operations
:vartype service_registries:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ServiceRegistriesOperations
:ivar application_live_views: ApplicationLiveViewsOperations operations
:vartype application_live_views:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApplicationLiveViewsOperations
:ivar dev_tool_portals: DevToolPortalsOperations operations
:vartype dev_tool_portals:
azure.mgmt.appplatform.v2024_05_01_preview.operations.DevToolPortalsOperations
:ivar container_registries: ContainerRegistriesOperations operations
:vartype container_registries:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ContainerRegistriesOperations
:ivar build_service: BuildServiceOperations operations
:vartype build_service:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildServiceOperations
:ivar buildpack_binding: BuildpackBindingOperations operations
:vartype buildpack_binding:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildpackBindingOperations
:ivar build_service_builder: BuildServiceBuilderOperations operations
:vartype build_service_builder:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildServiceBuilderOperations
:ivar build_service_agent_pool: BuildServiceAgentPoolOperations operations
:vartype build_service_agent_pool:
azure.mgmt.appplatform.v2024_05_01_preview.operations.BuildServiceAgentPoolOperations
:ivar monitoring_settings: MonitoringSettingsOperations operations
:vartype monitoring_settings:
azure.mgmt.appplatform.v2024_05_01_preview.operations.MonitoringSettingsOperations
:ivar apps: AppsOperations operations
:vartype apps: azure.mgmt.appplatform.v2024_05_01_preview.operations.AppsOperations
:ivar bindings: BindingsOperations operations
:vartype bindings: azure.mgmt.appplatform.v2024_05_01_preview.operations.BindingsOperations
:ivar storages: StoragesOperations operations
:vartype storages: azure.mgmt.appplatform.v2024_05_01_preview.operations.StoragesOperations
:ivar certificates: CertificatesOperations operations
:vartype certificates:
azure.mgmt.appplatform.v2024_05_01_preview.operations.CertificatesOperations
:ivar custom_domains: CustomDomainsOperations operations
:vartype custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.operations.CustomDomainsOperations
:ivar deployments: DeploymentsOperations operations
:vartype deployments:
azure.mgmt.appplatform.v2024_05_01_preview.operations.DeploymentsOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.appplatform.v2024_05_01_preview.operations.Operations
:ivar runtime_versions: RuntimeVersionsOperations operations
:vartype runtime_versions:
azure.mgmt.appplatform.v2024_05_01_preview.operations.RuntimeVersionsOperations
:ivar skus: SkusOperations operations
:vartype skus: azure.mgmt.appplatform.v2024_05_01_preview.operations.SkusOperations
:ivar gateways: GatewaysOperations operations
:vartype gateways: azure.mgmt.appplatform.v2024_05_01_preview.operations.GatewaysOperations
:ivar gateway_route_configs: GatewayRouteConfigsOperations operations
:vartype gateway_route_configs:
azure.mgmt.appplatform.v2024_05_01_preview.operations.GatewayRouteConfigsOperations
:ivar gateway_custom_domains: GatewayCustomDomainsOperations operations
:vartype gateway_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.operations.GatewayCustomDomainsOperations
:ivar api_portals: ApiPortalsOperations operations
:vartype api_portals:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApiPortalsOperations
:ivar api_portal_custom_domains: ApiPortalCustomDomainsOperations operations
:vartype api_portal_custom_domains:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApiPortalCustomDomainsOperations
:ivar application_accelerators: ApplicationAcceleratorsOperations operations
:vartype application_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.operations.ApplicationAcceleratorsOperations
:ivar customized_accelerators: CustomizedAcceleratorsOperations operations
:vartype customized_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.operations.CustomizedAcceleratorsOperations
:ivar predefined_accelerators: PredefinedAcceleratorsOperations operations
:vartype predefined_accelerators:
azure.mgmt.appplatform.v2024_05_01_preview.operations.PredefinedAcceleratorsOperations
:ivar jobs: JobsOperations operations
:vartype jobs: azure.mgmt.appplatform.v2024_05_01_preview.operations.JobsOperations
:ivar job: JobOperations operations
:vartype job: azure.mgmt.appplatform.v2024_05_01_preview.operations.JobOperations
:ivar job_execution: JobExecutionOperations operations
:vartype job_execution:
azure.mgmt.appplatform.v2024_05_01_preview.operations.JobExecutionOperations
:ivar job_executions: JobExecutionsOperations operations
:vartype job_executions:
azure.mgmt.appplatform.v2024_05_01_preview.operations.JobExecutionsOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: Gets subscription ID which uniquely identify the 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 "2024-05-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
) -> None:
pass
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
'''
pass
def close(self) -> None:
pass
def __enter__(self) -> "AppPlatformManagementClient":
pass
def __exit__(self, *exc_details: Any) -> None:
pass
| 6 | 2 | 31 | 1 | 28 | 3 | 1 | 0.89 | 0 | 42 | 38 | 0 | 5 | 39 | 5 | 5 | 273 | 11 | 140 | 54 | 128 | 124 | 57 | 48 | 51 | 3 | 0 | 1 | 7 |
10,781 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2023_12_01/operations/_storages_operations.py
|
azext_spring.vendored_sdks.appplatform.v2023_12_01.operations._storages_operations.StoragesOperations
|
class StoragesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2023_12_01.AppPlatformManagementClient`'s
:attr:`storages` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
self._api_version = input_args.pop(0) if input_args else kwargs.pop("api_version")
@distributed_trace
def get(
self, resource_group_name: str, service_name: str, storage_name: str, **kwargs: Any
) -> _models.StorageResource:
"""Get the storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:return: StorageResource or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2023_12_01.models.StorageResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
cls: ClsType[_models.StorageResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
service_name=service_name,
storage_name=storage_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("StorageResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_or_update_initial(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: Union[_models.StorageResource, IO[bytes]],
**kwargs: Any
) -> _models.StorageResource:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.StorageResource] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(storage_resource, (IOBase, bytes)):
_content = storage_resource
else:
_json = self._serialize.body(storage_resource, "StorageResource")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
service_name=service_name,
storage_name=storage_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201, 202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if response.status_code == 200:
deserialized = self._deserialize("StorageResource", pipeline_response)
if response.status_code == 201:
deserialized = self._deserialize("StorageResource", pipeline_response)
if response.status_code == 202:
deserialized = self._deserialize("StorageResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: _models.StorageResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.StorageResource]:
"""Create or update storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:param storage_resource: Parameters for the create or update operation. Required.
:type storage_resource: ~azure.mgmt.appplatform.v2023_12_01.models.StorageResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either StorageResource or the result of
cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.StorageResource]:
"""Create or update storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:param storage_resource: Parameters for the create or update operation. Required.
:type storage_resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either StorageResource or the result of
cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: Union[_models.StorageResource, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.StorageResource]:
"""Create or update storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:param storage_resource: Parameters for the create or update operation. Is either a
StorageResource type or a IO[bytes] type. Required.
:type storage_resource: ~azure.mgmt.appplatform.v2023_12_01.models.StorageResource or IO[bytes]
:return: An instance of LROPoller that returns either StorageResource or the result of
cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.StorageResource] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
service_name=service_name,
storage_name=storage_name,
storage_resource=storage_resource,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("StorageResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.StorageResource].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.StorageResource](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, service_name: str, storage_name: str, **kwargs: Any
) -> None:
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
service_name=service_name,
storage_name=storage_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {}) # type: ignore
@distributed_trace
def begin_delete(
self, resource_group_name: str, service_name: str, storage_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Delete the storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial( # type: ignore
resource_group_name=resource_group_name,
service_name=service_name,
storage_name=storage_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list(self, resource_group_name: str, service_name: str, **kwargs: Any) -> Iterable["_models.StorageResource"]:
"""List all the storages of one Azure Spring Apps resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:return: An iterator like instance of either StorageResource or the result of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
cls: ClsType[_models.StorageResourceCollection] = kwargs.pop("cls", None)
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
resource_group_name=resource_group_name,
service_name=service_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("StorageResourceCollection", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class StoragesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2023_12_01.AppPlatformManagementClient`'s
:attr:`storages` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def get(
self, resource_group_name: str, service_name: str, storage_name: str, **kwargs: Any
) -> _models.StorageResource:
'''Get the storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:return: StorageResource or the result of cls(response)
:rtype: ~azure.mgmt.appplatform.v2023_12_01.models.StorageResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_or_update_initial(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: Union[_models.StorageResource, IO[bytes]],
**kwargs: Any
) -> _models.StorageResource:
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: _models.StorageResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.StorageResource]:
'''Create or update storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:param storage_resource: Parameters for the create or update operation. Required.
:type storage_resource: ~azure.mgmt.appplatform.v2023_12_01.models.StorageResource
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either StorageResource or the result of
cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: _models.StorageResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.StorageResource]:
'''Create or update storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:param storage_resource: Parameters for the create or update operation. Required.
:type storage_resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either StorageResource or the result of
cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
service_name: str,
storage_name: str,
storage_resource: _models.StorageResource,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.StorageResource]:
'''Create or update storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:param storage_resource: Parameters for the create or update operation. Is either a
StorageResource type or a IO[bytes] type. Required.
:type storage_resource: ~azure.mgmt.appplatform.v2023_12_01.models.StorageResource or IO[bytes]
:return: An instance of LROPoller that returns either StorageResource or the result of
cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, service_name: str, storage_name: str, **kwargs: Any
) -> None:
pass
@distributed_trace
def begin_delete(
self, resource_group_name: str, service_name: str, storage_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Delete the storage resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:param storage_name: The name of the storage resource. Required.
:type storage_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list(self, resource_group_name: str, service_name: str, **kwargs: Any) -> Iterable["_models.StorageResource"]:
'''List all the storages of one Azure Spring Apps resource.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param service_name: The name of the Service resource. Required.
:type service_name: str
:return: An iterator like instance of either StorageResource or the result of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.appplatform.v2023_12_01.models.StorageResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 21 | 7 | 36 | 4 | 26 | 8 | 3 | 0.37 | 0 | 7 | 0 | 0 | 9 | 5 | 9 | 9 | 473 | 62 | 313 | 132 | 254 | 115 | 162 | 88 | 147 | 7 | 0 | 1 | 42 |
10,782 |
Azure/azure-cli-extensions
|
src/spring/azext_spring/vendored_sdks/appplatform/v2023_12_01/operations/_skus_operations.py
|
azext_spring.vendored_sdks.appplatform.v2023_12_01.operations._skus_operations.SkusOperations
|
class SkusOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2023_12_01.AppPlatformManagementClient`'s
:attr:`skus` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
self._api_version = input_args.pop(0) if input_args else kwargs.pop("api_version")
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.ResourceSku"]:
"""Lists all of the available skus of the Microsoft.AppPlatform provider.
:return: An iterator like instance of either ResourceSku or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.appplatform.v2023_12_01.models.ResourceSku]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-12-01"))
cls: ClsType[_models.ResourceSkuCollection] = kwargs.pop("cls", None)
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("ResourceSkuCollection", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class SkusOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.appplatform.v2023_12_01.AppPlatformManagementClient`'s
:attr:`skus` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.ResourceSku"]:
'''Lists all of the available skus of the Microsoft.AppPlatform provider.
:return: An iterator like instance of either ResourceSku or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.appplatform.v2023_12_01.models.ResourceSku]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 26 | 3 | 21 | 2 | 3 | 0.23 | 0 | 3 | 0 | 0 | 2 | 5 | 2 | 2 | 95 | 16 | 66 | 28 | 59 | 15 | 45 | 27 | 39 | 6 | 0 | 1 | 13 |
10,783 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/aio/_mongo_cluster_mgmt_client.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.aio._mongo_cluster_mgmt_client.MongoClusterMgmtClient
|
class MongoClusterMgmtClient: # pylint: disable=client-accepts-api-version-keyword
"""The Microsoft Azure management API provides create, read, update, and delete functionality for
Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.
:ivar operations: Operations operations
:vartype operations: azure.mgmt.mongocluster.aio.operations.Operations
:ivar mongo_clusters: MongoClustersOperations operations
:vartype mongo_clusters: azure.mgmt.mongocluster.aio.operations.MongoClustersOperations
:ivar firewall_rules: FirewallRulesOperations operations
:vartype firewall_rules: azure.mgmt.mongocluster.aio.operations.FirewallRulesOperations
:ivar private_endpoint_connections: PrivateEndpointConnectionsOperations operations
:vartype private_endpoint_connections:
azure.mgmt.mongocluster.aio.operations.PrivateEndpointConnectionsOperations
:ivar private_links: PrivateLinksOperations operations
:vartype private_links: azure.mgmt.mongocluster.aio.operations.PrivateLinksOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. 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 "2024-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: "AsyncTokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
) -> None:
self._config = MongoClusterMgmtClientConfiguration(
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),
AsyncARMAutoResourceProviderRegistrationPolicy(),
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: AsyncARMPipelineClient = AsyncARMPipelineClient(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.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
self.mongo_clusters = MongoClustersOperations(self._client, self._config, self._serialize, self._deserialize)
self.firewall_rules = FirewallRulesOperations(self._client, self._config, self._serialize, self._deserialize)
self.private_endpoint_connections = PrivateEndpointConnectionsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.private_links = PrivateLinksOperations(self._client, self._config, self._serialize, self._deserialize)
def _send_request(
self, request: HttpRequest, *, stream: bool = False, **kwargs: Any
) -> Awaitable[AsyncHttpResponse]:
"""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 = await client._send_request(request)
<AsyncHttpResponse: 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.AsyncHttpResponse
"""
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
async def close(self) -> None:
await self._client.close()
async def __aenter__(self) -> "MongoClusterMgmtClient":
await self._client.__aenter__()
return self
async def __aexit__(self, *exc_details: Any) -> None:
await self._client.__aexit__(*exc_details)
|
class MongoClusterMgmtClient:
'''The Microsoft Azure management API provides create, read, update, and delete functionality for
Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.
:ivar operations: Operations operations
:vartype operations: azure.mgmt.mongocluster.aio.operations.Operations
:ivar mongo_clusters: MongoClustersOperations operations
:vartype mongo_clusters: azure.mgmt.mongocluster.aio.operations.MongoClustersOperations
:ivar firewall_rules: FirewallRulesOperations operations
:vartype firewall_rules: azure.mgmt.mongocluster.aio.operations.FirewallRulesOperations
:ivar private_endpoint_connections: PrivateEndpointConnectionsOperations operations
:vartype private_endpoint_connections:
azure.mgmt.mongocluster.aio.operations.PrivateEndpointConnectionsOperations
:ivar private_links: PrivateLinksOperations operations
:vartype private_links: azure.mgmt.mongocluster.aio.operations.PrivateLinksOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. 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 "2024-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: "AsyncTokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
) -> None:
pass
def _send_request(
self, request: HttpRequest, *, stream: bool = False, **kwargs: Any
) -> Awaitable[AsyncHttpResponse]:
'''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 = await client._send_request(request)
<AsyncHttpResponse: 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.AsyncHttpResponse
'''
pass
async def close(self) -> None:
pass
async def __aenter__(self) -> "MongoClusterMgmtClient":
pass
async def __aexit__(self, *exc_details: Any) -> None:
pass
| 6 | 2 | 14 | 1 | 11 | 3 | 1 | 0.74 | 0 | 12 | 8 | 0 | 5 | 9 | 5 | 5 | 103 | 11 | 54 | 26 | 40 | 40 | 27 | 18 | 21 | 3 | 0 | 1 | 7 |
10,784 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_notebook_workspaces_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._notebook_workspaces_operations.NotebookWorkspacesOperations
|
class NotebookWorkspacesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`notebook_workspaces` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_by_database_account(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.NotebookWorkspace"]:
"""Gets the notebook workspace resources of an existing Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either NotebookWorkspace or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.NotebookWorkspaceListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_database_account_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("NotebookWorkspaceListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> _models.NotebookWorkspace:
"""Gets the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: NotebookWorkspace or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.NotebookWorkspace
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.NotebookWorkspace] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("NotebookWorkspace", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_or_update_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: Union[_models.NotebookWorkspaceCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(notebook_create_update_parameters, (IOBase, bytes)):
_content = notebook_create_update_parameters
else:
_json = self._serialize.body(notebook_create_update_parameters, "NotebookWorkspaceCreateUpdateParameters")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: _models.NotebookWorkspaceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.NotebookWorkspace]:
"""Creates the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:param notebook_create_update_parameters: The notebook workspace to create for the current
database account. Required.
:type notebook_create_update_parameters:
~azure.mgmt.cosmosdb.models.NotebookWorkspaceCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either NotebookWorkspace or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.NotebookWorkspace]:
"""Creates the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:param notebook_create_update_parameters: The notebook workspace to create for the current
database account. Required.
:type notebook_create_update_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either NotebookWorkspace or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: Union[_models.NotebookWorkspaceCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.NotebookWorkspace]:
"""Creates the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:param notebook_create_update_parameters: The notebook workspace to create for the current
database account. Is either a NotebookWorkspaceCreateUpdateParameters type or a IO[bytes] type.
Required.
:type notebook_create_update_parameters:
~azure.mgmt.cosmosdb.models.NotebookWorkspaceCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either NotebookWorkspace or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.NotebookWorkspace] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
notebook_create_update_parameters=notebook_create_update_parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("NotebookWorkspace", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.NotebookWorkspace].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.NotebookWorkspace](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> LROPoller[None]:
"""Deletes the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
@distributed_trace
def list_connection_info(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> _models.NotebookWorkspaceConnectionInfoResult:
"""Retrieves the connection info for the notebook workspace.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: NotebookWorkspaceConnectionInfoResult or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.NotebookWorkspaceConnectionInfoResult
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.NotebookWorkspaceConnectionInfoResult] = kwargs.pop("cls", None)
_request = build_list_connection_info_request(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("NotebookWorkspaceConnectionInfoResult", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _regenerate_auth_token_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_regenerate_auth_token_request(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_regenerate_auth_token(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> LROPoller[None]:
"""Regenerates the auth token for the notebook workspace.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._regenerate_auth_token_initial(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore
def _start_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_start_request(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponseAutoGenerated, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_start(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> LROPoller[None]:
"""Starts the notebook workspace.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._start_initial(
resource_group_name=resource_group_name,
account_name=account_name,
notebook_workspace_name=notebook_workspace_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class NotebookWorkspacesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`notebook_workspaces` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_by_database_account(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.NotebookWorkspace"]:
'''Gets the notebook workspace resources of an existing Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either NotebookWorkspace or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_next(next_link=None):
'''Gets the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: NotebookWorkspace or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.NotebookWorkspace
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_or_update_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: Union[_models.NotebookWorkspaceCreateUpdateParameters, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: _models.NotebookWorkspaceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.NotebookWorkspace]:
'''Creates the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:param notebook_create_update_parameters: The notebook workspace to create for the current
database account. Required.
:type notebook_create_update_parameters:
~azure.mgmt.cosmosdb.models.NotebookWorkspaceCreateUpdateParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either NotebookWorkspace or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: _models.NotebookWorkspaceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.NotebookWorkspace]:
'''Creates the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:param notebook_create_update_parameters: The notebook workspace to create for the current
database account. Required.
:type notebook_create_update_parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either NotebookWorkspace or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
notebook_create_update_parameters: _models.NotebookWorkspaceCreateUpdateParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.NotebookWorkspace]:
'''Creates the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:param notebook_create_update_parameters: The notebook workspace to create for the current
database account. Is either a NotebookWorkspaceCreateUpdateParameters type or a IO[bytes] type.
Required.
:type notebook_create_update_parameters:
~azure.mgmt.cosmosdb.models.NotebookWorkspaceCreateUpdateParameters or IO[bytes]
:return: An instance of LROPoller that returns either NotebookWorkspace or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.NotebookWorkspace]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> LROPoller[None]:
'''Deletes the notebook workspace for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
@distributed_trace
def list_connection_info(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> _models.NotebookWorkspaceConnectionInfoResult:
'''Retrieves the connection info for the notebook workspace.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: NotebookWorkspaceConnectionInfoResult or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.NotebookWorkspaceConnectionInfoResult
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _regenerate_auth_token_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_regenerate_auth_token(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> LROPoller[None]:
'''Regenerates the auth token for the notebook workspace.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _start_initial(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_start(
self,
resource_group_name: str,
account_name: str,
notebook_workspace_name: Union[str, _models.NotebookWorkspaceName],
**kwargs: Any
) -> LROPoller[None]:
'''Starts the notebook workspace.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param notebook_workspace_name: The name of the notebook workspace resource. "default"
Required.
:type notebook_workspace_name: str or ~azure.mgmt.cosmosdb.models.NotebookWorkspaceName
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 31 | 10 | 40 | 4 | 29 | 9 | 3 | 0.33 | 0 | 8 | 0 | 0 | 14 | 4 | 14 | 14 | 804 | 103 | 558 | 245 | 445 | 182 | 283 | 154 | 261 | 5 | 0 | 2 | 65 |
10,785 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_partition_key_range_id_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._partition_key_range_id_operations.PartitionKeyRangeIdOperations
|
class PartitionKeyRangeIdOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`partition_key_range_id` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_metrics(
self,
resource_group_name: str,
account_name: str,
database_rid: str,
collection_rid: str,
partition_key_range_id: str,
filter: str,
**kwargs: Any
) -> Iterable["_models.PartitionMetric"]:
"""Retrieves the metrics determined by the given filter for the given partition key range id.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_rid: Cosmos DB database rid. Required.
:type database_rid: str
:param collection_rid: Cosmos DB collection rid. Required.
:type collection_rid: str
:param partition_key_range_id: Partition Key Range Id for which to get data. Required.
:type partition_key_range_id: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PartitionMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PartitionMetric]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PartitionMetricListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_metrics_request(
resource_group_name=resource_group_name,
account_name=account_name,
database_rid=database_rid,
collection_rid=collection_rid,
partition_key_range_id=partition_key_range_id,
subscription_id=self._config.subscription_id,
filter=filter,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PartitionMetricListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class PartitionKeyRangeIdOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`partition_key_range_id` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_metrics(
self,
resource_group_name: str,
account_name: str,
database_rid: str,
collection_rid: str,
partition_key_range_id: str,
filter: str,
**kwargs: Any
) -> Iterable["_models.PartitionMetric"]:
'''Retrieves the metrics determined by the given filter for the given partition key range id.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param database_rid: Cosmos DB database rid. Required.
:type database_rid: str
:param collection_rid: Cosmos DB collection rid. Required.
:type collection_rid: str
:param partition_key_range_id: Partition Key Range Id for which to get data. Required.
:type partition_key_range_id: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PartitionMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PartitionMetric]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 32 | 3 | 24 | 5 | 2 | 0.38 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 122 | 16 | 78 | 36 | 62 | 30 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,786 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_partition_key_range_id_region_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._partition_key_range_id_region_operations.PartitionKeyRangeIdRegionOperations
|
class PartitionKeyRangeIdRegionOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`partition_key_range_id_region` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_metrics(
self,
resource_group_name: str,
account_name: str,
region: str,
database_rid: str,
collection_rid: str,
partition_key_range_id: str,
filter: str,
**kwargs: Any
) -> Iterable["_models.PartitionMetric"]:
"""Retrieves the metrics determined by the given filter for the given partition key range id and
region.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param region: Cosmos DB region, with spaces between words and each word capitalized. Required.
:type region: str
:param database_rid: Cosmos DB database rid. Required.
:type database_rid: str
:param collection_rid: Cosmos DB collection rid. Required.
:type collection_rid: str
:param partition_key_range_id: Partition Key Range Id for which to get data. Required.
:type partition_key_range_id: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PartitionMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PartitionMetric]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PartitionMetricListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_metrics_request(
resource_group_name=resource_group_name,
account_name=account_name,
region=region,
database_rid=database_rid,
collection_rid=collection_rid,
partition_key_range_id=partition_key_range_id,
subscription_id=self._config.subscription_id,
filter=filter,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PartitionMetricListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class PartitionKeyRangeIdRegionOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`partition_key_range_id_region` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_metrics(
self,
resource_group_name: str,
account_name: str,
region: str,
database_rid: str,
collection_rid: str,
partition_key_range_id: str,
filter: str,
**kwargs: Any
) -> Iterable["_models.PartitionMetric"]:
'''Retrieves the metrics determined by the given filter for the given partition key range id and
region.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param region: Cosmos DB region, with spaces between words and each word capitalized. Required.
:type region: str
:param database_rid: Cosmos DB database rid. Required.
:type database_rid: str
:param collection_rid: Cosmos DB collection rid. Required.
:type collection_rid: str
:param partition_key_range_id: Partition Key Range Id for which to get data. Required.
:type partition_key_range_id: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PartitionMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PartitionMetric]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 33 | 3 | 25 | 6 | 2 | 0.41 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 127 | 16 | 80 | 37 | 63 | 33 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,787 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_percentile_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._percentile_operations.PercentileOperations
|
class PercentileOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`percentile` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_metrics(
self, resource_group_name: str, account_name: str, filter: str, **kwargs: Any
) -> Iterable["_models.PercentileMetric"]:
"""Retrieves the metrics determined by the given filter for the given database account. This url
is only for PBS and Replication Latency data.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PercentileMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PercentileMetric]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PercentileMetricListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_metrics_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
filter=filter,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PercentileMetricListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class PercentileOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`percentile` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_metrics(
self, resource_group_name: str, account_name: str, filter: str, **kwargs: Any
) -> Iterable["_models.PercentileMetric"]:
'''Retrieves the metrics determined by the given filter for the given database account. This url
is only for PBS and Replication Latency data.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PercentileMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PercentileMetric]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 29 | 3 | 22 | 4 | 2 | 0.37 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 107 | 16 | 68 | 29 | 59 | 25 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,788 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_percentile_source_target_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._percentile_source_target_operations.PercentileSourceTargetOperations
|
class PercentileSourceTargetOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`percentile_source_target` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_metrics(
self,
resource_group_name: str,
account_name: str,
source_region: str,
target_region: str,
filter: str,
**kwargs: Any
) -> Iterable["_models.PercentileMetric"]:
"""Retrieves the metrics determined by the given filter for the given account, source and target
region. This url is only for PBS and Replication Latency data.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param source_region: Source region from which data is written. Cosmos DB region, with spaces
between words and each word capitalized. Required.
:type source_region: str
:param target_region: Target region to which data is written. Cosmos DB region, with spaces
between words and each word capitalized. Required.
:type target_region: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PercentileMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PercentileMetric]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PercentileMetricListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_metrics_request(
resource_group_name=resource_group_name,
account_name=account_name,
source_region=source_region,
target_region=target_region,
subscription_id=self._config.subscription_id,
filter=filter,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PercentileMetricListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class PercentileSourceTargetOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`percentile_source_target` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_metrics(
self,
resource_group_name: str,
account_name: str,
source_region: str,
target_region: str,
filter: str,
**kwargs: Any
) -> Iterable["_models.PercentileMetric"]:
'''Retrieves the metrics determined by the given filter for the given account, source and target
region. This url is only for PBS and Replication Latency data.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param source_region: Source region from which data is written. Cosmos DB region, with spaces
between words and each word capitalized. Required.
:type source_region: str
:param target_region: Target region to which data is written. Cosmos DB region, with spaces
between words and each word capitalized. Required.
:type target_region: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PercentileMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PercentileMetric]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 32 | 3 | 24 | 5 | 2 | 0.41 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 121 | 16 | 76 | 35 | 61 | 31 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,789 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_percentile_target_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._percentile_target_operations.PercentileTargetOperations
|
class PercentileTargetOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`percentile_target` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_metrics(
self, resource_group_name: str, account_name: str, target_region: str, filter: str, **kwargs: Any
) -> Iterable["_models.PercentileMetric"]:
"""Retrieves the metrics determined by the given filter for the given account target region. This
url is only for PBS and Replication Latency data.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param target_region: Target region to which data is written. Cosmos DB region, with spaces
between words and each word capitalized. Required.
:type target_region: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PercentileMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PercentileMetric]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PercentileMetricListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_metrics_request(
resource_group_name=resource_group_name,
account_name=account_name,
target_region=target_region,
subscription_id=self._config.subscription_id,
filter=filter,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PercentileMetricListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class PercentileTargetOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`percentile_target` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_metrics(
self, resource_group_name: str, account_name: str, target_region: str, filter: str, **kwargs: Any
) -> Iterable["_models.PercentileMetric"]:
'''Retrieves the metrics determined by the given filter for the given account target region. This
url is only for PBS and Replication Latency data.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param target_region: Target region to which data is written. Cosmos DB region, with spaces
between words and each word capitalized. Required.
:type target_region: str
:param filter: An OData filter expression that describes a subset of metrics to return. The
parameters that can be filtered are name.value (name of the metric, can have an or of multiple
names), startTime, endTime, and timeGrain. The supported operator is eq. Required.
:type filter: str
:return: An iterator like instance of either PercentileMetric or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PercentileMetric]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 30 | 3 | 22 | 5 | 2 | 0.41 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 111 | 16 | 69 | 29 | 60 | 28 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,790 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_private_endpoint_connections_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._private_endpoint_connections_operations.PrivateEndpointConnectionsOperations
|
class PrivateEndpointConnectionsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`private_endpoint_connections` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_by_database_account(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.PrivateEndpointConnection"]:
"""List all private endpoint connections on a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either PrivateEndpointConnection or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PrivateEndpointConnectionListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_database_account_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PrivateEndpointConnectionListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get(
self, resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any
) -> _models.PrivateEndpointConnection:
"""Gets a private endpoint connection.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:return: PrivateEndpointConnection or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.PrivateEndpointConnection
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PrivateEndpointConnection] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
account_name=account_name,
private_endpoint_connection_name=private_endpoint_connection_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("PrivateEndpointConnection", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _create_or_update_initial(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: Union[_models.PrivateEndpointConnection, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(parameters, (IOBase, bytes)):
_content = parameters
else:
_json = self._serialize.body(parameters, "PrivateEndpointConnection")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
account_name=account_name,
private_endpoint_connection_name=private_endpoint_connection_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: _models.PrivateEndpointConnection,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PrivateEndpointConnection]:
"""Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:param parameters: Required.
:type parameters: ~azure.mgmt.cosmosdb.models.PrivateEndpointConnection
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PrivateEndpointConnection or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PrivateEndpointConnection]:
"""Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:param parameters: Required.
:type parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PrivateEndpointConnection or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: Union[_models.PrivateEndpointConnection, IO[bytes]],
**kwargs: Any
) -> LROPoller[_models.PrivateEndpointConnection]:
"""Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:param parameters: Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.
:type parameters: ~azure.mgmt.cosmosdb.models.PrivateEndpointConnection or IO[bytes]
:return: An instance of LROPoller that returns either PrivateEndpointConnection or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PrivateEndpointConnection] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
account_name=account_name,
private_endpoint_connection_name=private_endpoint_connection_name,
parameters=parameters,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("PrivateEndpointConnection", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.PrivateEndpointConnection].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.PrivateEndpointConnection](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
def _delete_initial(
self, resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
account_name=account_name,
private_endpoint_connection_name=private_endpoint_connection_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@distributed_trace
def begin_delete(
self, resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Deletes a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._delete_initial(
resource_group_name=resource_group_name,
account_name=account_name,
private_endpoint_connection_name=private_endpoint_connection_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class PrivateEndpointConnectionsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`private_endpoint_connections` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_by_database_account(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.PrivateEndpointConnection"]:
'''List all private endpoint connections on a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either PrivateEndpointConnection or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_next(next_link=None):
'''Gets a private endpoint connection.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:return: PrivateEndpointConnection or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.PrivateEndpointConnection
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def _create_or_update_initial(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: Union[_models.PrivateEndpointConnection, IO[bytes]],
**kwargs: Any
) -> Iterator[bytes]:
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: _models.PrivateEndpointConnection,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PrivateEndpointConnection]:
'''Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:param parameters: Required.
:type parameters: ~azure.mgmt.cosmosdb.models.PrivateEndpointConnection
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PrivateEndpointConnection or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: _models.PrivateEndpointConnection,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PrivateEndpointConnection]:
'''Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:param parameters: Required.
:type parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either PrivateEndpointConnection or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
account_name: str,
private_endpoint_connection_name: str,
parameters: _models.PrivateEndpointConnection,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.PrivateEndpointConnection]:
'''Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:param parameters: Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.
:type parameters: ~azure.mgmt.cosmosdb.models.PrivateEndpointConnection or IO[bytes]
:return: An instance of LROPoller that returns either PrivateEndpointConnection or the result
of cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.cosmosdb.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
def _delete_initial(
self, resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any
) -> Iterator[bytes]:
pass
@distributed_trace
def begin_delete(
self, resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any
) -> LROPoller[None]:
'''Deletes a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection. Required.
:type private_endpoint_connection_name: str
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 21 | 7 | 36 | 4 | 26 | 8 | 3 | 0.36 | 0 | 8 | 0 | 0 | 9 | 4 | 9 | 9 | 476 | 62 | 320 | 138 | 259 | 114 | 167 | 92 | 152 | 5 | 0 | 2 | 40 |
10,791 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_private_link_resources_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._private_link_resources_operations.PrivateLinkResourcesOperations
|
class PrivateLinkResourcesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`private_link_resources` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_by_database_account(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.PrivateLinkResource"]:
"""Gets the private link resources that need to be created for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either PrivateLinkResource or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PrivateLinkResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PrivateLinkResourceListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_database_account_request(
resource_group_name=resource_group_name,
account_name=account_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PrivateLinkResourceListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get(
self, resource_group_name: str, account_name: str, group_name: str, **kwargs: Any
) -> _models.PrivateLinkResource:
"""Gets the private link resources that need to be created for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param group_name: The name of the private link resource. Required.
:type group_name: str
:return: PrivateLinkResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.PrivateLinkResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PrivateLinkResource] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
account_name=account_name,
group_name=group_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("PrivateLinkResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
|
class PrivateLinkResourcesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`private_link_resources` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_by_database_account(
self, resource_group_name: str, account_name: str, **kwargs: Any
) -> Iterable["_models.PrivateLinkResource"]:
'''Gets the private link resources that need to be created for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:return: An iterator like instance of either PrivateLinkResource or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.PrivateLinkResource]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_next(next_link=None):
'''Gets the private link resources that need to be created for a Cosmos DB account.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param account_name: Cosmos DB database account name. Required.
:type account_name: str
:param group_name: The name of the private link resource. Required.
:type group_name: str
:return: PrivateLinkResource or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.PrivateLinkResource
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
| 9 | 3 | 32 | 5 | 24 | 5 | 3 | 0.34 | 0 | 4 | 0 | 0 | 3 | 4 | 3 | 3 | 161 | 27 | 104 | 43 | 91 | 35 | 61 | 37 | 54 | 5 | 0 | 1 | 15 |
10,792 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_restorable_database_accounts_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._restorable_database_accounts_operations.RestorableDatabaseAccountsOperations
|
class RestorableDatabaseAccountsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_database_accounts` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_by_location(self, location: str, **kwargs: Any) -> Iterable["_models.RestorableDatabaseAccountGetResult"]:
"""Lists all the restorable Azure Cosmos DB database accounts available under the subscription and
in a region. This call requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:return: An iterator like instance of either RestorableDatabaseAccountGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableDatabaseAccountsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_location_request(
location=location,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableDatabaseAccountsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.RestorableDatabaseAccountGetResult"]:
"""Lists all the restorable Azure Cosmos DB database accounts available under the subscription.
This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
:return: An iterator like instance of either RestorableDatabaseAccountGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableDatabaseAccountsListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("RestorableDatabaseAccountsListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
@distributed_trace
def get_by_location(
self, location: str, instance_id: str, **kwargs: Any
) -> _models.RestorableDatabaseAccountGetResult:
"""Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: RestorableDatabaseAccountGetResult or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.RestorableDatabaseAccountGetResult] = kwargs.pop("cls", None)
_request = build_get_by_location_request(
location=location,
instance_id=instance_id,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("RestorableDatabaseAccountGetResult", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
|
class RestorableDatabaseAccountsOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`restorable_database_accounts` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list_by_location(self, location: str, **kwargs: Any) -> Iterable["_models.RestorableDatabaseAccountGetResult"]:
'''Lists all the restorable Azure Cosmos DB database accounts available under the subscription and
in a region. This call requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:return: An iterator like instance of either RestorableDatabaseAccountGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def list_by_location(self, location: str, **kwargs: Any) -> Iterable["_models.RestorableDatabaseAccountGetResult"]:
'''Lists all the restorable Azure Cosmos DB database accounts available under the subscription.
This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.
:return: An iterator like instance of either RestorableDatabaseAccountGetResult or the result
of cls(response)
:rtype:
~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
@distributed_trace
def get_by_location(
self, location: str, instance_id: str, **kwargs: Any
) -> _models.RestorableDatabaseAccountGetResult:
'''Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call
requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.
:param location: Cosmos DB region, with spaces between words and each word capitalized.
Required.
:type location: str
:param instance_id: The instanceId GUID of a restorable database account. Required.
:type instance_id: str
:return: RestorableDatabaseAccountGetResult or the result of cls(response)
:rtype: ~azure.mgmt.cosmosdb.models.RestorableDatabaseAccountGetResult
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
| 14 | 4 | 31 | 4 | 23 | 5 | 2 | 0.3 | 0 | 4 | 0 | 0 | 4 | 4 | 4 | 4 | 235 | 40 | 155 | 60 | 139 | 47 | 95 | 55 | 84 | 5 | 0 | 1 | 22 |
10,793 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_cosmosdb/operations/_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_cosmosdb.operations._operations.Operations
|
class Operations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`operations` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.Operation"]:
"""Lists all of the available Cosmos DB Resource Provider operations.
:return: An iterator like instance of either Operation or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.Operation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.OperationListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("OperationListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
|
class Operations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.cosmosdb.CosmosDBManagementClient`'s
:attr:`operations` attribute.
'''
def __init__(self, *args, **kwargs):
pass
@distributed_trace
def list(self, **kwargs: Any) -> Iterable["_models.Operation"]:
'''Lists all of the available Cosmos DB Resource Provider operations.
:return: An iterator like instance of either Operation or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.cosmosdb.models.Operation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
def extract_data(pipeline_response):
pass
def get_next(next_link=None):
pass
| 7 | 2 | 25 | 3 | 20 | 2 | 2 | 0.24 | 0 | 4 | 0 | 0 | 2 | 4 | 2 | 2 | 91 | 16 | 62 | 27 | 55 | 15 | 42 | 26 | 36 | 5 | 0 | 1 | 12 |
10,794 |
Azure/azure-cli-extensions
|
src/costmanagement/azext_costmanagement/vendored_sdks/costmanagement/models/_models.py
|
azext_costmanagement.vendored_sdks.costmanagement.models._models.PivotProperties
|
class PivotProperties(msrest.serialization.Model):
"""Each pivot must contain a 'type' and 'name'.
:param type: Data type to show in view. Possible values include: "Dimension", "TagKey".
:type type: str or ~azure.mgmt.costmanagement.models.PivotType
:param name: Data field to show in view.
:type name: str
"""
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
}
def __init__(
self,
**kwargs
):
super(PivotProperties, self).__init__(**kwargs)
self.type = kwargs.get('type', None)
self.name = kwargs.get('name', None)
|
class PivotProperties(msrest.serialization.Model):
'''Each pivot must contain a 'type' and 'name'.
:param type: Data type to show in view. Possible values include: "Dimension", "TagKey".
:type type: str or ~azure.mgmt.costmanagement.models.PivotType
:param name: Data field to show in view.
:type name: str
'''
def __init__(
self,
**kwargs
):
pass
| 2 | 1 | 7 | 0 | 7 | 0 | 1 | 0.5 | 1 | 1 | 0 | 0 | 1 | 2 | 1 | 1 | 21 | 3 | 12 | 8 | 7 | 6 | 6 | 5 | 4 | 1 | 1 | 0 | 1 |
10,795 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/aio/operations/_firewall_rules_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.aio.operations._firewall_rules_operations.FirewallRulesOperations
|
class FirewallRulesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s
:attr:`firewall_rules` attribute.
"""
models = _models
def __init__(self, *args, **kwargs) -> None:
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list_by_mongo_cluster(
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> AsyncIterable["_models.FirewallRule"]:
"""List all the firewall rules in a given mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: An iterator like instance of either FirewallRule or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.FirewallRuleListResult] = kwargs.pop("cls", None)
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_mongo_cluster_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
async def extract_data(pipeline_response):
deserialized = self._deserialize("FirewallRuleListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, AsyncList(list_of_elem)
async def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)
@distributed_trace_async
async def get(
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> _models.FirewallRule:
"""Gets information about a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: FirewallRule or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.FirewallRule
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.FirewallRule] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = self._deserialize("FirewallRule", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
async def _create_or_update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: Union[_models.FirewallRule, IO[bytes]],
**kwargs: Any
) -> Optional[_models.FirewallRule]:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Optional[_models.FirewallRule]] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(resource, (IOBase, bytes)):
_content = resource
else:
_json = self._serialize.body(resource, "FirewallRule")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201, 202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
deserialized = None
response_headers = {}
if response.status_code == 200:
deserialized = self._deserialize("FirewallRule", pipeline_response)
if response.status_code == 201:
deserialized = self._deserialize("FirewallRule", pipeline_response)
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.FirewallRule]:
"""Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: IO[bytes],
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.FirewallRule]:
"""Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@distributed_trace_async
async def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: Union[_models.FirewallRule, IO[bytes]],
**kwargs: Any
) -> AsyncLROPoller[_models.FirewallRule]:
"""Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Is either a FirewallRule type or a IO[bytes] type.
Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule or IO[bytes]
:return: An instance of AsyncLROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.FirewallRule] = kwargs.pop("cls", None)
polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = await self._create_or_update_initial(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
resource=resource,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("FirewallRule", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: AsyncPollingMethod = cast(
AsyncPollingMethod,
AsyncARMPolling(lro_delay, lro_options={"final-state-via": "azure-async-operation"}, **kwargs),
)
elif polling is False:
polling_method = cast(AsyncPollingMethod, AsyncNoPolling())
else:
polling_method = polling
if cont_token:
return AsyncLROPoller[_models.FirewallRule].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return AsyncLROPoller[_models.FirewallRule](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
async def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> None:
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After"))
if cls:
return cls(pipeline_response, None, response_headers) # type: ignore
@distributed_trace_async
async def begin_delete(
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> AsyncLROPoller[None]:
"""Deletes a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = await self._delete_initial( # type: ignore
resource_group_name=resource_group_name,
mongo_cluster_name=mongo_cluster_name,
firewall_rule_name=firewall_rule_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {}) # type: ignore
if polling is True:
polling_method: AsyncPollingMethod = cast(
AsyncPollingMethod, AsyncARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(AsyncPollingMethod, AsyncNoPolling())
else:
polling_method = polling
if cont_token:
return AsyncLROPoller[None].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method)
|
class FirewallRulesOperations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s
:attr:`firewall_rules` attribute.
'''
def __init__(self, *args, **kwargs) -> None:
pass
@distributed_trace
def list_by_mongo_cluster(
self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any
) -> AsyncIterable["_models.FirewallRule"]:
'''List all the firewall rules in a given mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:return: An iterator like instance of either FirewallRule or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
async def extract_data(pipeline_response):
pass
async def get_next(next_link=None):
pass
@distributed_trace_async
async def get_next(next_link=None):
'''Gets information about a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: FirewallRule or the result of cls(response)
:rtype: ~azure.mgmt.mongocluster.models.FirewallRule
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
async def _create_or_update_initial(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: Union[_models.FirewallRule, IO[bytes]],
**kwargs: Any
) -> Optional[_models.FirewallRule]:
pass
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.FirewallRule]:
'''Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@overload
async def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.FirewallRule]:
'''Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Required.
:type resource: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of AsyncLROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
@distributed_trace_async
async def begin_create_or_update(
self,
resource_group_name: str,
mongo_cluster_name: str,
firewall_rule_name: str,
resource: _models.FirewallRule,
*,
content_type: str = "application/json",
**kwargs: Any
) -> AsyncLROPoller[_models.FirewallRule]:
'''Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:param resource: Resource create parameters. Is either a FirewallRule type or a IO[bytes] type.
Required.
:type resource: ~azure.mgmt.mongocluster.models.FirewallRule or IO[bytes]
:return: An instance of AsyncLROPoller that returns either FirewallRule or the result of
cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.mgmt.mongocluster.models.FirewallRule]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
async def _delete_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> None:
pass
@distributed_trace_async
async def begin_delete(
self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any
) -> AsyncLROPoller[None]:
'''Deletes a mongo cluster firewall rule.
:param resource_group_name: The name of the resource group. The name is case insensitive.
Required.
:type resource_group_name: str
:param mongo_cluster_name: The name of the mongo cluster. Required.
:type mongo_cluster_name: str
:param firewall_rule_name: The name of the mongo cluster firewall rule. Required.
:type firewall_rule_name: str
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def get_long_running_output(pipeline_response):
pass
| 21 | 7 | 37 | 4 | 27 | 8 | 3 | 0.34 | 0 | 9 | 0 | 0 | 9 | 4 | 9 | 9 | 487 | 63 | 330 | 139 | 269 | 111 | 172 | 93 | 157 | 7 | 0 | 1 | 42 |
10,796 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/aio/operations/_operations.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.aio.operations._operations.Operations
|
class Operations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s
:attr:`operations` attribute.
"""
models = _models
def __init__(self, *args, **kwargs) -> None:
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
@distributed_trace
def list(self, **kwargs: Any) -> AsyncIterable["_models.Operation"]:
"""List the operations for the provider.
:return: An iterator like instance of either Operation or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.Operation]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.OperationListResult] = kwargs.pop("cls", None)
error_map: MutableMapping[int, Type[HttpResponseError]] = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_request(
api_version=api_version,
headers=_headers,
params=_params,
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request = _convert_request(_request)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
async def extract_data(pipeline_response):
deserialized = self._deserialize("OperationListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, AsyncList(list_of_elem)
async def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.ErrorResponse, pipeline_response)
raise HttpResponseError(response=response, model=error, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)
|
class Operations:
'''
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.mongocluster.aio.MongoClusterMgmtClient`'s
:attr:`operations` attribute.
'''
def __init__(self, *args, **kwargs) -> None:
pass
@distributed_trace
def list(self, **kwargs: Any) -> AsyncIterable["_models.Operation"]:
'''List the operations for the provider.
:return: An iterator like instance of either Operation or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.Operation]
:raises ~azure.core.exceptions.HttpResponseError:
'''
pass
def prepare_request(next_link=None):
pass
async def extract_data(pipeline_response):
pass
async def get_next(next_link=None):
pass
| 7 | 2 | 26 | 3 | 21 | 2 | 2 | 0.23 | 0 | 5 | 0 | 0 | 2 | 4 | 2 | 2 | 94 | 16 | 65 | 28 | 58 | 15 | 45 | 27 | 39 | 5 | 0 | 1 | 12 |
10,797 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/models/_models_py3.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.models._models_py3.PrivateEndpoint
|
class PrivateEndpoint(_serialization.Model):
"""The private endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The ARM identifier for private endpoint.
:vartype id: str
"""
_validation = {
"id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
|
class PrivateEndpoint(_serialization.Model):
'''The private endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The ARM identifier for private endpoint.
:vartype id: str
'''
def __init__(self, **kwargs: Any) -> None:
''' '''
pass
| 2 | 2 | 4 | 0 | 3 | 1 | 1 | 0.6 | 1 | 2 | 0 | 0 | 1 | 1 | 1 | 16 | 21 | 5 | 10 | 5 | 8 | 6 | 6 | 5 | 4 | 1 | 2 | 0 | 1 |
10,798 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/models/_models_py3.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.models._models_py3.PrivateEndpointConnectionProperties
|
class PrivateEndpointConnectionProperties(_serialization.Model):
"""Properties of the private endpoint connection.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar group_ids: The group ids for the private endpoint resource.
:vartype group_ids: list[str]
:ivar private_endpoint: The private endpoint resource.
:vartype private_endpoint: ~azure.mgmt.mongocluster.models.PrivateEndpoint
:ivar private_link_service_connection_state: A collection of information about the state of the
connection between service consumer and provider. Required.
:vartype private_link_service_connection_state:
~azure.mgmt.mongocluster.models.PrivateLinkServiceConnectionState
:ivar provisioning_state: The provisioning state of the private endpoint connection resource.
Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
:vartype provisioning_state: str or
~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProvisioningState
"""
_validation = {
"group_ids": {"readonly": True},
"private_link_service_connection_state": {"required": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"group_ids": {"key": "groupIds", "type": "[str]"},
"private_endpoint": {"key": "privateEndpoint", "type": "PrivateEndpoint"},
"private_link_service_connection_state": {
"key": "privateLinkServiceConnectionState",
"type": "PrivateLinkServiceConnectionState",
},
"provisioning_state": {"key": "provisioningState", "type": "str"},
}
def __init__(
self,
*,
private_link_service_connection_state: "_models.PrivateLinkServiceConnectionState",
private_endpoint: Optional["_models.PrivateEndpoint"] = None,
**kwargs: Any
) -> None:
"""
:keyword private_endpoint: The private endpoint resource.
:paramtype private_endpoint: ~azure.mgmt.mongocluster.models.PrivateEndpoint
:keyword private_link_service_connection_state: A collection of information about the state of
the connection between service consumer and provider. Required.
:paramtype private_link_service_connection_state:
~azure.mgmt.mongocluster.models.PrivateLinkServiceConnectionState
"""
super().__init__(**kwargs)
self.group_ids = None
self.private_endpoint = private_endpoint
self.private_link_service_connection_state = private_link_service_connection_state
self.provisioning_state = None
|
class PrivateEndpointConnectionProperties(_serialization.Model):
'''Properties of the private endpoint connection.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar group_ids: The group ids for the private endpoint resource.
:vartype group_ids: list[str]
:ivar private_endpoint: The private endpoint resource.
:vartype private_endpoint: ~azure.mgmt.mongocluster.models.PrivateEndpoint
:ivar private_link_service_connection_state: A collection of information about the state of the
connection between service consumer and provider. Required.
:vartype private_link_service_connection_state:
~azure.mgmt.mongocluster.models.PrivateLinkServiceConnectionState
:ivar provisioning_state: The provisioning state of the private endpoint connection resource.
Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
:vartype provisioning_state: str or
~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProvisioningState
'''
def __init__(
self,
*,
private_link_service_connection_state: "_models.PrivateLinkServiceConnectionState",
private_endpoint: Optional["_models.PrivateEndpoint"] = None,
**kwargs: Any
) -> None:
'''
:keyword private_endpoint: The private endpoint resource.
:paramtype private_endpoint: ~azure.mgmt.mongocluster.models.PrivateEndpoint
:keyword private_link_service_connection_state: A collection of information about the state of
the connection between service consumer and provider. Required.
:paramtype private_link_service_connection_state:
~azure.mgmt.mongocluster.models.PrivateLinkServiceConnectionState
'''
pass
| 2 | 2 | 20 | 0 | 12 | 8 | 1 | 0.89 | 1 | 2 | 0 | 0 | 1 | 4 | 1 | 16 | 57 | 6 | 27 | 14 | 19 | 24 | 9 | 8 | 7 | 1 | 2 | 0 | 1 |
10,799 |
Azure/azure-cli-extensions
|
src/cosmosdb-preview/azext_cosmosdb_preview/vendored_sdks/azure_mgmt_mongocluster/models/_models_py3.py
|
azext_cosmosdb_preview.vendored_sdks.azure_mgmt_mongocluster.models._models_py3.PrivateEndpointConnectionResource
|
class PrivateEndpointConnectionResource(ProxyResource):
"""Concrete proxy resource types can be created by aliasing this type using a specific property
type.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.mongocluster.models.SystemData
:ivar properties: The resource-specific properties for this resource.
:vartype properties: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProperties
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"properties": {"key": "properties", "type": "PrivateEndpointConnectionProperties"},
}
def __init__(
self, *, properties: Optional["_models.PrivateEndpointConnectionProperties"] = None, **kwargs: Any
) -> None:
"""
:keyword properties: The resource-specific properties for this resource.
:paramtype properties: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProperties
"""
super().__init__(**kwargs)
self.properties = properties
|
class PrivateEndpointConnectionResource(ProxyResource):
'''Concrete proxy resource types can be created by aliasing this type using a specific property
type.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.mongocluster.models.SystemData
:ivar properties: The resource-specific properties for this resource.
:vartype properties: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProperties
'''
def __init__(
self, *, properties: Optional["_models.PrivateEndpointConnectionProperties"] = None, **kwargs: Any
) -> None:
'''
:keyword properties: The resource-specific properties for this resource.
:paramtype properties: ~azure.mgmt.mongocluster.models.PrivateEndpointConnectionProperties
'''
pass
| 2 | 2 | 9 | 0 | 5 | 4 | 1 | 1.11 | 1 | 2 | 0 | 0 | 1 | 1 | 1 | 17 | 45 | 5 | 19 | 7 | 15 | 21 | 6 | 5 | 4 | 1 | 4 | 0 | 1 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.