DomainsOperations Class
DomainsOperations 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.objectDomainsOperations
Constructor
DomainsOperations(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 or update a domain. Asynchronously creates or updates a new domain with the specified parameters. |
| begin_delete |
Delete a domain. Delete existing domain. |
| begin_update |
Update a domain. Asynchronously updates a domain with the specified parameters. |
| get |
Get a domain. Get properties of a domain. |
| list_by_resource_group |
List domains under a resource group. List all the domains under a resource group. |
| list_by_subscription |
List domains under an Azure subscription. List all the domains under an Azure subscription. |
| list_shared_access_keys |
List keys for a domain. List the two keys used to publish to a domain. |
| regenerate_key |
Regenerate key for a domain. Regenerate a shared access key for a domain. |
begin_create_or_update
Create or update a domain.
Asynchronously creates or updates a new domain with the specified parameters.
begin_create_or_update(resource_group_name: str, domain_name: str, domain_info: azure.mgmt.eventgrid.models._models_py3.Domain, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventgrid.models._models_py3.Domain]Parameters
- 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 PollingMethod
By default, your polling method will be ARMPolling. 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 LROPoller that returns either Domain or the result of cls(response)
Return type
Exceptions
begin_delete
Delete a domain.
Delete existing domain.
begin_delete(resource_group_name: str, domain_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- 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 PollingMethod
By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Update a domain.
Asynchronously updates a domain with the specified parameters.
begin_update(resource_group_name: str, domain_name: str, domain_update_parameters: azure.mgmt.eventgrid.models._models_py3.DomainUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventgrid.models._models_py3.Domain]Parameters
- 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 PollingMethod
By default, your polling method will be ARMPolling. 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 LROPoller that returns either Domain or the result of cls(response)
Return type
Exceptions
get
Get a domain.
Get properties of a domain.
get(resource_group_name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.eventgrid.models._models_py3.DomainParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Domain, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
List domains under a resource group.
List all the domains under a resource group.
list_by_resource_group(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.DomainsListResult]Parameters
- filter
- str
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
- top
- int
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DomainsListResult or the result of cls(response)
Return type
Exceptions
list_by_subscription
List domains under an Azure subscription.
List all the domains under an Azure subscription.
list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.DomainsListResult]Parameters
- filter
- str
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
- top
- int
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DomainsListResult or the result of cls(response)
Return type
Exceptions
list_shared_access_keys
List keys for a domain.
List the two keys used to publish to a domain.
list_shared_access_keys(resource_group_name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.eventgrid.models._models_py3.DomainSharedAccessKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DomainSharedAccessKeys, or the result of cls(response)
Return type
Exceptions
regenerate_key
Regenerate key for a domain.
Regenerate a shared access key for a domain.
regenerate_key(resource_group_name: str, domain_name: str, regenerate_key_request: azure.mgmt.eventgrid.models._models_py3.DomainRegenerateKeyRequest, **kwargs: Any) -> azure.mgmt.eventgrid.models._models_py3.DomainSharedAccessKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DomainSharedAccessKeys, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>Feedback
Submit and view feedback for