ContactProfiles interface

Interface representing a ContactProfiles.

Methods

beginCreateOrUpdate(string, string, string, ContactProfilesPropertiesNetworkConfiguration, ContactProfileLink[], ContactProfilesCreateOrUpdateOptionalParams)

Creates or updates a contact profile.

beginCreateOrUpdateAndWait(string, string, string, ContactProfilesPropertiesNetworkConfiguration, ContactProfileLink[], ContactProfilesCreateOrUpdateOptionalParams)

Creates or updates a contact profile.

beginDelete(string, string, ContactProfilesDeleteOptionalParams)

Deletes a specified contact profile resource.

beginDeleteAndWait(string, string, ContactProfilesDeleteOptionalParams)

Deletes a specified contact profile resource.

beginUpdateTags(string, string, TagsObject, ContactProfilesUpdateTagsOptionalParams)

Updates the specified contact profile tags.

beginUpdateTagsAndWait(string, string, TagsObject, ContactProfilesUpdateTagsOptionalParams)

Updates the specified contact profile tags.

get(string, string, ContactProfilesGetOptionalParams)

Gets the specified contact Profile in a specified resource group.

list(string, ContactProfilesListOptionalParams)

Returns list of contact profiles by Resource Group.

listBySubscription(ContactProfilesListBySubscriptionOptionalParams)

Returns list of contact profiles by Subscription.

Method Details

beginCreateOrUpdate(string, string, string, ContactProfilesPropertiesNetworkConfiguration, ContactProfileLink[], ContactProfilesCreateOrUpdateOptionalParams)

Creates or updates a contact profile.

function beginCreateOrUpdate(resourceGroupName: string, contactProfileName: string, location: string, networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContactProfile>, ContactProfile>>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

location

string

The geo-location where the resource lives

networkConfiguration
ContactProfilesPropertiesNetworkConfiguration

Network configuration of customer virtual network.

links

ContactProfileLink[]

Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.

options
ContactProfilesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, ContactProfilesPropertiesNetworkConfiguration, ContactProfileLink[], ContactProfilesCreateOrUpdateOptionalParams)

Creates or updates a contact profile.

function beginCreateOrUpdateAndWait(resourceGroupName: string, contactProfileName: string, location: string, networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams): Promise<ContactProfile>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

location

string

The geo-location where the resource lives

networkConfiguration
ContactProfilesPropertiesNetworkConfiguration

Network configuration of customer virtual network.

links

ContactProfileLink[]

Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.

options
ContactProfilesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ContactProfile>

beginDelete(string, string, ContactProfilesDeleteOptionalParams)

Deletes a specified contact profile resource.

function beginDelete(resourceGroupName: string, contactProfileName: string, options?: ContactProfilesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

options
ContactProfilesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ContactProfilesDeleteOptionalParams)

Deletes a specified contact profile resource.

function beginDeleteAndWait(resourceGroupName: string, contactProfileName: string, options?: ContactProfilesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

options
ContactProfilesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateTags(string, string, TagsObject, ContactProfilesUpdateTagsOptionalParams)

Updates the specified contact profile tags.

function beginUpdateTags(resourceGroupName: string, contactProfileName: string, parameters: TagsObject, options?: ContactProfilesUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<ContactProfile>, ContactProfile>>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

parameters
TagsObject

Parameters supplied to update contact profile tags.

options
ContactProfilesUpdateTagsOptionalParams

The options parameters.

Returns

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

beginUpdateTagsAndWait(string, string, TagsObject, ContactProfilesUpdateTagsOptionalParams)

Updates the specified contact profile tags.

function beginUpdateTagsAndWait(resourceGroupName: string, contactProfileName: string, parameters: TagsObject, options?: ContactProfilesUpdateTagsOptionalParams): Promise<ContactProfile>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

parameters
TagsObject

Parameters supplied to update contact profile tags.

options
ContactProfilesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ContactProfile>

get(string, string, ContactProfilesGetOptionalParams)

Gets the specified contact Profile in a specified resource group.

function get(resourceGroupName: string, contactProfileName: string, options?: ContactProfilesGetOptionalParams): Promise<ContactProfile>

Parameters

resourceGroupName

string

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

contactProfileName

string

Contact Profile name.

options
ContactProfilesGetOptionalParams

The options parameters.

Returns

Promise<ContactProfile>

list(string, ContactProfilesListOptionalParams)

Returns list of contact profiles by Resource Group.

function list(resourceGroupName: string, options?: ContactProfilesListOptionalParams): PagedAsyncIterableIterator<ContactProfile, ContactProfile[], PageSettings>

Parameters

resourceGroupName

string

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

options
ContactProfilesListOptionalParams

The options parameters.

Returns

listBySubscription(ContactProfilesListBySubscriptionOptionalParams)

Returns list of contact profiles by Subscription.

function listBySubscription(options?: ContactProfilesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ContactProfile, ContactProfile[], PageSettings>

Parameters

options
ContactProfilesListBySubscriptionOptionalParams

The options parameters.

Returns