ApiPortalsOperations Class
ApiPortalsOperations 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.
- Inheritance
-
builtins.objectApiPortalsOperations
Constructor
ApiPortalsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create_or_update |
Create the default API portal or update the existing API portal. |
| begin_delete |
Delete the default API portal. |
| get |
Get the API portal and its properties. |
| list |
Handles requests to list all resources in a Service. |
| validate_domain |
Check the domains are valid as well as not in use. |
begin_create_or_update
Create the default API portal or update the existing API portal.
async begin_create_or_update(resource_group_name: str, service_name: str, api_portal_name: str, api_portal_resource: azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.ApiPortalResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.ApiPortalResource]Parameters
- resource_group_name
- str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either ApiPortalResource or the result of cls(response)
Return type
Exceptions
begin_delete
Delete the default API portal.
async begin_delete(resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- resource_group_name
- str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
get
Get the API portal and its properties.
async get(resource_group_name: str, service_name: str, api_portal_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.ApiPortalResourceParameters
- resource_group_name
- str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ApiPortalResource, or the result of cls(response)
Return type
Exceptions
list
Handles requests to list all resources in a Service.
list(resource_group_name: str, service_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.ApiPortalResourceCollection]Parameters
- resource_group_name
- str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ApiPortalResourceCollection or the result of cls(response)
Return type
Exceptions
validate_domain
Check the domains are valid as well as not in use.
async validate_domain(resource_group_name: str, service_name: str, api_portal_name: str, validate_payload: azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.CustomDomainValidatePayload, **kwargs: Any) -> azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.CustomDomainValidateResultParameters
- resource_group_name
- str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CustomDomainValidateResult, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.appplatform.v2022_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\appplatform\\v2022_01_01_preview\\models\\__init__.py'>Feedback
Submit and view feedback for