Share via

DomainsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:domains> attribute.

Inheritance
builtins.object
DomainsOperations

Constructor

DomainsOperations(*args, **kwargs)

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: _models.Domain, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Domain]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
domain_name
Required
str

Name of the domain. Required.
domain_info
Required
Domain or IO[bytes]

Domain information. Is either a Domain type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Domain]

An instance of LROPoller that returns either Domain or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a domain.

Delete existing domain.

begin_delete(resource_group_name: str, domain_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
domain_name
Required
str

Name of the domain. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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: _models.DomainUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Domain]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
domain_name
Required
str

Name of the domain. Required.
domain_update_parameters
Required
DomainUpdateParameters or IO[bytes]

Domain update information. Is either a DomainUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Domain]

An instance of LROPoller that returns either Domain or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a domain.

Get properties of a domain.

get(resource_group_name: str, domain_name: str, **kwargs: Any) -> Domain

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
domain_name
Required
str

Name of the domain. Required.

Returns

Type Description
Domain

Domain or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[Domain]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
filter
Required
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
Required
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.

Returns

Type Description
ItemPaged[Domain]

An iterator like instance of either Domain or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_subscription

List domains under an Azure subscription.

List all the domains under an Azure subscription.

list_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[Domain]

Parameters

Name Description
filter
Required
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
Required
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.

Returns

Type Description
ItemPaged[Domain]

An iterator like instance of either Domain or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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) -> DomainSharedAccessKeys

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
domain_name
Required
str

Name of the domain. Required.

Returns

Type Description
DomainSharedAccessKeys

DomainSharedAccessKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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: _models.DomainRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainSharedAccessKeys

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
domain_name
Required
str

Name of the domain. Required.
regenerate_key_request
Required
DomainRegenerateKeyRequest or IO[bytes]

Request body to regenerate key. Is either a DomainRegenerateKeyRequest type or a IO[bytes] type. Required.

Returns

Type Description
DomainSharedAccessKeys

DomainSharedAccessKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>