ServicesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:services> attribute.
- Inheritance
-
builtins.objectServicesOperations
Constructor
ServicesOperations(*args, **kwargs)
Methods
begin_create_or_update |
Create a new Service or update an exiting Service. |
begin_delete |
Operation to delete a Service. |
begin_update |
Operation to update an exiting Service. |
check_name_availability |
Checks that the resource name is valid and is not already in use. |
disable_test_endpoint |
Disable test endpoint functionality for a Service. |
enable_test_endpoint |
Enable test endpoint functionality for a Service. |
get |
Get a Service and its properties. |
list |
Handles requests to list all resources in a resource group. |
list_by_subscription |
Handles requests to list all resources in a subscription. |
list_test_keys |
List test keys for a Service. |
regenerate_test_key |
Regenerate a test key for a Service. |
begin_create_or_update
Create a new Service or update an exiting Service.
begin_create_or_update(resource_group_name: str, service_name: str, resource: _models.ServiceResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServiceResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
resource
Required
|
Parameters for the create or update operation. Is either a ServiceResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either ServiceResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Operation to delete a Service.
begin_delete(resource_group_name: str, service_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update
Operation to update an exiting Service.
begin_update(resource_group_name: str, service_name: str, resource: _models.ServiceResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServiceResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
resource
Required
|
Parameters for the update operation. Is either a ServiceResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either ServiceResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
check_name_availability
Checks that the resource name is valid and is not already in use.
check_name_availability(location: str, availability_parameters: _models.NameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NameAvailability
Parameters
Name | Description |
---|---|
location
Required
|
the region. Required. |
availability_parameters
Required
|
Parameters supplied to the operation. Is either a NameAvailabilityParameters type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
NameAvailability or the result of cls(response) |
Exceptions
Type | Description |
---|---|
disable_test_endpoint
Disable test endpoint functionality for a Service.
disable_test_endpoint(resource_group_name: str, service_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
enable_test_endpoint
Enable test endpoint functionality for a Service.
enable_test_endpoint(resource_group_name: str, service_name: str, **kwargs: Any) -> TestKeys
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
Returns
Type | Description |
---|---|
TestKeys or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Get a Service and its properties.
get(resource_group_name: str, service_name: str, **kwargs: Any) -> ServiceResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
Returns
Type | Description |
---|---|
ServiceResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
Handles requests to list all resources in a resource group.
list(resource_group_name: str, **kwargs: Any) -> Iterable[ServiceResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
Returns
Type | Description |
---|---|
An iterator like instance of either ServiceResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_subscription
Handles requests to list all resources in a subscription.
list_by_subscription(**kwargs: Any) -> Iterable[ServiceResource]
Returns
Type | Description |
---|---|
An iterator like instance of either ServiceResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_test_keys
List test keys for a Service.
list_test_keys(resource_group_name: str, service_name: str, **kwargs: Any) -> TestKeys
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
Returns
Type | Description |
---|---|
TestKeys or the result of cls(response) |
Exceptions
Type | Description |
---|---|
regenerate_test_key
Regenerate a test key for a Service.
regenerate_test_key(resource_group_name: str, service_name: str, regenerate_test_key_request: _models.RegenerateTestKeyRequestPayload, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestKeys
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
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. |
service_name
Required
|
The name of the Service resource. Required. |
regenerate_test_key_request
Required
|
Parameters for the operation. Is either a RegenerateTestKeyRequestPayload type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
TestKeys or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.appplatform.v2020_11_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\appplatform\\v2020_11_01_preview\\models\\__init__.py'>
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for