azure.mgmt.eventgrid.operations module¶

Raises

create_or_update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_info: _models.Channel, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Channel[source]¶

create_or_update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Channel

Create or update a channel.

Synchronously creates or updates a new channel with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the partners subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
channel_name (str) – Name of the channel. Required.
channel_info (Channel or IO) – Channel information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Channel or the result of cls(response)

Return type

Channel

Raises

get(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.Channel[source]¶

Get a channel.

Get properties of a channel.

Parameters

resource_group_name (str) – The name of the resource group within the partners subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
channel_name (str) – Name of the channel. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Channel or the result of cls(response)

Return type

Channel

Raises

get_full_url(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of partner destination channel.

Get the full endpoint URL of a partner destination channel.

Parameters

resource_group_name (str) – The name of the resource group within the partners subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
channel_name (str) – Name of the Channel. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list_by_partner_namespace(resource_group_name: str, partner_namespace_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.Channel][source]¶

List channels.

List all the channels in a partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the partners subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Channel]

Raises

update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_update_parameters: _models.ChannelUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → None [source]¶

update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Update a Channel.

Synchronously updates a channel with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the partners subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
channel_name (str) – Name of the channel. Required.
channel_update_parameters (ChannelUpdateParameters or IO) – Channel update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.DomainEventSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s domain_event_subscriptions attribute.

begin_create_or_update(resource_group_name: str, domain_name: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_create_or_update(resource_group_name: str, domain_name: str, event_subscription_name: str, event_subscription_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Create or update an event subscription to a domain.

Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_info (EventSubscription or IO) – Event subscription properties containing the destination and filter information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, domain_name: str, event_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete an event subscription for a domain.

Delete an existing event subscription for a domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
event_subscription_name (str) – Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, domain_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_update(resource_group_name: str, domain_name: str, event_subscription_name: str, event_subscription_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Update an event subscription for a domain.

Update an existing event subscription for a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
event_subscription_name (str) – Name of the event subscription to be updated. Required.
event_subscription_update_parameters (EventSubscriptionUpdateParameters or IO) – Updated event subscription information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

get(resource_group_name: str, domain_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscription[source]¶

Get an event subscription of a domain.

Get properties of an event subscription of a domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscription or the result of cls(response)

Return type

Raises

get_delivery_attributes(resource_group_name: str, domain_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult[source]¶

Get delivery attributes for an event subscription for domain.

Get all delivery attributes for an event subscription for domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult or the result of cls(response)

Return type

Raises

get_full_url(resource_group_name: str, domain_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of an event subscription for domain.

Get the full endpoint URL for an event subscription for domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list(resource_group_name: str, domain_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all event subscriptions for a specific domain.

List all event subscriptions that have been created for a specific topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.DomainTopicEventSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s domain_topic_event_subscriptions attribute.

begin_create_or_update(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_create_or_update(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, event_subscription_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Create or update a nested event subscription to a domain topic.

Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_info (EventSubscription or IO) – Event subscription properties containing the destination and filter information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a nested event subscription for a domain topic.

Delete a nested existing event subscription for a domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_update(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, event_subscription_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Update a nested event subscription for a domain topic.

Update an existing event subscription for a domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
topic_name (str) – Name of the topic. Required.
event_subscription_name (str) – Name of the event subscription to be updated. Required.
event_subscription_update_parameters (EventSubscriptionUpdateParameters or IO) – Updated event subscription information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

get(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscription[source]¶

Get a nested event subscription for domain topic.

Get properties of a nested event subscription for a domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscription or the result of cls(response)

Return type

Raises

get_delivery_attributes(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult[source]¶

Get delivery attributes for an event subscription for domain topic.

Get all delivery attributes for an event subscription for domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult or the result of cls(response)

Return type

Raises

get_full_url(resource_group_name: str, domain_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of a nested event subscription for domain topic.

Get the full endpoint URL for a nested event subscription for domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list(resource_group_name: str, domain_name: str, topic_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all nested event subscriptions for a specific domain topic.

List all event subscriptions that have been created for a specific domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.DomainTopicsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s domain_topics attribute.

begin_create_or_update(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.eventgrid.models._models_py3.DomainTopic][source]¶

Create or update a domain topic.

Asynchronously creates or updates a new domain topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
domain_topic_name (str) – Name of the domain topic. Required.

Keyword Arguments

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 DomainTopic or the result of cls(response)

Return type

LROPoller[DomainTopic]

Raises

begin_delete(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a domain topic.

Delete existing domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
domain_topic_name (str) – Name of the domain topic. Required.

Keyword Arguments

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

Raises

get(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DomainTopic[source]¶

Get a domain topic.

Get properties of a domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
domain_topic_name (str) – Name of the topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DomainTopic or the result of cls(response)

Return type

DomainTopic

Raises

list_by_domain(resource_group_name: str, domain_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.DomainTopic][source]¶

List domain topics.

List all the topics in a domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Domain name. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DomainTopic]

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.DomainsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s domains attribute.

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][source]¶

begin_create_or_update(resource_group_name: str, domain_name: str, domain_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Domain]

Create or update a domain.

Asynchronously creates or updates a new domain with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
domain_info (Domain or IO) – Domain information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

LROPoller[Domain]

Raises

begin_delete(resource_group_name: str, domain_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a domain.

Delete existing domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, domain_name: str, domain_update_parameters: _models.DomainUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_update(resource_group_name: str, domain_name: str, domain_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Update a domain.

Asynchronously updates a domain with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
domain_update_parameters (DomainUpdateParameters or IO) – Domain update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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

LROPoller[Domain]

Raises

get(resource_group_name: str, domain_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.Domain[source]¶

Get a domain.

Get properties of a domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Domain or the result of cls(response)

Return type

Domain

Raises

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.Domain][source]¶

List domains under a resource group.

List all the domains under a resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Domain]

Raises

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.Domain][source]¶

List domains under an Azure subscription.

List all the domains under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Domain]

Raises

list_shared_access_keys(resource_group_name: str, domain_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DomainSharedAccessKeys[source]¶

List keys for a domain.

List the two keys used to publish to a domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DomainSharedAccessKeys or the result of cls(response)

Return type

DomainSharedAccessKeys

Raises

regenerate_key(resource_group_name: str, domain_name: str, regenerate_key_request: _models.DomainRegenerateKeyRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DomainSharedAccessKeys[source]¶

regenerate_key(resource_group_name: str, domain_name: str, regenerate_key_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DomainSharedAccessKeys

Regenerate key for a domain.

Regenerate a shared access key for a domain.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the domain. Required.
regenerate_key_request (DomainRegenerateKeyRequest or IO) – Request body to regenerate key. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

DomainSharedAccessKeys or the result of cls(response)

Return type

DomainSharedAccessKeys

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.EventSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s event_subscriptions attribute.

begin_create_or_update(scope: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_create_or_update(scope: str, event_subscription_name: str, event_subscription_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Create or update an event subscription.

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

Parameters

scope (str) – The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for a resource, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}’ for an EventGrid topic. Required.
event_subscription_name (str) – Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only. Required.
event_subscription_info (EventSubscription or IO) – Event subscription properties containing the destination and filter information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

begin_delete(scope: str, event_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete an event subscription.

Delete an existing event subscription.

Parameters

scope (str) – The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for a resource, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}’ for an EventGrid topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

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

Raises

begin_update(scope: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_update(scope: str, event_subscription_name: str, event_subscription_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Update an event subscription.

Asynchronously updates an existing event subscription.

Parameters

scope (str) – The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for a resource, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}’ for an EventGrid topic. Required.
event_subscription_name (str) – Name of the event subscription to be updated. Required.
event_subscription_update_parameters (EventSubscriptionUpdateParameters or IO) – Updated event subscription information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

get(scope: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscription[source]¶

Get an event subscription.

Get properties of an event subscription.

Parameters

scope (str) – The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for a resource, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}’ for an EventGrid topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscription or the result of cls(response)

Return type

Raises

get_delivery_attributes(scope: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult[source]¶

Get delivery attributes for an event subscription.

Get all delivery attributes for an event subscription.

Parameters

scope (str) – The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for a resource, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}’ for an EventGrid topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult or the result of cls(response)

Return type

Raises

get_full_url(scope: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of an event subscription.

Get the full endpoint URL for an event subscription.

Parameters

scope (str) – The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for a resource, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}’ for an EventGrid topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list_by_domain_topic(resource_group_name: str, domain_name: str, topic_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all event subscriptions for a specific domain topic.

List all event subscriptions that have been created for a specific domain topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
domain_name (str) – Name of the top level domain. Required.
topic_name (str) – Name of the domain topic. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_by_resource(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all event subscriptions.

List all event subscriptions that have been created for a specific resource.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
provider_namespace (str) – Namespace of the provider of the topic. Required.
resource_type_name (str) – Name of the resource type. Required.
resource_name (str) – Name of the resource. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_global_by_resource_group(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all global event subscriptions under an Azure subscription and resource group.

List all global event subscriptions under a specific Azure subscription and resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_global_by_resource_group_for_topic_type(resource_group_name: str, topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all global event subscriptions under a resource group for a topic type.

List all global event subscriptions under a resource group for a specific topic type.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_type_name (str) – Name of the topic type. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_global_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

Get an aggregated list of all global event subscriptions under an Azure subscription.

List all aggregated global event subscriptions under a specific Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_global_by_subscription_for_topic_type(topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all global event subscriptions for a topic type.

List all global event subscriptions under an Azure subscription for a topic type.

Parameters

topic_type_name (str) – Name of the topic type. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_regional_by_resource_group(resource_group_name: str, location: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all regional event subscriptions under an Azure subscription and resource group.

List all event subscriptions from the given location under a specific Azure subscription and resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
location (str) – Name of the location. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_regional_by_resource_group_for_topic_type(resource_group_name: str, location: str, topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all regional event subscriptions under an Azure subscription and resource group for a topic type.

List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
location (str) – Name of the location. Required.
topic_type_name (str) – Name of the topic type. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_regional_by_subscription(location: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all regional event subscriptions under an Azure subscription.

List all event subscriptions from the given location under a specific Azure subscription.

Parameters

location (str) – Name of the location. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_regional_by_subscription_for_topic_type(location: str, topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all regional event subscriptions under an Azure subscription for a topic type.

List all event subscriptions from the given location under a specific Azure subscription and topic type.

Parameters

location (str) – Name of the location. Required.
topic_type_name (str) – Name of the topic type. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.ExtensionTopicsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s extension_topics attribute.

get(scope: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.ExtensionTopic[source]¶

Get properties of an extension topic.

Get the properties of an extension topic.

Parameters: scope (str) – The identifier of the resource to which extension topic is queried. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace. For example, use ‘/subscriptions/{subscriptionId}/’ for a subscription, ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ for a resource group, and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}’ for Azure resource. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ExtensionTopic or the result of cls(response)
Return type: ExtensionTopic
Raises: HttpResponseError –

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.Operation][source]¶

List available operations.

List the available operations supported by the Microsoft.EventGrid resource provider.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PartnerConfigurationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s partner_configurations attribute.

authorize_partner(resource_group_name: str, partner_info: _models.Partner, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerConfiguration[source]¶

authorize_partner(resource_group_name: str, partner_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerConfiguration

Authorize a partner.

Authorize a single partner either by partner registration immutable Id or by partner name.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_info (Partner or IO) – The information of the partner to be authorized. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerConfiguration or the result of cls(response)

Return type

PartnerConfiguration

Raises

LROPoller[PartnerConfiguration]

begin_create_or_update(resource_group_name: str, partner_configuration_info: _models.PartnerConfiguration, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerConfiguration][source]¶

begin_create_or_update(resource_group_name: str, partner_configuration_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerConfiguration]

Create or update a partner configuration.

Synchronously creates or updates a partner configuration with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_configuration_info (PartnerConfiguration or IO) – Partner configuration information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PartnerConfiguration or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a partner configuration.

Delete existing partner configuration.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

Keyword Arguments

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

Raises

LROPoller[PartnerConfiguration]

begin_update(resource_group_name: str, partner_configuration_update_parameters: _models.PartnerConfigurationUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerConfiguration][source]¶

begin_update(resource_group_name: str, partner_configuration_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerConfiguration]

Update a partner configuration.

Synchronously updates a partner configuration with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_configuration_update_parameters (PartnerConfigurationUpdateParameters or IO) – Partner configuration update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PartnerConfiguration or the result of cls(response)

Return type

Raises

ItemPaged[PartnerConfiguration]

get(resource_group_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerConfiguration[source]¶

Get a partner configuration.

Get properties of a partner configuration.

Parameters: resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: PartnerConfiguration or the result of cls(response)
Return type: PartnerConfiguration
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PartnerConfiguration][source]¶

List partner configurations under a resource group.

List all the partner configurations under a resource group.

Parameters: resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either PartnerConfiguration or the result of cls(response)
Return type: ItemPaged[PartnerConfiguration]
Raises: HttpResponseError –

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PartnerConfiguration][source]¶

List partner configurations under an Azure subscription.

List all the partner configurations under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

unauthorize_partner(resource_group_name: str, partner_info: _models.Partner, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerConfiguration[source]¶

unauthorize_partner(resource_group_name: str, partner_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerConfiguration

Unauthorize a partner.

Unauthorize a single partner either by partner registration immutable Id or by partner name.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_info (Partner or IO) – The information of the partner to be unauthorized. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerConfiguration or the result of cls(response)

Return type

PartnerConfiguration

Raises

LROPoller[PartnerNamespace]

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PartnerNamespacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s partner_namespaces attribute.

begin_create_or_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_info: _models.PartnerNamespace, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerNamespace][source]¶

begin_create_or_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerNamespace]

Create a partner namespace.

Asynchronously creates a new partner namespace with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
partner_namespace_info (PartnerNamespace or IO) – PartnerNamespace information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PartnerNamespace or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a partner namespace.

Delete existing partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.

Keyword Arguments

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

Raises

LROPoller[PartnerNamespace]

begin_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_update_parameters: _models.PartnerNamespaceUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Update a partner namespace.

Asynchronously updates a partner namespace with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
partner_namespace_update_parameters (PartnerNamespaceUpdateParameters or IO) – Partner namespace update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PartnerNamespace or the result of cls(response)

Return type

Raises

get(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerNamespace[source]¶

Get a partner namespace.

Get properties of a partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerNamespace or the result of cls(response)

Return type

PartnerNamespace

Raises

ItemPaged[PartnerNamespace]

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.PartnerNamespace][source]¶

List partner namespaces under a resource group.

List all the partner namespaces under a resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[PartnerNamespace]

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PartnerNamespace][source]¶

List partner namespaces under an Azure subscription.

List all the partner namespaces under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

PartnerNamespaceSharedAccessKeys

list_shared_access_keys(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerNamespaceSharedAccessKeys[source]¶

List keys for a partner namespace.

List the two keys used to publish to a partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerNamespaceSharedAccessKeys or the result of cls(response)

Return type

Raises

PartnerNamespaceSharedAccessKeys

regenerate_key(resource_group_name: str, partner_namespace_name: str, regenerate_key_request: _models.PartnerNamespaceRegenerateKeyRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerNamespaceSharedAccessKeys[source]¶

regenerate_key(resource_group_name: str, partner_namespace_name: str, regenerate_key_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerNamespaceSharedAccessKeys

Regenerate key for a partner namespace.

Regenerate a shared access key for a partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_namespace_name (str) – Name of the partner namespace. Required.
regenerate_key_request (PartnerNamespaceRegenerateKeyRequest or IO) – Request body to regenerate key. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerNamespaceSharedAccessKeys or the result of cls(response)

Return type

Raises

LROPoller[PartnerRegistration]

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PartnerRegistrationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s partner_registrations attribute.

begin_create_or_update(resource_group_name: str, partner_registration_name: str, partner_registration_info: _models.PartnerRegistration, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerRegistration][source]¶

begin_create_or_update(resource_group_name: str, partner_registration_name: str, partner_registration_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PartnerRegistration]

Create a partner registration.

Creates a new partner registration with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_registration_name (str) – Name of the partner registration. Required.
partner_registration_info (PartnerRegistration or IO) – PartnerRegistration information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PartnerRegistration or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, partner_registration_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a partner registration.

Deletes a partner registration with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_registration_name (str) – Name of the partner registration. Required.

Keyword Arguments

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

Raises

LROPoller[PartnerRegistration]

begin_update(resource_group_name: str, partner_registration_name: str, partner_registration_update_parameters: _models.PartnerRegistrationUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_update(resource_group_name: str, partner_registration_name: str, partner_registration_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Update a partner registration.

Updates a partner registration with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_registration_name (str) – Name of the partner registration. Required.
partner_registration_update_parameters (PartnerRegistrationUpdateParameters or IO) – Partner registration update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PartnerRegistration or the result of cls(response)

Return type

Raises

get(resource_group_name: str, partner_registration_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerRegistration[source]¶

Get a partner registration.

Gets a partner registration with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_registration_name (str) – Name of the partner registration. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerRegistration or the result of cls(response)

Return type

PartnerRegistration

Raises

ItemPaged[PartnerRegistration]

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.PartnerRegistration][source]¶

List partner registrations under a resource group.

List all the partner registrations under a resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

ItemPaged[PartnerRegistration]

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PartnerRegistration][source]¶

List partner registrations under an Azure subscription.

List all the partner registrations under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PartnerTopicEventSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s partner_topic_event_subscriptions attribute.

begin_create_or_update(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_create_or_update(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, event_subscription_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Create or update an event subscription of a partner topic.

Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_info (EventSubscription or IO) – Event subscription properties containing the destination and filter information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete an event subscription of a partner topic.

Delete an existing event subscription of a partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_update(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, event_subscription_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Update event subscription of a partner topic.

Update an existing event subscription of a partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_update_parameters (EventSubscriptionUpdateParameters or IO) – Updated event subscription information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

get(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscription[source]¶

Get an event subscription of a partner topic.

Get properties of an event subscription of a partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscription or the result of cls(response)

Return type

Raises

get_delivery_attributes(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult[source]¶

Get delivery attributes for an event subscription of a partner topic.

Get all delivery attributes for an event subscription of a partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult or the result of cls(response)

Return type

Raises

get_full_url(resource_group_name: str, partner_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of an event subscription of a partner topic.

Get the full endpoint URL for an event subscription of a partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list_by_partner_topic(resource_group_name: str, partner_topic_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List event subscriptions of a partner topic.

List event subscriptions that belong to a specific partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PartnerTopicsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s partner_topics attribute.

activate(resource_group_name: str, partner_topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerTopic[source]¶

Activate a partner topic.

Activate a newly created partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerTopic or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, partner_topic_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a partner topic.

Delete existing partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.

Keyword Arguments

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

Raises

create_or_update(resource_group_name: str, partner_topic_name: str, partner_topic_info: _models.PartnerTopic, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerTopic[source]¶

create_or_update(resource_group_name: str, partner_topic_name: str, partner_topic_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PartnerTopic

Create a partner topic.

Asynchronously creates a new partner topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
partner_topic_info (PartnerTopic or IO) – Partner Topic information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerTopic or the result of cls(response)

Return type

Raises

deactivate(resource_group_name: str, partner_topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerTopic[source]¶

Deactivate a partner topic.

Deactivate specific partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerTopic or the result of cls(response)

Return type

Raises

get(resource_group_name: str, partner_topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PartnerTopic[source]¶

Get a partner topic.

Get properties of a partner topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerTopic or the result of cls(response)

Return type

Raises

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.PartnerTopic][source]¶

List partner topics under a resource group.

List all the partner topics under a resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PartnerTopic]

Raises

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PartnerTopic][source]¶

List partner topics under an Azure subscription.

List all the partner topics under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PartnerTopic]

Raises

update(resource_group_name: str, partner_topic_name: str, partner_topic_update_parameters: _models.PartnerTopicUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.PartnerTopic][source]¶

update(resource_group_name: str, partner_topic_name: str, partner_topic_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.PartnerTopic]

Update a partner topic.

Asynchronously updates a partner topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
partner_topic_name (str) – Name of the partner topic. Required.
partner_topic_update_parameters (PartnerTopicUpdateParameters or IO) – PartnerTopic update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

PartnerTopic or None or the result of cls(response)

Return type

PartnerTopic or None

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s private_endpoint_connections attribute.

begin_delete(resource_group_name: str, parent_type: Union[str, azure.mgmt.eventgrid.models._event_grid_management_client_enums.PrivateEndpointConnectionsParentType], parent_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a specific private endpoint connection.

Delete a specific private endpoint connection under a topic, domain, or partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
parent_type (str or PrivateEndpointConnectionsParentType) – The type of the parent resource. This can be either ‘topics’, ‘domains’, or ‘partnerNamespaces’. Known values are: “topics”, “domains”, and “partnerNamespaces”. Required.
parent_name (str) – The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection connection. Required.

Keyword Arguments

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

Raises

LROPoller[PrivateEndpointConnection]

begin_update(resource_group_name: str, parent_type: Union[str, _models.PrivateEndpointConnectionsParentType], parent_name: str, private_endpoint_connection_name: str, private_endpoint_connection: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]¶

begin_update(resource_group_name: str, parent_type: Union[str, _models.PrivateEndpointConnectionsParentType], parent_name: str, private_endpoint_connection_name: str, private_endpoint_connection: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Update a specific private endpoint connection.

Update a specific private endpoint connection under a topic, domain or partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
parent_type (str or PrivateEndpointConnectionsParentType) – The type of the parent resource. This can be either ‘topics’, ‘domains’, or ‘partnerNamespaces’. Known values are: “topics”, “domains”, and “partnerNamespaces”. Required.
parent_name (str) – The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection connection. Required.
private_endpoint_connection (PrivateEndpointConnection or IO) – The private endpoint connection object to update. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 PrivateEndpointConnection or the result of cls(response)

Return type

Raises

PrivateEndpointConnection

get(resource_group_name: str, parent_type: Union[str, azure.mgmt.eventgrid.models._event_grid_management_client_enums.PrivateEndpointConnectionsParentType], parent_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PrivateEndpointConnection[source]¶

Get a specific private endpoint connection.

Get a specific private endpoint connection under a topic, domain, or partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
parent_type (str or PrivateEndpointConnectionsParentType) – The type of the parent resource. This can be either ‘topics’, ‘domains’, or ‘partnerNamespaces’. Known values are: “topics”, “domains”, and “partnerNamespaces”. Required.
parent_name (str) – The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection connection. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

Raises

ItemPaged[PrivateEndpointConnection]

list_by_resource(resource_group_name: str, parent_type: Union[str, azure.mgmt.eventgrid.models._event_grid_management_client_enums.PrivateEndpointConnectionsParentType], parent_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PrivateEndpointConnection][source]¶

Lists all private endpoint connections under a resource.

Get all private endpoint connections under a topic, domain, or partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
parent_type (str or PrivateEndpointConnectionsParentType) – The type of the parent resource. This can be either ‘topics’, ‘domains’, or ‘partnerNamespaces’. Known values are: “topics”, “domains”, and “partnerNamespaces”. Required.
parent_name (str) – The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s private_link_resources attribute.

get(resource_group_name: str, parent_type: str, parent_name: str, private_link_resource_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.PrivateLinkResource[source]¶

Get a private link resource.

Get properties of a private link resource.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
parent_type (str) – The type of the parent resource. This can be either ‘topics’, ‘domains’, or ‘partnerNamespaces’. Required.
parent_name (str) – The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). Required.
private_link_resource_name (str) – The name of private link resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResource or the result of cls(response)

Return type

PrivateLinkResource

Raises

ItemPaged[PrivateLinkResource]

list_by_resource(resource_group_name: str, parent_type: str, parent_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.PrivateLinkResource][source]¶

List private link resources under specific topic, domain, or partner namespace.

List all the private link resources under a topic, domain, or partner namespace.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
parent_type (str) – The type of the parent resource. This can be either ‘topics’, ‘domains’, or ‘partnerNamespaces’. Required.
parent_name (str) – The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.SystemTopicEventSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s system_topic_event_subscriptions attribute.

begin_create_or_update(resource_group_name: str, system_topic_name: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_create_or_update(resource_group_name: str, system_topic_name: str, event_subscription_name: str, event_subscription_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Create or update an event subscription for a system topic.

Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_info (EventSubscription or IO) – Event subscription properties containing the destination and filter information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, system_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete an event subscription of a system topic.

Delete an existing event subscription of a system topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, system_topic_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_update(resource_group_name: str, system_topic_name: str, event_subscription_name: str, event_subscription_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Update event subscription of a system topic.

Update an existing event subscription of a system topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_update_parameters (EventSubscriptionUpdateParameters or IO) – Updated event subscription information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

get(resource_group_name: str, system_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscription[source]¶

Get an event subscription of a system topic.

Get an event subscription.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscription or the result of cls(response)

Return type

Raises

get_delivery_attributes(resource_group_name: str, system_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult[source]¶

Get delivery attributes for an event subscription.

Get all delivery attributes for an event subscription.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult or the result of cls(response)

Return type

Raises

get_full_url(resource_group_name: str, system_topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of an event subscription of a system topic.

Get the full endpoint URL for an event subscription of a system topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list_by_system_topic(resource_group_name: str, system_topic_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List event subscriptions of a system topic.

List event subscriptions that belong to a specific system topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.SystemTopicsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s system_topics attribute.

begin_create_or_update(resource_group_name: str, system_topic_name: str, system_topic_info: _models.SystemTopic, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SystemTopic][source]¶

begin_create_or_update(resource_group_name: str, system_topic_name: str, system_topic_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SystemTopic]

Create a system topic.

Asynchronously creates a new system topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
system_topic_info (SystemTopic or IO) – System Topic information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 SystemTopic or the result of cls(response)

Return type

LROPoller[SystemTopic]

Raises

begin_delete(resource_group_name: str, system_topic_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a system topic.

Delete existing system topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, system_topic_name: str, system_topic_update_parameters: _models.SystemTopicUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SystemTopic][source]¶

begin_update(resource_group_name: str, system_topic_name: str, system_topic_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SystemTopic]

Update a system topic.

Asynchronously updates a system topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.
system_topic_update_parameters (SystemTopicUpdateParameters or IO) – SystemTopic update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 SystemTopic or the result of cls(response)

Return type

LROPoller[SystemTopic]

Raises

get(resource_group_name: str, system_topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.SystemTopic[source]¶

Get a system topic.

Get properties of a system topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
system_topic_name (str) – Name of the system topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SystemTopic or the result of cls(response)

Return type

SystemTopic

Raises

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.SystemTopic][source]¶

List system topics under a resource group.

List all the system topics under a resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[SystemTopic]

Raises

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.SystemTopic][source]¶

List system topics under an Azure subscription.

List all the system topics under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[SystemTopic]

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.TopicEventSubscriptionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s topic_event_subscriptions attribute.

begin_create_or_update(resource_group_name: str, topic_name: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_create_or_update(resource_group_name: str, topic_name: str, event_subscription_name: str, event_subscription_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Create or update an event subscription to a topic.

Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.
event_subscription_info (EventSubscription or IO) – Event subscription properties containing the destination and filter information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete an event subscription for a topic.

Delete an existing event subscription for a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.
event_subscription_name (str) – Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

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

Raises

begin_update(resource_group_name: str, topic_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription][source]¶

begin_update(resource_group_name: str, topic_name: str, event_subscription_name: str, event_subscription_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EventSubscription]

Update an event subscription for a topic.

Update an existing event subscription for a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the domain. Required.
event_subscription_name (str) – Name of the event subscription to be updated. Required.
event_subscription_update_parameters (EventSubscriptionUpdateParameters or IO) – Updated event subscription information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 EventSubscription or the result of cls(response)

Return type

Raises

get(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscription[source]¶

Get an event subscription of a topic.

Get properties of an event subscription of a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the partner topic. Required.
event_subscription_name (str) – Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscription or the result of cls(response)

Return type

Raises

get_delivery_attributes(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult[source]¶

Get delivery attributes for an event subscription for topic.

Get all delivery attributes for an event subscription for topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult or the result of cls(response)

Return type

Raises

get_full_url(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl[source]¶

Get full URL of an event subscription for topic.

Get the full endpoint URL for an event subscription for topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the domain topic. Required.
event_subscription_name (str) – Name of the event subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl or the result of cls(response)

Return type

Raises

list(resource_group_name: str, topic_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscription][source]¶

List all event subscriptions for a specific topic.

List all event subscriptions that have been created for a specific topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.TopicTypesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s topic_types attribute.

get(topic_type_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.TopicTypeInfo[source]¶

Get a topic type.

Get information about a topic type.

Parameters: topic_type_name (str) – Name of the topic type. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: TopicTypeInfo or the result of cls(response)
Return type: TopicTypeInfo
Raises: HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.TopicTypeInfo][source]¶

List topic types.

List all registered topic types.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TopicTypeInfo or the result of cls(response)
Return type: ItemPaged[TopicTypeInfo]
Raises: HttpResponseError –

list_event_types(topic_type_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventType][source]¶

List event types.

List event types for a topic type.

Parameters: topic_type_name (str) – Name of the topic type. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either EventType or the result of cls(response)
Return type: ItemPaged[EventType]
Raises: HttpResponseError –

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.TopicsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s topics attribute.

begin_create_or_update(resource_group_name: str, topic_name: str, topic_info: _models.Topic, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Topic][source]¶

begin_create_or_update(resource_group_name: str, topic_name: str, topic_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Topic]

Create a topic.

Asynchronously creates a new topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.
topic_info (Topic or IO) – Topic information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 Topic or the result of cls(response)

Return type

LROPoller[Topic]

Raises

begin_delete(resource_group_name: str, topic_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a topic.

Delete existing topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.

Keyword Arguments

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

Raises

LROPoller[TopicSharedAccessKeys]

begin_regenerate_key(resource_group_name: str, topic_name: str, regenerate_key_request: _models.TopicRegenerateKeyRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TopicSharedAccessKeys][source]¶

begin_regenerate_key(resource_group_name: str, topic_name: str, regenerate_key_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.TopicSharedAccessKeys]

Regenerate key for a topic.

Regenerate a shared access key for a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.
regenerate_key_request (TopicRegenerateKeyRequest or IO) – Request body to regenerate key. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 TopicSharedAccessKeys or the result of cls(response)

Return type

Raises

begin_update(resource_group_name: str, topic_name: str, topic_update_parameters: _models.TopicUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_update(resource_group_name: str, topic_name: str, topic_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Update a topic.

Asynchronously updates a topic with the specified parameters.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.
topic_update_parameters (TopicUpdateParameters or IO) – Topic update information. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 Topic or the result of cls(response)

Return type

LROPoller[Topic]

Raises

get(resource_group_name: str, topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.Topic[source]¶

Get a topic.

Get properties of a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Topic or the result of cls(response)

Return type

Topic

Raises

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.Topic][source]¶

List topics under a resource group.

List all the topics under a resource group.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Topic]

Raises

list_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.Topic][source]¶

List topics under an Azure subscription.

List all the topics under an Azure subscription.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Topic]

Raises

list_event_types(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.EventType][source]¶

List topic event types.

List event types for a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
provider_namespace (str) – Namespace of the provider of the topic. Required.
resource_type_name (str) – Name of the topic type. Required.
resource_name (str) – Name of the topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[EventType]

Raises

list_shared_access_keys(resource_group_name: str, topic_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.TopicSharedAccessKeys[source]¶

List keys for a topic.

List the two keys used to publish to a topic.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.
topic_name (str) – Name of the topic. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TopicSharedAccessKeys or the result of cls(response)

Return type

TopicSharedAccessKeys

Raises

ItemPaged[VerifiedPartner]

models = <module 'azure.mgmt.eventgrid.models' from '/mnt/vss/_work/1/s/sdk/eventgrid/azure-mgmt-eventgrid/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/eventgrid/models/__init__.py'>¶

class azure.mgmt.eventgrid.operations.VerifiedPartnersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EventGridManagementClient’s verified_partners attribute.

get(verified_partner_name: str, **kwargs: Any) → azure.mgmt.eventgrid.models._models_py3.VerifiedPartner[source]¶

Get a verified partner.

Get properties of a verified partner.

Parameters: verified_partner_name (str) – Name of the verified partner. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: VerifiedPartner or the result of cls(response)
Return type: VerifiedPartner
Raises: HttpResponseError –

list(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.eventgrid.models._models_py3.VerifiedPartner][source]¶

List all verified partners.

Get a list of all verified partners.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises