InvitationsOperations Class

InvitationsOperations 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

InvitationsOperations

Constructor

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

create	Sends a new invitation to a recipient to access a share. Create an invitation.
delete	Delete Invitation in a share. Delete an invitation in a share.
get	Get Invitation in a share. Get an invitation in a share.
list_by_share	List all Invitations in a share. List invitations in a share.

create

Sends a new invitation to a recipient to access a share.

Create an invitation.

async create(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, invitation: azure.mgmt.datashare.models._models_py3.Invitation, **kwargs) -> azure.mgmt.datashare.models._models_py3.Invitation

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share to send the invitation for.

invitation_name

str

Required

The name of the invitation.

invitation

Invitation

Required

Invitation details.

cls

callable

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

Returns

Invitation, or the result of cls(response)

Return type

Invitation

Exceptions

HttpResponseError

delete

Delete Invitation in a share.

Delete an invitation in a share.

async delete(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

invitation_name

str

Required

The name of the invitation.

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

Exceptions

HttpResponseError

get

Get Invitation in a share.

Get an invitation in a share.

async get(resource_group_name: str, account_name: str, share_name: str, invitation_name: str, **kwargs) -> azure.mgmt.datashare.models._models_py3.Invitation

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

invitation_name

str

Required

The name of the invitation.

cls

callable

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

Returns

Invitation, or the result of cls(response)

Return type

Invitation

Exceptions

HttpResponseError

list_by_share

List all Invitations in a share.

List invitations in a share.

list_by_share(resource_group_name: str, account_name: str, share_name: str, skip_token: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.datashare.models._models_py3.InvitationList]

Parameters

resource_group_name

str

Required

The resource group name.

account_name

str

Required

The name of the share account.

share_name

str

Required

The name of the share.

skip_token

str

default value: None

The continuation token.

filter

str

default value: None

Filters the results using OData syntax.

orderby

str

default value: None

Sorts the results using OData syntax.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[InvitationList]

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'>