Contacts interface

Interface representing a Contacts.

Methods

beginCreate(string, string, string, Contact, ContactsCreateOptionalParams)

Creates a contact.

beginCreateAndWait(string, string, string, Contact, ContactsCreateOptionalParams)

Creates a contact.

beginDelete(string, string, string, ContactsDeleteOptionalParams)

Deletes a specified contact.

beginDeleteAndWait(string, string, string, ContactsDeleteOptionalParams)

Deletes a specified contact.

get(string, string, string, ContactsGetOptionalParams)

Gets the specified contact in a specified resource group.

list(string, string, ContactsListOptionalParams)

Returns list of contacts by spacecraftName.

Method Details

beginCreate(string, string, string, Contact, ContactsCreateOptionalParams)

Creates a contact.

function beginCreate(resourceGroupName: string, spacecraftName: string, contactName: string, parameters: Contact, options?: ContactsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Contact>, Contact>>

Parameters

resourceGroupName

string

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

spacecraftName

string

Spacecraft ID.

contactName

string

Contact name.

parameters
Contact

The parameters to provide for the created contact.

options
ContactsCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Contact>, Contact>>

beginCreateAndWait(string, string, string, Contact, ContactsCreateOptionalParams)

Creates a contact.

function beginCreateAndWait(resourceGroupName: string, spacecraftName: string, contactName: string, parameters: Contact, options?: ContactsCreateOptionalParams): Promise<Contact>

Parameters

resourceGroupName

string

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

spacecraftName

string

Spacecraft ID.

contactName

string

Contact name.

parameters
Contact

The parameters to provide for the created contact.

options
ContactsCreateOptionalParams

The options parameters.

Returns

Promise<Contact>

beginDelete(string, string, string, ContactsDeleteOptionalParams)

Deletes a specified contact.

function beginDelete(resourceGroupName: string, spacecraftName: string, contactName: string, options?: ContactsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

spacecraftName

string

Spacecraft ID.

contactName

string

Contact name.

options
ContactsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ContactsDeleteOptionalParams)

Deletes a specified contact.

function beginDeleteAndWait(resourceGroupName: string, spacecraftName: string, contactName: string, options?: ContactsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

spacecraftName

string

Spacecraft ID.

contactName

string

Contact name.

options
ContactsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ContactsGetOptionalParams)

Gets the specified contact in a specified resource group.

function get(resourceGroupName: string, spacecraftName: string, contactName: string, options?: ContactsGetOptionalParams): Promise<Contact>

Parameters

resourceGroupName

string

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

spacecraftName

string

Spacecraft ID.

contactName

string

Contact name.

options
ContactsGetOptionalParams

The options parameters.

Returns

Promise<Contact>

list(string, string, ContactsListOptionalParams)

Returns list of contacts by spacecraftName.

function list(resourceGroupName: string, spacecraftName: string, options?: ContactsListOptionalParams): PagedAsyncIterableIterator<Contact, Contact[], PageSettings>

Parameters

resourceGroupName

string

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

spacecraftName

string

Spacecraft ID.

options
ContactsListOptionalParams

The options parameters.

Returns