Profiles interface
Interface representing a Profiles.
Methods
Method Details
beginCreateOrUpdate(string, string, string, ProfileResourceFormat, ProfilesCreateOrUpdateOptionalParams)
Creates a profile within a Hub, or updates an existing profile.
function beginCreateOrUpdate(resourceGroupName: string, hubName: string, profileName: string, parameters: ProfileResourceFormat, options?: ProfilesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProfileResourceFormat>, ProfileResourceFormat>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- profileName
-
string
The name of the profile.
- parameters
- ProfileResourceFormat
Parameters supplied to the create/delete Profile type operation
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ProfileResourceFormat>, ProfileResourceFormat>>
beginCreateOrUpdateAndWait(string, string, string, ProfileResourceFormat, ProfilesCreateOrUpdateOptionalParams)
Creates a profile within a Hub, or updates an existing profile.
function beginCreateOrUpdateAndWait(resourceGroupName: string, hubName: string, profileName: string, parameters: ProfileResourceFormat, options?: ProfilesCreateOrUpdateOptionalParams): Promise<ProfileResourceFormat>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- profileName
-
string
The name of the profile.
- parameters
- ProfileResourceFormat
Parameters supplied to the create/delete Profile type operation
The options parameters.
Returns
Promise<ProfileResourceFormat>
beginDelete(string, string, string, ProfilesDeleteOptionalParams)
Deletes a profile within a hub
function beginDelete(resourceGroupName: string, hubName: string, profileName: string, options?: ProfilesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- profileName
-
string
The name of the profile.
- options
- ProfilesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, ProfilesDeleteOptionalParams)
Deletes a profile within a hub
function beginDeleteAndWait(resourceGroupName: string, hubName: string, profileName: string, options?: ProfilesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- profileName
-
string
The name of the profile.
- options
- ProfilesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ProfilesGetOptionalParams)
Gets information about the specified profile.
function get(resourceGroupName: string, hubName: string, profileName: string, options?: ProfilesGetOptionalParams): Promise<ProfileResourceFormat>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- profileName
-
string
The name of the profile.
- options
- ProfilesGetOptionalParams
The options parameters.
Returns
Promise<ProfileResourceFormat>
getEnrichingKpis(string, string, string, ProfilesGetEnrichingKpisOptionalParams)
Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
function getEnrichingKpis(resourceGroupName: string, hubName: string, profileName: string, options?: ProfilesGetEnrichingKpisOptionalParams): Promise<ProfilesGetEnrichingKpisResponse>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- profileName
-
string
The name of the profile.
The options parameters.
Returns
Promise<ProfilesGetEnrichingKpisResponse>
listByHub(string, string, ProfilesListByHubOptionalParams)
Gets all profile in the hub.
function listByHub(resourceGroupName: string, hubName: string, options?: ProfilesListByHubOptionalParams): PagedAsyncIterableIterator<ProfileResourceFormat, ProfileResourceFormat[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- options
- ProfilesListByHubOptionalParams
The options parameters.