CommunicationServiceOperations Class

CommunicationServiceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

CommunicationServiceOperations

Constructor

CommunicationServiceOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Create Or Update. Create a new CommunicationService or update an existing CommunicationService.
begin_delete	Delete. Operation to delete a CommunicationService.
check_name_availability	Check Name Availability. Checks that the CommunicationService name is valid and is not already in use.
get	Get. Get the CommunicationService and its properties.
link_notification_hub	Link Notification Hub. Links an Azure Notification Hub to this communication service.
list_by_resource_group	List By Resource Group. Handles requests to list all resources in a resource group.
list_by_subscription	List By Subscription. Handles requests to list all resources in a subscription.
list_keys	List Keys. Get the access keys of the CommunicationService resource.
regenerate_key	Regenerate Key. Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
update	Update. Operation to update an existing CommunicationService.

begin_create_or_update

Create Or Update.

Create a new CommunicationService or update an existing CommunicationService.

begin_create_or_update(resource_group_name: str, communication_service_name: str, parameters: Optional[_models.CommunicationServiceResource] = None, **kwargs: Any) -> LROPoller[_models.CommunicationServiceResource]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

parameters

<xref:communication_service_management_client.models.CommunicationServiceResource>

default value: None

Parameters for the create or update operation.

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

True for ARMPolling, False for no polling, or a polling object for 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 CommunicationServiceResource or the result of cls(response)

Return type

LROPoller[<xref:communication_service_management_client.models.CommunicationServiceResource>]

Exceptions

HttpResponseError

begin_delete

Delete.

Operation to delete a CommunicationService.

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

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

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

True for ARMPolling, False for no polling, or a polling object for 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

LROPoller[None]

Exceptions

HttpResponseError

check_name_availability

Check Name Availability.

Checks that the CommunicationService name is valid and is not already in use.

check_name_availability(name_availability_parameters: Optional[_models.NameAvailabilityParameters] = None, **kwargs: Any) -> _models.NameAvailability

Parameters

name_availability_parameters

<xref:communication_service_management_client.models.NameAvailabilityParameters>

default value: None

Parameters supplied to the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

NameAvailability, or the result of cls(response)

Return type

<xref:communication_service_management_client.models.NameAvailability>

Exceptions

HttpResponseError

get

Get.

Get the CommunicationService and its properties.

get(resource_group_name: str, communication_service_name: str, **kwargs: Any) -> _models.CommunicationServiceResource

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

CommunicationServiceResource, or the result of cls(response)

Return type

<xref:communication_service_management_client.models.CommunicationServiceResource>

Exceptions

HttpResponseError

link_notification_hub

Link Notification Hub.

Links an Azure Notification Hub to this communication service.

link_notification_hub(resource_group_name: str, communication_service_name: str, link_notification_hub_parameters: Optional[_models.LinkNotificationHubParameters] = None, **kwargs: Any) -> _models.LinkedNotificationHub

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

link_notification_hub_parameters

<xref:communication_service_management_client.models.LinkNotificationHubParameters>

default value: None

Parameters supplied to the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

LinkedNotificationHub, or the result of cls(response)

Return type

<xref:communication_service_management_client.models.LinkedNotificationHub>

Exceptions

HttpResponseError

list_by_resource_group

List By Resource Group.

Handles requests to list all resources in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[_models.CommunicationServiceResourceList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[<xref:communication_service_management_client.models.CommunicationServiceResourceList>]

Exceptions

HttpResponseError

list_by_subscription

List By Subscription.

Handles requests to list all resources in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[_models.CommunicationServiceResourceList]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[<xref:communication_service_management_client.models.CommunicationServiceResourceList>]

Exceptions

HttpResponseError

list_keys

List Keys.

Get the access keys of the CommunicationService resource.

list_keys(resource_group_name: str, communication_service_name: str, **kwargs: Any) -> _models.CommunicationServiceKeys

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

CommunicationServiceKeys, or the result of cls(response)

Return type

<xref:communication_service_management_client.models.CommunicationServiceKeys>

Exceptions

HttpResponseError

regenerate_key

Regenerate Key.

Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

regenerate_key(resource_group_name: str, communication_service_name: str, parameters: _models.RegenerateKeyParameters, **kwargs: Any) -> _models.CommunicationServiceKeys

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

parameters

<xref:communication_service_management_client.models.RegenerateKeyParameters>

Required

Parameter that describes the Regenerate Key Operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

CommunicationServiceKeys, or the result of cls(response)

Return type

<xref:communication_service_management_client.models.CommunicationServiceKeys>

Exceptions

HttpResponseError

update

Update.

Operation to update an existing CommunicationService.

update(resource_group_name: str, communication_service_name: str, parameters: Optional[_models.CommunicationServiceResource] = None, **kwargs: Any) -> _models.CommunicationServiceResource

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

communication_service_name

str

Required

The name of the CommunicationService resource.

parameters

<xref:communication_service_management_client.models.CommunicationServiceResource>

default value: None

Parameters for the update operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

CommunicationServiceResource, or the result of cls(response)

Return type

<xref:communication_service_management_client.models.CommunicationServiceResource>

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.communication.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\communication\\models\\__init__.py'>