ContactProfilesImpl | @azure/arm-orbital

Class containing ContactProfiles operations.

Hierarchy

ContactProfilesImpl

Implements

ContactProfiles

Index

Constructors

constructor

Methods

Constructors

constructor

new ContactProfilesImpl(client: AzureOrbital): ContactProfilesImpl

- Defined in operations/contactProfiles.ts:36
Initialize a new instance of the class ContactProfiles class.

Parameters
- client: AzureOrbital
  
  Reference to the service client
Returns ContactProfilesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, contactProfileName: string, location: string, options?: ContactProfilesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ContactProfilesCreateOrUpdateResponse>, ContactProfilesCreateOrUpdateResponse>>

Implementation of ContactProfiles.beginCreateOrUpdate
- Defined in operations/contactProfiles.ts:146
Creates or updates a contact profile

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
- Optional options: ContactProfilesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ContactProfilesCreateOrUpdateResponse>, ContactProfilesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, contactProfileName: string, location: string, options?: ContactProfilesCreateOrUpdateOptionalParams): Promise<ContactProfilesCreateOrUpdateResponse>

Implementation of ContactProfiles.beginCreateOrUpdateAndWait
- Defined in operations/contactProfiles.ts:217
Creates or updates a contact profile

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
- Optional options: ContactProfilesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ContactProfilesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, contactProfileName: string, options?: ContactProfilesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of ContactProfiles.beginDelete
- Defined in operations/contactProfiles.ts:238
Deletes a specified contact profile resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- contactProfileName: string
  
  Contact Profile Name
- Optional options: ContactProfilesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of ContactProfiles.beginDeleteAndWait
- Defined in operations/contactProfiles.ts:302
Deletes a specified contact profile resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- contactProfileName: string
  
  Contact Profile Name
- Optional options: ContactProfilesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of ContactProfiles.get
- Defined in operations/contactProfiles.ts:128
Gets the specified contact Profile in a specified resource group

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- contactProfileName: string
  
  Contact Profile Name
- Optional options: ContactProfilesGetOptionalParams
  
  The options parameters.
Returns Promise<ContactProfilesGetResponse>

list

list(resourceGroupName: string, options?: ContactProfilesListOptionalParams): PagedAsyncIterableIterator<ContactProfile>

Implementation of ContactProfiles.list
- Defined in operations/contactProfiles.ts:87
Returns list of contact profiles

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: ContactProfilesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ContactProfile>

listBySubscription

listBySubscription(options?: ContactProfilesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ContactProfile>

Implementation of ContactProfiles.listBySubscription
- Defined in operations/contactProfiles.ts:50
Returns list of contact profiles

Parameters
- Optional options: ContactProfilesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ContactProfile>

updateTags

updateTags(resourceGroupName: string, contactProfileName: string, parameters: TagsObject, options?: ContactProfilesUpdateTagsOptionalParams): Promise<ContactProfilesUpdateTagsResponse>

Implementation of ContactProfiles.updateTags
- Defined in operations/contactProfiles.ts:322
Updates the specified contact profile tags.

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.
- Optional options: ContactProfilesUpdateTagsOptionalParams
  
  The options parameters.
Returns Promise<ContactProfilesUpdateTagsResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: AzureOrbital

Returns ContactProfilesImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

contactProfileName: string

location: string

Optional options: ContactProfilesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ContactProfilesCreateOrUpdateResponse>, ContactProfilesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

contactProfileName: string

location: string

Optional options: ContactProfilesCreateOrUpdateOptionalParams

Returns Promise<ContactProfilesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

contactProfileName: string

Optional options: ContactProfilesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

contactProfileName: string

Optional options: ContactProfilesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

contactProfileName: string

Optional options: ContactProfilesGetOptionalParams

Returns Promise<ContactProfilesGetResponse>

list

Parameters

resourceGroupName: string

Optional options: ContactProfilesListOptionalParams

Returns PagedAsyncIterableIterator<ContactProfile>

listBySubscription

Parameters

Optional options: ContactProfilesListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<ContactProfile>

updateTags

Parameters

resourceGroupName: string

contactProfileName: string

parameters: TagsObject

Optional options: ContactProfilesUpdateTagsOptionalParams

Returns Promise<ContactProfilesUpdateTagsResponse>