Microsoft.CustomerInsights (stable:2017-04-26)

2025/10/23 • 66 new, 66 deleted methods

Operations_List (new)
Description :  Lists all of the available Customer Insights REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomerInsights/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Customer Insights operations supported by the Microsoft.CustomerInsights resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.CustomerInsights ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Hubs_CreateOrUpdate (new)
Description :  Creates a hub, or updates an existing hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the Hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Hub operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
Hubs_Update (new)
Description :  Updates a Hub.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the Hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Hub operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
Hubs_Delete (new)
Description :  Deletes the specified hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Hubs_Get (new)
Description :  Gets information about the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
Hubs_ListByResourceGroup (new)
Description :  Gets all the hubs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}
Hubs_List (new)
Description :  Gets all hubs in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerInsights/hubs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}
Profiles_CreateOrUpdate (new)
Description :  Creates a profile within a Hub, or updates an existing profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/delete Profile type operation ,
Required: True ,
}
{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
Profiles_Get (new)
Description :  Gets information about the specified profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of profile to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Profiles_Delete (new)
Description :  Deletes a profile within a hub
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of profile to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Profiles_ListByHub (new)
Description :  Gets all profile in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of profile to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Profiles_GetEnrichingKpis (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}/getEnrichingKpis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
Interactions_CreateOrUpdate (new)
Description :  Creates an interaction or updates an existing interaction within a hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
interactionName:
{
Description: The name of the interaction. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Interaction operation. ,
Required: True ,
}
{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Interactions_Get (new)
Description :  Gets information about the specified interaction.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
interactionName:
{
Description: The name of the interaction. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of interaction to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}
Interactions_ListByHub (new)
Description :  Gets all interactions in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of interaction to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Relationships_CreateOrUpdate (new)
Description :  Creates a relationship or updates an existing relationship within a hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the Relationship. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Relationship operation. ,
Required: True ,
}
{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
Relationships_Get (new)
Description :  Gets information about the specified relationship.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the relationship. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
Relationships_Delete (new)
Description :  Deletes a relationship within a hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the relationship. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}
Relationships_ListByHub (new)
Description :  Gets all relationships in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
AuthorizationPolicies_CreateOrUpdate (new)
Description :  Creates an authorization policy or updates an existing authorization policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate authorization policy operation. ,
Required: True ,
}
{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
AuthorizationPolicies_Get (new)
Description :  Gets an authorization policy in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
AuthorizationPolicies_ListByHub (new)
Description :  Gets all the authorization policies in a specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
AuthorizationPolicies_RegeneratePrimaryKey (new)
Description :  Regenerates the primary policy key of the specified authorization policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
AuthorizationPolicies_RegenerateSecondaryKey (new)
Description :  Regenerates the secondary policy key of the specified authorization policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
Connectors_CreateOrUpdate (new)
Description :  Creates a connector or updates an existing connector in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Connector operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Connectors_Get (new)
Description :  Gets a connector in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}
Connectors_Delete (new)
Description :  Deletes a connector in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Connectors_ListByHub (new)
Description :  Gets all the connectors in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
ConnectorMappings_CreateOrUpdate (new)
Description :  Creates a connector mapping or updates an existing connector mapping in the connector.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
mappingName:
{
Description: The name of the connector mapping. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Connector Mapping operation. ,
Required: True ,
}
{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
ConnectorMappings_Get (new)
Description :  Gets a connector mapping in the connector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
mappingName:
{
Description: The name of the connector mapping. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
ConnectorMappings_Delete (new)
Description :  Deletes a connector mapping in the connector.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
mappingName:
{
Description: The name of the connector mapping. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ConnectorMappings_ListByConnector (new)
Description :  Gets all the connector mappings in the specified connector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Kpi_CreateOrUpdate (new)
Description :  Creates a KPI or updates an existing KPI in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update KPI operation. ,
Required: True ,
}
{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
Kpi_Get (new)
Description :  Gets a KPI in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Kpi_Delete (new)
Description :  Deletes a KPI in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Kpi_Reprocess (new)
Description :  Reprocesses the Kpi values of the specified KPI.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}/reprocess
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
Kpi_ListByHub (new)
Description :  Gets all the KPIs in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
WidgetTypes_ListByHub (new)
Description :  Gets all available widget types in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/widgetTypes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Definition of WidgetType. ,
Required: False ,
}
{
widgetTypeName:
{
Description: Name of the widget type. ,
Required: False ,
}
string ,
definition:
{
Description: Definition for widget type. ,
Required: True ,
}
string ,
description:
{
Description: Description for widget type. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the widget type. ,
Required: False ,
}
object ,
imageUrl:
{
Description: The image URL. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
widgetVersion:
{
Description: The widget version. ,
Required: False ,
}
string ,
changed:
{
Description: Date time when widget type was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when widget type was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
WidgetTypes_Get (new)
Description :  Gets a widget type in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/widgetTypes/{widgetTypeName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
widgetTypeName:
{
Description: The name of the widget type. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Definition of WidgetType. ,
Required: False ,
}
{
widgetTypeName:
{
Description: Name of the widget type. ,
Required: False ,
}
string ,
definition:
{
Description: Definition for widget type. ,
Required: True ,
}
string ,
description:
{
Description: Description for widget type. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the widget type. ,
Required: False ,
}
object ,
imageUrl:
{
Description: The image URL. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
widgetVersion:
{
Description: The widget version. ,
Required: False ,
}
string ,
changed:
{
Description: Date time when widget type was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when widget type was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Views_ListByHub (new)
Description :  Gets all available views for given user in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID. Use * to retrieve hub level views. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Views_CreateOrUpdate (new)
Description :  Creates a view or updates an existing view in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
viewName:
{
Description: The name of the view. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate View operation. ,
Required: True ,
}
{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Views_Get (new)
Description :  Gets a view in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
viewName:
{
Description: The name of the view. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID. Use * to retrieve hub level view. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Views_Delete (new)
Description :  Deletes a view in the specified hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
viewName:
{
Description: The name of the view. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID. Use * to retrieve hub level view. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Roles_ListByHub (new)
Description :  Gets all the roles for the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roles
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Role definition. ,
Required: False ,
}
{
roleName:
{
Description: The role name. ,
Required: False ,
}
string ,
description:
{
Description: The description of the role. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
RoleAssignments_ListByHub (new)
Description :  Gets all the role assignments for the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
RoleAssignments_CreateOrUpdate (new)
Description :  Creates or updates a role assignment in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
assignmentName:
{
Description: The assignment name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate RoleAssignment operation. ,
Required: True ,
}
{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{}
RoleAssignments_Get (new)
Description :  Gets the role assignment in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
assignmentName:
{
Description: The name of the role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
RoleAssignments_Delete (new)
Description :  Deletes the role assignment in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
assignmentName:
{
Description: The name of the role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Images_GetUploadUrlForEntityType (new)
Description :  Gets entity type (profile or interaction) image upload URL.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getEntityTypeImageUploadUrl
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the GetUploadUrlForEntityType operation. ,
Required: True ,
}
{
entityType:
{
Description: Type of entity. Can be Profile or Interaction. ,
Required: False ,
}
string ,
entityTypeName:
{
Description: Name of the entity type. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageExists:
{
Description: Whether image exists already. ,
Required: False ,
}
boolean ,
contentUrl:
{
Description: Content URL for the image blob. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
Images_GetUploadUrlForData (new)
Description :  Gets data image upload URL.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getDataImageUploadUrl
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the GetUploadUrlForData operation. ,
Required: True ,
}
{
entityType:
{
Description: Type of entity. Can be Profile or Interaction. ,
Required: False ,
}
string ,
entityTypeName:
{
Description: Name of the entity type. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageExists:
{
Description: Whether image exists already. ,
Required: False ,
}
boolean ,
contentUrl:
{
Description: Content URL for the image blob. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
Predictions_CreateOrUpdate (new)
Description :  Creates a Prediction or updates an existing Prediction in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update Prediction operation. ,
Required: True ,
}
{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
Predictions_Get (new)
Description :  Gets a Prediction in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}
Predictions_Delete (new)
Description :  Deletes a Prediction in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Predictions_GetTrainingResults (new)
Description :  Gets training results.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}/getTrainingResults
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
scoreName:
{
Description: Score name. ,
Required: False ,
}
string ,
predictionDistribution:
{
Description: Prediction distribution. ,
Required: False ,
}
{
totalPositives:
{
Description: Total positive in the distribution. ,
Format: int64 ,
Required: False ,
}
integer ,
totalNegatives:
{
Description: Total negatives in the distribution. ,
Format: int64 ,
Required: False ,
}
integer ,
distributions:
{
Description: Distributions of the prediction. ,
Required: False ,
}
[
{
scoreThreshold:
{
Description: Score threshold. ,
Required: False ,
}
integer ,
positives:
{
Description: Number of positives. ,
Format: int64 ,
Required: False ,
}
integer ,
negatives:
{
Description: Number of negatives. ,
Format: int64 ,
Required: False ,
}
integer ,
positivesAboveThreshold:
{
Description: Number of positives above threshold. ,
Format: int64 ,
Required: False ,
}
integer ,
negativesAboveThreshold:
{
Description: Number of negatives above threshold. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
canonicalProfiles:
{
Description: Canonical profiles. ,
Required: False ,
}
[
{
canonicalProfileId:
{
Description: Canonical profile ID. ,
Required: False ,
}
integer ,
properties:
{
Description: Properties of the canonical profile. ,
Required: False ,
}
[
{
profileName:
{
Description: Profile name. ,
Required: False ,
}
string ,
profilePropertyName:
{
Description: Property name of profile. ,
Required: False ,
}
string ,
rank:
{
Description: The rank. ,
Required: False ,
}
integer ,
type:
{
Description: Type of canonical property value. ,
Enum:
{
Numeric: No description available. ,
Categorical: No description available. ,
DerivedCategorical: No description available. ,
DerivedNumeric: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Value of the canonical property. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
primaryProfileInstanceCount:
{
Description: Instance count of the primary profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Predictions_GetModelStatus (new)
Description :  Gets model status of the prediction.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}/getModelStatus
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
predictionName:
{
Description: The prediction name. ,
Required: False ,
}
string ,
predictionGuidId:
{
Description: The prediction GUID ID. ,
Required: False ,
}
string ,
status:
{
Description: Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the status to PendingFeaturing or Active through API. ,
Enum:
{
New: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
PendingDiscovering: No description available. ,
Discovering: No description available. ,
PendingFeaturing: No description available. ,
Featuring: No description available. ,
FeaturingFailed: No description available. ,
PendingTraining: No description available. ,
Training: No description available. ,
TrainingFailed: No description available. ,
Evaluating: No description available. ,
EvaluatingFailed: No description available. ,
PendingModelConfirmation: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The model status message. ,
Required: False ,
}
string ,
trainingSetCount:
{
Description: Count of the training set. ,
Required: False ,
}
integer ,
testSetCount:
{
Description: Count of the test set. ,
Required: False ,
}
integer ,
validationSetCount:
{
Description: Count of the validation set. ,
Required: False ,
}
integer ,
trainingAccuracy:
{
Description: The training accuracy. ,
Format: decimal ,
Required: False ,
}
integer ,
signalsUsed:
{
Description: The signals used. ,
Required: False ,
}
integer ,
modelVersion:
{
Description: Version of the model. ,
Required: False ,
}
string ,
}
Predictions_ModelStatus (new)
Description :  Creates or updates the model status of prediction.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}/modelStatus
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update prediction model status operation. ,
Required: True ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
predictionName:
{
Description: The prediction name. ,
Required: False ,
}
string ,
predictionGuidId:
{
Description: The prediction GUID ID. ,
Required: False ,
}
string ,
status:
{
Description: Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the status to PendingFeaturing or Active through API. ,
Enum:
{
New: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
PendingDiscovering: No description available. ,
Discovering: No description available. ,
PendingFeaturing: No description available. ,
Featuring: No description available. ,
FeaturingFailed: No description available. ,
PendingTraining: No description available. ,
Training: No description available. ,
TrainingFailed: No description available. ,
Evaluating: No description available. ,
EvaluatingFailed: No description available. ,
PendingModelConfirmation: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The model status message. ,
Required: False ,
}
string ,
trainingSetCount:
{
Description: Count of the training set. ,
Required: False ,
}
integer ,
testSetCount:
{
Description: Count of the test set. ,
Required: False ,
}
integer ,
validationSetCount:
{
Description: Count of the validation set. ,
Required: False ,
}
integer ,
trainingAccuracy:
{
Description: The training accuracy. ,
Format: decimal ,
Required: False ,
}
integer ,
signalsUsed:
{
Description: The signals used. ,
Required: False ,
}
integer ,
modelVersion:
{
Description: Version of the model. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Predictions_ListByHub (new)
Description :  Gets all the predictions in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available Customer Insights REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomerInsights/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Customer Insights operations supported by the Microsoft.CustomerInsights resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.CustomerInsights ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Hubs_CreateOrUpdate (removed)
Description :  Creates a hub, or updates an existing hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the Hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Hub operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
Hubs_Update (removed)
Description :  Updates a Hub.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the Hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Hub operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
Hubs_Delete (removed)
Description :  Deletes the specified hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Hubs_Get (removed)
Description :  Gets information about the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
Hubs_ListByResourceGroup (removed)
Description :  Gets all the hubs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}
Hubs_List (removed)
Description :  Gets all hubs in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerInsights/hubs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of hub. ,
Required: False ,
}
{
apiEndpoint:
{
Description: API endpoint URL of the hub. ,
Required: False ,
}
string ,
webEndpoint:
{
Description: Web endpoint URL of the hub. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the hub. ,
Required: False ,
}
string ,
tenantFeatures:
{
Description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. ,
Required: False ,
}
integer ,
hubBillingInfo:
{
Description: Billing settings of the hub. ,
Required: False ,
}
{
skuName:
{
Description: The sku name. ,
Required: False ,
}
string ,
minUnits:
{
Description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
maxUnits:
{
Description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}
Profiles_CreateOrUpdate (removed)
Description :  Creates a profile within a Hub, or updates an existing profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/delete Profile type operation ,
Required: True ,
}
{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
Profiles_Get (removed)
Description :  Gets information about the specified profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of profile to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Profiles_Delete (removed)
Description :  Deletes a profile within a hub
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of profile to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Profiles_ListByHub (removed)
Description :  Gets all profile in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of profile to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The profile type definition. ,
Required: False ,
}
{
strongIds:
{
Description: The strong IDs. ,
Required: False ,
}
[
{
keyPropertyNames:
{
Description: The properties which make up the unique ID. ,
Required: True ,
}
[
string ,
]
,
strongIdName:
{
Description: The Name identifying the strong ID. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Profiles_GetEnrichingKpis (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}/getEnrichingKpis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the profile. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
Interactions_CreateOrUpdate (removed)
Description :  Creates an interaction or updates an existing interaction within a hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
interactionName:
{
Description: The name of the interaction. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Interaction operation. ,
Required: True ,
}
{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Interactions_Get (removed)
Description :  Gets information about the specified interaction.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions/{interactionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
interactionName:
{
Description: The name of the interaction. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of interaction to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}
Interactions_ListByHub (removed)
Description :  Gets all interactions in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
locale-code:
{
Description: Locale of interaction to retrieve, default is en-us. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Interaction Type Definition ,
Required: False ,
}
{
idPropertyNames:
{
Description: The id property names. Properties which uniquely identify an interaction instance. ,
Required: False ,
}
[
string ,
]
,
participantProfiles:
{
Description: Profiles that participated in the interaction. ,
Required: False ,
}
[
{
profileTypeName:
{
Description: Profile type name. ,
Required: True ,
}
string ,
participantPropertyReferences:
{
Description: The property references. ,
Required: True ,
}
[
{
sourcePropertyName:
{
Description: The source property that maps to the target property. ,
Required: True ,
}
string ,
targetPropertyName:
{
Description: The target property that maps to the source property. ,
Required: True ,
}
string ,
}
,
]
,
participantName:
{
Description: Participant name. ,
Required: True ,
}
string ,
displayName:
{
Description: Localized display name. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions. ,
Required: False ,
}
object ,
role:
{
Description: The role that the participant is playing in the interaction. ,
Required: False ,
}
string ,
}
,
]
,
primaryParticipantProfilePropertyName:
{
Description: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. ,
Required: False ,
}
string ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
defaultDataSource:
{
Description: Default data source is specifically used in cases where data source is not specified in an instance. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
isActivity:
{
Description: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Relationships_CreateOrUpdate (removed)
Description :  Creates a relationship or updates an existing relationship within a hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the Relationship. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Relationship operation. ,
Required: True ,
}
{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
Relationships_Get (removed)
Description :  Gets information about the specified relationship.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the relationship. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
Relationships_Delete (removed)
Description :  Deletes a relationship within a hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
relationshipName:
{
Description: The name of the relationship. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}
Relationships_ListByHub (removed)
Description :  Gets all relationships in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The definition of Relationship. ,
Required: False ,
}
{
cardinality:
{
Description: The Relationship Cardinality. ,
Enum:
{
OneToOne: No description available. ,
OneToMany: No description available. ,
ManyToMany: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Localized display name for the Relationship. ,
Required: False ,
}
object ,
description:
{
Description: Localized descriptions for the Relationship. ,
Required: False ,
}
object ,
expiryDateTimeUtc:
{
Description: The expiry date time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
fields:
{
Description: The properties of the Relationship. ,
Required: False ,
}
[
{
arrayValueSeparator:
{
Description: Array value separator for properties with isArray set. ,
Required: False ,
}
string ,
enumValidValues:
{
Description: Describes valid values for an enum property. ,
Required: False ,
}
[
{
value:
{
Description: The integer value of the enum member. ,
Required: False ,
}
integer ,
localizedValueNames:
{
Description: Localized names of the enum member. ,
Required: False ,
}
object ,
}
,
]
,
fieldName:
{
Description: Name of the property. ,
Required: True ,
}
string ,
fieldType:
{
Description: Type of the property. ,
Required: True ,
}
string ,
isArray:
{
Description: Indicates if the property is actually an array of the fieldType above on the data api. ,
Required: False ,
}
boolean ,
isEnum:
{
Description: Indicates if the property is an enum. ,
Required: False ,
}
boolean ,
isFlagEnum:
{
Description: Indicates if the property is an flag enum. ,
Required: False ,
}
boolean ,
isImage:
{
Description: Whether the property is an Image. ,
Required: False ,
}
boolean ,
isLocalizedString:
{
Description: Whether the property is a localized string. ,
Required: False ,
}
boolean ,
isName:
{
Description: Whether the property is a name or a part of name. ,
Required: False ,
}
boolean ,
isRequired:
{
Description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. ,
Required: False ,
}
boolean ,
propertyId:
{
Description: The ID associated with the property. ,
Required: False ,
}
string ,
schemaItemPropLink:
{
Description: URL encoded schema.org item prop link for the property. ,
Required: False ,
}
string ,
maxLength:
{
Description: Max length of string. Used only if type is string. ,
Required: False ,
}
integer ,
isAvailableInGraph:
{
Description: Whether property is available in graph or not. ,
Required: False ,
}
boolean ,
dataSourcePrecedenceRules:
{
Description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. ,
Required: False ,
}
[
{
dataSource:
{
Description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. ,
Required: False ,
}
{
name:
{
Description: The data source name ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
Connector: No description available. ,
LinkInteraction: No description available. ,
SystemDefault: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The data source status. ,
Enum:
{
None: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The data source ID. ,
Required: False ,
}
integer ,
dataSourceReferenceId:
{
Description: The data source reference id. ,
Required: False ,
}
string ,
}
,
precedence:
{
Description: the precedence value. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lookupMappings:
{
Description: Optional property to be used to map fields in profile to their strong ids in related profile. ,
Required: False ,
}
[
{
fieldMappings:
{
Description: Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. ,
Required: True ,
}
[
{
profileFieldName:
{
Description: Specifies the fieldName in profile. ,
Required: True ,
}
string ,
relatedProfileKeyProperty:
{
Description: Specifies the KeyProperty (from StrongId) of the related profile. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
profileType:
{
Description: Profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipName:
{
Description: The Relationship name. ,
Required: False ,
}
string ,
relatedProfileType:
{
Description: Related profile being referenced. ,
Required: True ,
}
string ,
relationshipGuidId:
{
Description: The relationship guid id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
AuthorizationPolicies_CreateOrUpdate (removed)
Description :  Creates an authorization policy or updates an existing authorization policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate authorization policy operation. ,
Required: True ,
}
{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
AuthorizationPolicies_Get (removed)
Description :  Gets an authorization policy in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
AuthorizationPolicies_ListByHub (removed)
Description :  Gets all the authorization policies in a specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The authorization policy. ,
Required: False ,
}
{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
AuthorizationPolicies_RegeneratePrimaryKey (removed)
Description :  Regenerates the primary policy key of the specified authorization policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
AuthorizationPolicies_RegenerateSecondaryKey (removed)
Description :  Regenerates the secondary policy key of the specified authorization policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
authorizationPolicyName:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policyName:
{
Description: Name of the policy. ,
Required: False ,
}
string ,
permissions:
{
Description: The permissions associated with the policy. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Primary key associated with the policy. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary key associated with the policy. ,
Required: False ,
}
string ,
}
Connectors_CreateOrUpdate (removed)
Description :  Creates a connector or updates an existing connector in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Connector operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
Connectors_Get (removed)
Description :  Gets a connector in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}
Connectors_Delete (removed)
Description :  Deletes a connector in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Connectors_ListByHub (removed)
Description :  Gets all the connectors in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of connector. ,
Required: False ,
}
{
connectorId:
{
Description: ID of the connector. ,
Required: False ,
}
integer ,
connectorName:
{
Description: Name of the connector. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the connector. ,
Required: False ,
}
string ,
description:
{
Description: Description of the connector. ,
Required: False ,
}
string ,
connectorProperties:
{
Description: The connector properties. ,
Required: True ,
}
object ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of connector. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Ready: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
isInternal:
{
Description: If this is an internal connector. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
ConnectorMappings_CreateOrUpdate (removed)
Description :  Creates a connector mapping or updates an existing connector mapping in the connector.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
mappingName:
{
Description: The name of the connector mapping. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate Connector Mapping operation. ,
Required: True ,
}
{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
ConnectorMappings_Get (removed)
Description :  Gets a connector mapping in the connector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
mappingName:
{
Description: The name of the connector mapping. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
ConnectorMappings_Delete (removed)
Description :  Deletes a connector mapping in the connector.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
mappingName:
{
Description: The name of the connector mapping. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ConnectorMappings_ListByConnector (removed)
Description :  Gets all the connector mappings in the specified connector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the connector. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The connector mapping definition. ,
Required: False ,
}
{
connectorName:
{
Description: The connector name. ,
Required: False ,
}
string ,
connectorType:
{
Description: Type of connector. ,
Enum:
{
None: No description available. ,
CRM: No description available. ,
AzureBlob: No description available. ,
Salesforce: No description available. ,
ExchangeOnline: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
entityType:
{
Description: Defines which entity type the file should map to. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
connectorMappingName:
{
Description: The connector mapping name ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the connector mapping. ,
Required: False ,
}
string ,
description:
{
Description: The description of the connector mapping. ,
Required: False ,
}
string ,
dataFormatId:
{
Description: The DataFormat ID. ,
Required: False ,
}
string ,
mappingProperties:
{
Description: The properties of the mapping. ,
Required: True ,
}
{
folderPath:
{
Description: The folder path for the mapping. ,
Required: False ,
}
string ,
fileFilter:
{
Description: The file filter for the mapping. ,
Required: False ,
}
string ,
hasHeader:
{
Description: If the file contains a header or not. ,
Required: False ,
}
boolean ,
errorManagement:
{
Description: The error management setting for the mapping. ,
Required: True ,
}
{
errorManagementType:
{
Description: The type of error management to use for the mapping. ,
Enum:
{
RejectAndContinue: No description available. ,
StopImport: No description available. ,
RejectUntilLimit: No description available. ,
}
,
Required: True ,
}
enum ,
errorLimit:
{
Description: The error limit allowed while importing data. ,
Required: False ,
}
integer ,
}
,
format:
{
Description: The format of mapping property. ,
Required: True ,
}
{
formatType:
{
Description: The type mapping format. ,
Enum:
{
TextFormat: No description available. ,
}
,
Required: True ,
}
enum ,
columnDelimiter:
{
Description: The character that signifies a break between columns. ,
Required: False ,
}
string ,
acceptLanguage:
{
Description: The oData language. ,
Required: False ,
}
string ,
quoteCharacter:
{
Description: Quote character, used to indicate enquoted fields. ,
Required: False ,
}
string ,
quoteEscapeCharacter:
{
Description: Escape character for quotes, can be the same as the quoteCharacter. ,
Required: False ,
}
string ,
arraySeparator:
{
Description: Character separating array elements. ,
Required: False ,
}
string ,
}
,
availability:
{
Description: The availability of mapping property. ,
Required: True ,
}
{
frequency:
{
Description: The frequency to update. ,
Enum:
{
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of the given frequency to use. ,
Required: True ,
}
integer ,
}
,
structure:
{
Description: Ingestion mapping information at property level. ,
Required: True ,
}
[
{
propertyName:
{
Description: The property name of the mapping entity. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name of the import file. ,
Required: True ,
}
string ,
customFormatSpecifier:
{
Description: Custom format specifier for input parsing. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Indicates if the column is encrypted. ,
Required: False ,
}
boolean ,
}
,
]
,
completeOperation:
{
Description: The operation after import is done. ,
Required: True ,
}
{
completionOperationType:
{
Description: The type of completion operation. ,
Enum:
{
DoNothing: No description available. ,
DeleteFile: No description available. ,
MoveFile: No description available. ,
}
,
Required: False ,
}
enum ,
destinationFolder:
{
Description: The destination folder where files will be moved to once the import is done. ,
Required: False ,
}
string ,
}
,
}
,
nextRunTime:
{
Description: The next run time based on customer's settings. ,
Format: date-time ,
Required: False ,
}
string ,
runId:
{
Description: The RunId. ,
Required: False ,
}
string ,
state:
{
Description: State of connector mapping. ,
Enum:
{
Creating: No description available. ,
Created: No description available. ,
Failed: No description available. ,
Ready: No description available. ,
Running: No description available. ,
Stopped: No description available. ,
Expiring: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Kpi_CreateOrUpdate (removed)
Description :  Creates a KPI or updates an existing KPI in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update KPI operation. ,
Required: True ,
}
{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
Kpi_Get (removed)
Description :  Gets a KPI in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Kpi_Delete (removed)
Description :  Deletes a KPI in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Kpi_Reprocess (removed)
Description :  Reprocesses the Kpi values of the specified KPI.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi/{kpiName}/reprocess
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
kpiName:
{
Description: The name of the KPI. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
Kpi_ListByHub (removed)
Description :  Gets all the KPIs in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/kpi
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Defines the KPI Threshold limits. ,
Required: False ,
}
{
entityType:
{
Description: The mapping entity type. ,
Enum:
{
None: No description available. ,
Profile: No description available. ,
Interaction: No description available. ,
Relationship: No description available. ,
}
,
Required: True ,
}
enum ,
entityTypeName:
{
Description: The mapping entity name. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
kpiName:
{
Description: The KPI name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the KPI. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the KPI. ,
Required: False ,
}
object ,
calculationWindow:
{
Description: The calculation window. ,
Enum:
{
Lifetime: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
}
,
Required: True ,
}
enum ,
calculationWindowFieldName:
{
Description: Name of calculation window field. ,
Required: False ,
}
string ,
function:
{
Description: The computation function for the KPI. ,
Enum:
{
Sum: No description available. ,
Avg: No description available. ,
Min: No description available. ,
Max: No description available. ,
Last: No description available. ,
Count: No description available. ,
None: No description available. ,
CountDistinct: No description available. ,
}
,
Required: True ,
}
enum ,
expression:
{
Description: The computation expression for the KPI. ,
Required: True ,
}
string ,
unit:
{
Description: The unit of measurement for the KPI. ,
Required: False ,
}
string ,
filter:
{
Description: The filter expression for the KPI. ,
Required: False ,
}
string ,
groupBy:
{
Description: the group by properties for the KPI. ,
Required: False ,
}
[
string ,
]
,
groupByMetadata:
{
Description: The KPI GroupByMetadata. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name. ,
Required: False ,
}
object ,
fieldName:
{
Description: The name of the field. ,
Required: False ,
}
string ,
fieldType:
{
Description: The type of the field. ,
Required: False ,
}
string ,
}
,
]
,
participantProfilesMetadata:
{
Description: The participant profiles. ,
Required: False ,
}
[
{
typeName:
{
Description: Name of the type. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
thresHolds:
{
Description: The KPI thresholds. ,
Required: False ,
}
{
lowerLimit:
{
Description: The lower threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
upperLimit:
{
Description: The upper threshold limit. ,
Format: decimal ,
Required: True ,
}
number ,
increasingKpi:
{
Description: Whether or not the KPI is an increasing KPI. ,
Required: True ,
}
boolean ,
}
,
aliases:
{
Description: The aliases. ,
Required: False ,
}
[
{
aliasName:
{
Description: KPI alias name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
extracts:
{
Description: The KPI extracts. ,
Required: False ,
}
[
{
extractName:
{
Description: KPI extract name. ,
Required: True ,
}
string ,
expression:
{
Description: The expression. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
WidgetTypes_ListByHub (removed)
Description :  Gets all available widget types in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/widgetTypes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Definition of WidgetType. ,
Required: False ,
}
{
widgetTypeName:
{
Description: Name of the widget type. ,
Required: False ,
}
string ,
definition:
{
Description: Definition for widget type. ,
Required: True ,
}
string ,
description:
{
Description: Description for widget type. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the widget type. ,
Required: False ,
}
object ,
imageUrl:
{
Description: The image URL. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
widgetVersion:
{
Description: The widget version. ,
Required: False ,
}
string ,
changed:
{
Description: Date time when widget type was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when widget type was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
WidgetTypes_Get (removed)
Description :  Gets a widget type in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/widgetTypes/{widgetTypeName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
widgetTypeName:
{
Description: The name of the widget type. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Definition of WidgetType. ,
Required: False ,
}
{
widgetTypeName:
{
Description: Name of the widget type. ,
Required: False ,
}
string ,
definition:
{
Description: Definition for widget type. ,
Required: True ,
}
string ,
description:
{
Description: Description for widget type. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the widget type. ,
Required: False ,
}
object ,
imageUrl:
{
Description: The image URL. ,
Required: False ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
widgetVersion:
{
Description: The widget version. ,
Required: False ,
}
string ,
changed:
{
Description: Date time when widget type was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when widget type was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Views_ListByHub (removed)
Description :  Gets all available views for given user in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID. Use * to retrieve hub level views. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
Views_CreateOrUpdate (removed)
Description :  Creates a view or updates an existing view in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
viewName:
{
Description: The name of the view. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate View operation. ,
Required: True ,
}
{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Views_Get (removed)
Description :  Gets a view in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
viewName:
{
Description: The name of the view. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID. Use * to retrieve hub level view. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The view in Customer 360 web application. ,
Required: False ,
}
{
viewName:
{
Description: Name of the view. ,
Required: False ,
}
string ,
userId:
{
Description: the user ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: the hub name. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name for the view. ,
Required: False ,
}
object ,
definition:
{
Description: View definition. ,
Required: True ,
}
string ,
changed:
{
Description: Date time when view was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: Date time when view was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Views_Delete (removed)
Description :  Deletes a view in the specified hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/views/{viewName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
viewName:
{
Description: The name of the view. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
userId:
{
Description: The user ID. Use * to retrieve hub level view. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Roles_ListByHub (removed)
Description :  Gets all the roles for the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roles
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Role definition. ,
Required: False ,
}
{
roleName:
{
Description: The role name. ,
Required: False ,
}
string ,
description:
{
Description: The description of the role. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
RoleAssignments_ListByHub (removed)
Description :  Gets all the role assignments for the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}
RoleAssignments_CreateOrUpdate (removed)
Description :  Creates or updates a role assignment in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
assignmentName:
{
Description: The assignment name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate RoleAssignment operation. ,
Required: True ,
}
{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{}
RoleAssignments_Get (removed)
Description :  Gets the role assignment in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
assignmentName:
{
Description: The name of the role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Role Assignment definition. ,
Required: False ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
assignmentName:
{
Description: The name of the metadata object. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display names for the metadata. ,
Required: False ,
}
object ,
description:
{
Description: Localized description for the metadata. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: Type of roles. ,
Enum:
{
Admin: No description available. ,
Reader: No description available. ,
ManageAdmin: No description available. ,
ManageReader: No description available. ,
DataAdmin: No description available. ,
DataReader: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The principals being assigned to. ,
Required: True ,
}
[
{
principalId:
{
Description: The principal id being assigned to. ,
Required: True ,
}
string ,
principalType:
{
Description: The Type of the principal ID. ,
Required: True ,
}
string ,
principalMetadata:
{
Description: Other metadata for the principal. ,
Required: False ,
}
object ,
}
,
]
,
profiles:
{
Description: Profiles set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
interactions:
{
Description: Interactions set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
links:
{
Description: Links set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
kpis:
{
Description: Kpis set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
sasPolicies:
{
Description: Sas Policies set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
connectors:
{
Description: Connectors set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
views:
{
Description: Views set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationshipLinks:
{
Description: The Role assignments set for the relationship links. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
relationships:
{
Description: The Role assignments set for the relationships. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
widgetTypes:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
roleAssignments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
conflationPolicies:
{
Description: Widget types set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
segments:
{
Description: The Role assignments set for the assignment. ,
Required: False ,
}
{
elements:
{
Description: The elements included in the set. ,
Required: False ,
}
[
string ,
]
,
exceptions:
{
Description: The elements that are not included in the set, in case elements contains '*' indicating 'all'. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
RoleAssignments_Delete (removed)
Description :  Deletes the role assignment in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roleAssignments/{assignmentName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
assignmentName:
{
Description: The name of the role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Images_GetUploadUrlForEntityType (removed)
Description :  Gets entity type (profile or interaction) image upload URL.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getEntityTypeImageUploadUrl
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the GetUploadUrlForEntityType operation. ,
Required: True ,
}
{
entityType:
{
Description: Type of entity. Can be Profile or Interaction. ,
Required: False ,
}
string ,
entityTypeName:
{
Description: Name of the entity type. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageExists:
{
Description: Whether image exists already. ,
Required: False ,
}
boolean ,
contentUrl:
{
Description: Content URL for the image blob. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
Images_GetUploadUrlForData (removed)
Description :  Gets data image upload URL.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/images/getDataImageUploadUrl
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the GetUploadUrlForData operation. ,
Required: True ,
}
{
entityType:
{
Description: Type of entity. Can be Profile or Interaction. ,
Required: False ,
}
string ,
entityTypeName:
{
Description: Name of the entity type. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageExists:
{
Description: Whether image exists already. ,
Required: False ,
}
boolean ,
contentUrl:
{
Description: Content URL for the image blob. ,
Required: False ,
}
string ,
relativePath:
{
Description: Relative path of the image. ,
Required: False ,
}
string ,
}
Predictions_CreateOrUpdate (removed)
Description :  Creates a Prediction or updates an existing Prediction in the hub.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update Prediction operation. ,
Required: True ,
}
{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{}
Predictions_Get (removed)
Description :  Gets a Prediction in the hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}
Predictions_Delete (removed)
Description :  Deletes a Prediction in the hub.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
Predictions_GetTrainingResults (removed)
Description :  Gets training results.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}/getTrainingResults
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
scoreName:
{
Description: Score name. ,
Required: False ,
}
string ,
predictionDistribution:
{
Description: Prediction distribution. ,
Required: False ,
}
{
totalPositives:
{
Description: Total positive in the distribution. ,
Format: int64 ,
Required: False ,
}
integer ,
totalNegatives:
{
Description: Total negatives in the distribution. ,
Format: int64 ,
Required: False ,
}
integer ,
distributions:
{
Description: Distributions of the prediction. ,
Required: False ,
}
[
{
scoreThreshold:
{
Description: Score threshold. ,
Required: False ,
}
integer ,
positives:
{
Description: Number of positives. ,
Format: int64 ,
Required: False ,
}
integer ,
negatives:
{
Description: Number of negatives. ,
Format: int64 ,
Required: False ,
}
integer ,
positivesAboveThreshold:
{
Description: Number of positives above threshold. ,
Format: int64 ,
Required: False ,
}
integer ,
negativesAboveThreshold:
{
Description: Number of negatives above threshold. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
canonicalProfiles:
{
Description: Canonical profiles. ,
Required: False ,
}
[
{
canonicalProfileId:
{
Description: Canonical profile ID. ,
Required: False ,
}
integer ,
properties:
{
Description: Properties of the canonical profile. ,
Required: False ,
}
[
{
profileName:
{
Description: Profile name. ,
Required: False ,
}
string ,
profilePropertyName:
{
Description: Property name of profile. ,
Required: False ,
}
string ,
rank:
{
Description: The rank. ,
Required: False ,
}
integer ,
type:
{
Description: Type of canonical property value. ,
Enum:
{
Numeric: No description available. ,
Categorical: No description available. ,
DerivedCategorical: No description available. ,
DerivedNumeric: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Value of the canonical property. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
primaryProfileInstanceCount:
{
Description: Instance count of the primary profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Predictions_GetModelStatus (removed)
Description :  Gets model status of the prediction.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}/getModelStatus
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
predictionName:
{
Description: The prediction name. ,
Required: False ,
}
string ,
predictionGuidId:
{
Description: The prediction GUID ID. ,
Required: False ,
}
string ,
status:
{
Description: Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the status to PendingFeaturing or Active through API. ,
Enum:
{
New: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
PendingDiscovering: No description available. ,
Discovering: No description available. ,
PendingFeaturing: No description available. ,
Featuring: No description available. ,
FeaturingFailed: No description available. ,
PendingTraining: No description available. ,
Training: No description available. ,
TrainingFailed: No description available. ,
Evaluating: No description available. ,
EvaluatingFailed: No description available. ,
PendingModelConfirmation: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The model status message. ,
Required: False ,
}
string ,
trainingSetCount:
{
Description: Count of the training set. ,
Required: False ,
}
integer ,
testSetCount:
{
Description: Count of the test set. ,
Required: False ,
}
integer ,
validationSetCount:
{
Description: Count of the validation set. ,
Required: False ,
}
integer ,
trainingAccuracy:
{
Description: The training accuracy. ,
Format: decimal ,
Required: False ,
}
integer ,
signalsUsed:
{
Description: The signals used. ,
Required: False ,
}
integer ,
modelVersion:
{
Description: Version of the model. ,
Required: False ,
}
string ,
}
Predictions_ModelStatus (removed)
Description :  Creates or updates the model status of prediction.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}/modelStatus
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
predictionName:
{
Description: The name of the Prediction. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update prediction model status operation. ,
Required: True ,
}
{
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
predictionName:
{
Description: The prediction name. ,
Required: False ,
}
string ,
predictionGuidId:
{
Description: The prediction GUID ID. ,
Required: False ,
}
string ,
status:
{
Description: Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the status to PendingFeaturing or Active through API. ,
Enum:
{
New: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
PendingDiscovering: No description available. ,
Discovering: No description available. ,
PendingFeaturing: No description available. ,
Featuring: No description available. ,
FeaturingFailed: No description available. ,
PendingTraining: No description available. ,
Training: No description available. ,
TrainingFailed: No description available. ,
Evaluating: No description available. ,
EvaluatingFailed: No description available. ,
PendingModelConfirmation: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The model status message. ,
Required: False ,
}
string ,
trainingSetCount:
{
Description: Count of the training set. ,
Required: False ,
}
integer ,
testSetCount:
{
Description: Count of the test set. ,
Required: False ,
}
integer ,
validationSetCount:
{
Description: Count of the validation set. ,
Required: False ,
}
integer ,
trainingAccuracy:
{
Description: The training accuracy. ,
Format: decimal ,
Required: False ,
}
integer ,
signalsUsed:
{
Description: The signals used. ,
Required: False ,
}
integer ,
modelVersion:
{
Description: Version of the model. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
Predictions_ListByHub (removed)
Description :  Gets all the predictions in the specified hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hubName:
{
Description: The name of the hub. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The prediction definition. ,
Required: False ,
}
{
description:
{
Description: Description of the prediction. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of the prediction. ,
Required: False ,
}
object ,
involvedInteractionTypes:
{
Description: Interaction types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedKpiTypes:
{
Description: KPI types involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
involvedRelationships:
{
Description: Relationships involved in the prediction. ,
Required: False ,
}
[
string ,
]
,
negativeOutcomeExpression:
{
Description: Negative outcome expression. ,
Required: True ,
}
string ,
positiveOutcomeExpression:
{
Description: Positive outcome expression. ,
Required: True ,
}
string ,
primaryProfileType:
{
Description: Primary profile type. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Provisioning: No description available. ,
Succeeded: No description available. ,
Expiring: No description available. ,
Deleting: No description available. ,
HumanIntervention: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
predictionName:
{
Description: Name of the prediction. ,
Required: False ,
}
string ,
scopeExpression:
{
Description: Scope expression. ,
Required: True ,
}
string ,
tenantId:
{
Description: The hub name. ,
Required: False ,
}
string ,
autoAnalyze:
{
Description: Whether do auto analyze. ,
Required: True ,
}
boolean ,
mappings:
{
Description: Definition of the link mapping of prediction. ,
Required: True ,
}
{
score:
{
Description: The score of the link mapping. ,
Required: True ,
}
string ,
grade:
{
Description: The grade of the link mapping. ,
Required: True ,
}
string ,
reason:
{
Description: The reason of the link mapping. ,
Required: True ,
}
string ,
}
,
scoreLabel:
{
Description: Score label. ,
Required: True ,
}
string ,
grades:
{
Description: The prediction grades. ,
Required: False ,
}
[
{
gradeName:
{
Description: Name of the grade. ,
Required: False ,
}
string ,
minScoreThreshold:
{
Description: Minimum score threshold. ,
Required: False ,
}
integer ,
maxScoreThreshold:
{
Description: Maximum score threshold. ,
Required: False ,
}
integer ,
}
,
]
,
systemGeneratedEntities:
{
Description: System generated entities. ,
Required: False ,
}
{
generatedInteractionTypes:
{
Description: Generated interaction types. ,
Required: False ,
}
[
string ,
]
,
generatedLinks:
{
Description: Generated links. ,
Required: False ,
}
[
string ,
]
,
generatedKpis:
{
Description: Generated KPIs. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}