ConsumerInvitationsOperations Class

ConsumerInvitationsOperations async operations.

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

Inheritance

builtins.object

ConsumerInvitationsOperations

Constructor

ConsumerInvitationsOperations(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

get	Gets the invitation identified by invitationId. Get an invitation.
list_invitations	List the invitations. Lists invitations.
reject_invitation	Rejects the invitation identified by invitationId. Reject an invitation.

get

Gets the invitation identified by invitationId.

Get an invitation.

async get(location: str, invitation_id: str, **kwargs) -> azure.mgmt.datashare.models._models_py3.ConsumerInvitation

Parameters

location

str

Required

Location of the invitation.

invitation_id

str

Required

An invitation id.

cls

callable

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

Returns

ConsumerInvitation, or the result of cls(response)

Return type

ConsumerInvitation

Exceptions

HttpResponseError

list_invitations

List the invitations.

Lists invitations.

list_invitations(skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.datashare.models._models_py3.ConsumerInvitationList]

Parameters

skip_token

str

default value: None

The continuation token.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[ConsumerInvitationList]

Exceptions

HttpResponseError

reject_invitation

Rejects the invitation identified by invitationId.

Reject an invitation.

async reject_invitation(location: str, invitation: azure.mgmt.datashare.models._models_py3.ConsumerInvitation, **kwargs) -> azure.mgmt.datashare.models._models_py3.ConsumerInvitation

Parameters

location

str

Required

Location of the invitation.

invitation

ConsumerInvitation

Required

An invitation payload.

cls

callable

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

Returns

ConsumerInvitation, or the result of cls(response)

Return type

ConsumerInvitation

Exceptions

HttpResponseError

Attributes

models

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