import "github.com/Azure/azure-sdk-for-go/services/customerinsights/mgmt/2017-01-01/customerinsights"
Package customerinsights implements the Azure ARM Customerinsights service API version 2017-01-01.
The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
authorizationpolicies.go client.go connectormappings.go connectors.go enums.go hubs.go images.go interactions.go kpi.go links.go models.go operations.go profiles.go relationshiplinks.go relationships.go roleassignments.go roles.go version.go views.go widgettypes.go
const (
// DefaultBaseURI is the default URI used for the service Customerinsights
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type AssignmentPrincipal struct {
// PrincipalID - The principal id being assigned to.
PrincipalID *string `json:"principalId,omitempty"`
// PrincipalType - The Type of the principal ID.
PrincipalType *string `json:"principalType,omitempty"`
// PrincipalMetadata - Other metadata for the principal.
PrincipalMetadata map[string]*string `json:"principalMetadata"`
}AssignmentPrincipal the AssignmentPrincipal
func (ap AssignmentPrincipal) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AssignmentPrincipal.
type AuthorizationPoliciesClient struct {
BaseClient
}AuthorizationPoliciesClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewAuthorizationPoliciesClient(subscriptionID string) AuthorizationPoliciesClient
NewAuthorizationPoliciesClient creates an instance of the AuthorizationPoliciesClient client.
func NewAuthorizationPoliciesClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationPoliciesClient
NewAuthorizationPoliciesClientWithBaseURI creates an instance of the AuthorizationPoliciesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AuthorizationPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string, parameters AuthorizationPolicyResourceFormat) (result AuthorizationPolicyResourceFormat, err error)
CreateOrUpdate creates an authorization policy or updates an existing authorization policy. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. authorizationPolicyName - the name of the policy. parameters - parameters supplied to the CreateOrUpdate authorization policy operation.
func (client AuthorizationPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string, parameters AuthorizationPolicyResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AuthorizationPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result AuthorizationPolicyResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client AuthorizationPoliciesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationPoliciesClient) Get(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string) (result AuthorizationPolicyResourceFormat, err error)
Get gets an authorization policy in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. authorizationPolicyName - the name of the policy.
func (client AuthorizationPoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AuthorizationPoliciesClient) GetResponder(resp *http.Response) (result AuthorizationPolicyResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationPoliciesClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result AuthorizationPolicyListResultPage, err error)
ListByHub gets all the authorization policies in a specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client AuthorizationPoliciesClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result AuthorizationPolicyListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client AuthorizationPoliciesClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client AuthorizationPoliciesClient) ListByHubResponder(resp *http.Response) (result AuthorizationPolicyListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
func (client AuthorizationPoliciesClient) ListByHubSender(req *http.Request) (*http.Response, error)
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationPoliciesClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string) (result AuthorizationPolicy, err error)
RegeneratePrimaryKey regenerates the primary policy key of the specified authorization policy. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. authorizationPolicyName - the name of the policy.
func (client AuthorizationPoliciesClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string) (*http.Request, error)
RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.
func (client AuthorizationPoliciesClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result AuthorizationPolicy, err error)
RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.
func (client AuthorizationPoliciesClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)
RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationPoliciesClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string) (result AuthorizationPolicy, err error)
RegenerateSecondaryKey regenerates the secondary policy key of the specified authorization policy. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. authorizationPolicyName - the name of the policy.
func (client AuthorizationPoliciesClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string) (*http.Request, error)
RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.
func (client AuthorizationPoliciesClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result AuthorizationPolicy, err error)
RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.
func (client AuthorizationPoliciesClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)
RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.
type AuthorizationPolicy struct {
autorest.Response `json:"-"`
// PolicyName - READ-ONLY; Name of the policy.
PolicyName *string `json:"policyName,omitempty"`
// Permissions - The permissions associated with the policy.
Permissions *[]PermissionTypes `json:"permissions,omitempty"`
// PrimaryKey - Primary key associated with the policy.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - Secondary key associated with the policy.
SecondaryKey *string `json:"secondaryKey,omitempty"`
}AuthorizationPolicy the authorization policy.
func (ap AuthorizationPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AuthorizationPolicy.
type AuthorizationPolicyListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]AuthorizationPolicyResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}AuthorizationPolicyListResult the response of list authorization policy operation.
func (aplr AuthorizationPolicyListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AuthorizationPolicyListResultIterator struct {
// contains filtered or unexported fields
}AuthorizationPolicyListResultIterator provides access to a complete listing of AuthorizationPolicyResourceFormat values.
func NewAuthorizationPolicyListResultIterator(page AuthorizationPolicyListResultPage) AuthorizationPolicyListResultIterator
Creates a new instance of the AuthorizationPolicyListResultIterator type.
func (iter *AuthorizationPolicyListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AuthorizationPolicyListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AuthorizationPolicyListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AuthorizationPolicyListResultIterator) Response() AuthorizationPolicyListResult
Response returns the raw server response from the last page request.
func (iter AuthorizationPolicyListResultIterator) Value() AuthorizationPolicyResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AuthorizationPolicyListResultPage struct {
// contains filtered or unexported fields
}AuthorizationPolicyListResultPage contains a page of AuthorizationPolicyResourceFormat values.
func NewAuthorizationPolicyListResultPage(cur AuthorizationPolicyListResult, getNextPage func(context.Context, AuthorizationPolicyListResult) (AuthorizationPolicyListResult, error)) AuthorizationPolicyListResultPage
Creates a new instance of the AuthorizationPolicyListResultPage type.
func (page *AuthorizationPolicyListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AuthorizationPolicyListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AuthorizationPolicyListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AuthorizationPolicyListResultPage) Response() AuthorizationPolicyListResult
Response returns the raw server response from the last page request.
func (page AuthorizationPolicyListResultPage) Values() []AuthorizationPolicyResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type AuthorizationPolicyResourceFormat struct {
autorest.Response `json:"-"`
*AuthorizationPolicy `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}AuthorizationPolicyResourceFormat the authorization policy resource format.
func (aprf AuthorizationPolicyResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AuthorizationPolicyResourceFormat.
func (aprf *AuthorizationPolicyResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AuthorizationPolicyResourceFormat struct.
type AzureBlobConnectorProperties struct {
// ConnectionKeyVaultURL - The connection KeyVault URL.
ConnectionKeyVaultURL *string `json:"connectionKeyVaultUrl,omitempty"`
}AzureBlobConnectorProperties the Azure Blob connector properties.
BaseClient is the base client for Customerinsights.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CalculationWindowTypes enumerates the values for calculation window types.
const (
// Day ...
Day CalculationWindowTypes = "Day"
// Hour ...
Hour CalculationWindowTypes = "Hour"
// Lifetime ...
Lifetime CalculationWindowTypes = "Lifetime"
// Month ...
Month CalculationWindowTypes = "Month"
// Week ...
Week CalculationWindowTypes = "Week"
)func PossibleCalculationWindowTypesValues() []CalculationWindowTypes
PossibleCalculationWindowTypesValues returns an array of possible values for the CalculationWindowTypes const type.
CardinalityTypes enumerates the values for cardinality types.
const (
// ManyToMany ...
ManyToMany CardinalityTypes = "ManyToMany"
// OneToMany ...
OneToMany CardinalityTypes = "OneToMany"
// OneToOne ...
OneToOne CardinalityTypes = "OneToOne"
)func PossibleCardinalityTypesValues() []CardinalityTypes
PossibleCardinalityTypesValues returns an array of possible values for the CardinalityTypes const type.
CompletionOperationTypes enumerates the values for completion operation types.
const (
// DeleteFile ...
DeleteFile CompletionOperationTypes = "DeleteFile"
// DoNothing ...
DoNothing CompletionOperationTypes = "DoNothing"
// MoveFile ...
MoveFile CompletionOperationTypes = "MoveFile"
)func PossibleCompletionOperationTypesValues() []CompletionOperationTypes
PossibleCompletionOperationTypesValues returns an array of possible values for the CompletionOperationTypes const type.
type Connector struct {
// ConnectorID - READ-ONLY; ID of the connector.
ConnectorID *int32 `json:"connectorId,omitempty"`
// ConnectorName - Name of the connector.
ConnectorName *string `json:"connectorName,omitempty"`
// ConnectorType - Type of connector. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound'
ConnectorType ConnectorTypes `json:"connectorType,omitempty"`
// DisplayName - Display name of the connector.
DisplayName *string `json:"displayName,omitempty"`
// Description - Description of the connector.
Description *string `json:"description,omitempty"`
// ConnectorProperties - The connector properties.
ConnectorProperties map[string]interface{} `json:"connectorProperties"`
// Created - READ-ONLY; The created time.
Created *date.Time `json:"created,omitempty"`
// LastModified - READ-ONLY; The last modified time.
LastModified *date.Time `json:"lastModified,omitempty"`
// State - READ-ONLY; State of connector. Possible values include: 'ConnectorStatesCreating', 'ConnectorStatesCreated', 'ConnectorStatesReady', 'ConnectorStatesExpiring', 'ConnectorStatesDeleting', 'ConnectorStatesFailed'
State ConnectorStates `json:"state,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// IsInternal - If this is an internal connector.
IsInternal *bool `json:"isInternal,omitempty"`
}Connector properties of connector.
MarshalJSON is the custom marshaler for Connector.
type ConnectorListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ConnectorResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ConnectorListResult the response of list connector operation.
func (clr ConnectorListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ConnectorListResultIterator struct {
// contains filtered or unexported fields
}ConnectorListResultIterator provides access to a complete listing of ConnectorResourceFormat values.
func NewConnectorListResultIterator(page ConnectorListResultPage) ConnectorListResultIterator
Creates a new instance of the ConnectorListResultIterator type.
func (iter *ConnectorListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ConnectorListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ConnectorListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ConnectorListResultIterator) Response() ConnectorListResult
Response returns the raw server response from the last page request.
func (iter ConnectorListResultIterator) Value() ConnectorResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ConnectorListResultPage struct {
// contains filtered or unexported fields
}ConnectorListResultPage contains a page of ConnectorResourceFormat values.
func NewConnectorListResultPage(cur ConnectorListResult, getNextPage func(context.Context, ConnectorListResult) (ConnectorListResult, error)) ConnectorListResultPage
Creates a new instance of the ConnectorListResultPage type.
func (page *ConnectorListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ConnectorListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ConnectorListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ConnectorListResultPage) Response() ConnectorListResult
Response returns the raw server response from the last page request.
func (page ConnectorListResultPage) Values() []ConnectorResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type ConnectorMapping struct {
// ConnectorName - READ-ONLY; The connector name.
ConnectorName *string `json:"connectorName,omitempty"`
// ConnectorType - Type of connector. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound'
ConnectorType ConnectorTypes `json:"connectorType,omitempty"`
// Created - READ-ONLY; The created time.
Created *date.Time `json:"created,omitempty"`
// LastModified - READ-ONLY; The last modified time.
LastModified *date.Time `json:"lastModified,omitempty"`
// EntityType - Defines which entity type the file should map to. Possible values include: 'EntityTypesNone', 'EntityTypesProfile', 'EntityTypesInteraction', 'EntityTypesRelationship'
EntityType EntityTypes `json:"entityType,omitempty"`
// EntityTypeName - The mapping entity name.
EntityTypeName *string `json:"entityTypeName,omitempty"`
// ConnectorMappingName - READ-ONLY; The connector mapping name
ConnectorMappingName *string `json:"connectorMappingName,omitempty"`
// DisplayName - Display name for the connector mapping.
DisplayName *string `json:"displayName,omitempty"`
// Description - The description of the connector mapping.
Description *string `json:"description,omitempty"`
// DataFormatID - READ-ONLY; The DataFormat ID.
DataFormatID *string `json:"dataFormatId,omitempty"`
// MappingProperties - The properties of the mapping.
MappingProperties *ConnectorMappingProperties `json:"mappingProperties,omitempty"`
// NextRunTime - READ-ONLY; The next run time based on customer's settings.
NextRunTime *date.Time `json:"nextRunTime,omitempty"`
// RunID - READ-ONLY; The RunId.
RunID *string `json:"runId,omitempty"`
// State - READ-ONLY; State of connector mapping. Possible values include: 'Creating', 'Created', 'Failed', 'Ready', 'Running', 'Stopped', 'Expiring'
State ConnectorMappingStates `json:"state,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
}ConnectorMapping the connector mapping definition.
func (cm ConnectorMapping) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ConnectorMapping.
type ConnectorMappingAvailability struct {
// Frequency - The frequency to update. Possible values include: 'FrequencyTypesMinute', 'FrequencyTypesHour', 'FrequencyTypesDay', 'FrequencyTypesWeek', 'FrequencyTypesMonth'
Frequency FrequencyTypes `json:"frequency,omitempty"`
// Interval - The interval of the given frequency to use.
Interval *int32 `json:"interval,omitempty"`
}ConnectorMappingAvailability connector mapping property availability.
type ConnectorMappingCompleteOperation struct {
// CompletionOperationType - The type of completion operation. Possible values include: 'DoNothing', 'DeleteFile', 'MoveFile'
CompletionOperationType CompletionOperationTypes `json:"completionOperationType,omitempty"`
// DestinationFolder - The destination folder where files will be moved to once the import is done.
DestinationFolder *string `json:"destinationFolder,omitempty"`
}ConnectorMappingCompleteOperation the complete operation.
type ConnectorMappingErrorManagement struct {
// ErrorManagementType - The type of error management to use for the mapping. Possible values include: 'RejectAndContinue', 'StopImport', 'RejectUntilLimit'
ErrorManagementType ErrorManagementTypes `json:"errorManagementType,omitempty"`
// ErrorLimit - The error limit allowed while importing data.
ErrorLimit *int32 `json:"errorLimit,omitempty"`
}ConnectorMappingErrorManagement the error management.
type ConnectorMappingFormat struct {
// FormatType - The type mapping format.
FormatType *string `json:"formatType,omitempty"`
// ColumnDelimiter - The character that signifies a break between columns.
ColumnDelimiter *string `json:"columnDelimiter,omitempty"`
// AcceptLanguage - The oData language.
AcceptLanguage *string `json:"acceptLanguage,omitempty"`
// QuoteCharacter - Quote character, used to indicate enquoted fields.
QuoteCharacter *string `json:"quoteCharacter,omitempty"`
// QuoteEscapeCharacter - Escape character for quotes, can be the same as the quoteCharacter.
QuoteEscapeCharacter *string `json:"quoteEscapeCharacter,omitempty"`
// ArraySeparator - Character separating array elements.
ArraySeparator *string `json:"arraySeparator,omitempty"`
}ConnectorMappingFormat connector mapping property format.
type ConnectorMappingListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ConnectorMappingResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ConnectorMappingListResult the response of list connector mapping operation.
func (cmlr ConnectorMappingListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ConnectorMappingListResultIterator struct {
// contains filtered or unexported fields
}ConnectorMappingListResultIterator provides access to a complete listing of ConnectorMappingResourceFormat values.
func NewConnectorMappingListResultIterator(page ConnectorMappingListResultPage) ConnectorMappingListResultIterator
Creates a new instance of the ConnectorMappingListResultIterator type.
func (iter *ConnectorMappingListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ConnectorMappingListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ConnectorMappingListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ConnectorMappingListResultIterator) Response() ConnectorMappingListResult
Response returns the raw server response from the last page request.
func (iter ConnectorMappingListResultIterator) Value() ConnectorMappingResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ConnectorMappingListResultPage struct {
// contains filtered or unexported fields
}ConnectorMappingListResultPage contains a page of ConnectorMappingResourceFormat values.
func NewConnectorMappingListResultPage(cur ConnectorMappingListResult, getNextPage func(context.Context, ConnectorMappingListResult) (ConnectorMappingListResult, error)) ConnectorMappingListResultPage
Creates a new instance of the ConnectorMappingListResultPage type.
func (page *ConnectorMappingListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ConnectorMappingListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ConnectorMappingListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ConnectorMappingListResultPage) Response() ConnectorMappingListResult
Response returns the raw server response from the last page request.
func (page ConnectorMappingListResultPage) Values() []ConnectorMappingResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type ConnectorMappingProperties struct {
// FolderPath - The folder path for the mapping.
FolderPath *string `json:"folderPath,omitempty"`
// FileFilter - The file filter for the mapping.
FileFilter *string `json:"fileFilter,omitempty"`
// HasHeader - If the file contains a header or not.
HasHeader *bool `json:"hasHeader,omitempty"`
// ErrorManagement - The error management setting for the mapping.
ErrorManagement *ConnectorMappingErrorManagement `json:"errorManagement,omitempty"`
// Format - The format of mapping property.
Format *ConnectorMappingFormat `json:"format,omitempty"`
// Availability - The availability of mapping property.
Availability *ConnectorMappingAvailability `json:"availability,omitempty"`
// Structure - Ingestion mapping information at property level.
Structure *[]ConnectorMappingStructure `json:"structure,omitempty"`
// CompleteOperation - The operation after import is done.
CompleteOperation *ConnectorMappingCompleteOperation `json:"completeOperation,omitempty"`
}ConnectorMappingProperties the connector mapping properties.
type ConnectorMappingResourceFormat struct {
autorest.Response `json:"-"`
*ConnectorMapping `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}ConnectorMappingResourceFormat the connector mapping resource format.
func (cmrf ConnectorMappingResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ConnectorMappingResourceFormat.
func (cmrf *ConnectorMappingResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ConnectorMappingResourceFormat struct.
ConnectorMappingStates enumerates the values for connector mapping states.
const (
// Created ...
Created ConnectorMappingStates = "Created"
// Creating ...
Creating ConnectorMappingStates = "Creating"
// Expiring ...
Expiring ConnectorMappingStates = "Expiring"
// Failed ...
Failed ConnectorMappingStates = "Failed"
// Ready ...
Ready ConnectorMappingStates = "Ready"
// Running ...
Running ConnectorMappingStates = "Running"
// Stopped ...
Stopped ConnectorMappingStates = "Stopped"
)func PossibleConnectorMappingStatesValues() []ConnectorMappingStates
PossibleConnectorMappingStatesValues returns an array of possible values for the ConnectorMappingStates const type.
type ConnectorMappingStructure struct {
// PropertyName - The property name of the mapping entity.
PropertyName *string `json:"propertyName,omitempty"`
// ColumnName - The column name of the import file.
ColumnName *string `json:"columnName,omitempty"`
// CustomFormatSpecifier - Custom format specifier for input parsing.
CustomFormatSpecifier *string `json:"customFormatSpecifier,omitempty"`
// IsEncrypted - Indicates if the column is encrypted.
IsEncrypted *bool `json:"isEncrypted,omitempty"`
}ConnectorMappingStructure connector mapping property structure.
type ConnectorMappingsClient struct {
BaseClient
}ConnectorMappingsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewConnectorMappingsClient(subscriptionID string) ConnectorMappingsClient
NewConnectorMappingsClient creates an instance of the ConnectorMappingsClient client.
func NewConnectorMappingsClientWithBaseURI(baseURI string, subscriptionID string) ConnectorMappingsClient
NewConnectorMappingsClientWithBaseURI creates an instance of the ConnectorMappingsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ConnectorMappingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string, parameters ConnectorMappingResourceFormat) (result ConnectorMappingResourceFormat, err error)
CreateOrUpdate creates a connector mapping or updates an existing connector mapping in the connector. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector. mappingName - the name of the connector mapping. parameters - parameters supplied to the CreateOrUpdate Connector Mapping operation.
func (client ConnectorMappingsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string, parameters ConnectorMappingResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ConnectorMappingsClient) CreateOrUpdateResponder(resp *http.Response) (result ConnectorMappingResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ConnectorMappingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ConnectorMappingsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string) (result autorest.Response, err error)
Delete deletes a connector mapping in the connector. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector. mappingName - the name of the connector mapping.
func (client ConnectorMappingsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ConnectorMappingsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ConnectorMappingsClient) Get(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string) (result ConnectorMappingResourceFormat, err error)
Get gets a connector mapping in the connector. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector. mappingName - the name of the connector mapping.
func (client ConnectorMappingsClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ConnectorMappingsClient) GetResponder(resp *http.Response) (result ConnectorMappingResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ConnectorMappingsClient) ListByConnector(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (result ConnectorMappingListResultPage, err error)
ListByConnector gets all the connector mappings in the specified connector. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector.
func (client ConnectorMappingsClient) ListByConnectorComplete(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (result ConnectorMappingListResultIterator, err error)
ListByConnectorComplete enumerates all values, automatically crossing page boundaries as required.
func (client ConnectorMappingsClient) ListByConnectorPreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (*http.Request, error)
ListByConnectorPreparer prepares the ListByConnector request.
func (client ConnectorMappingsClient) ListByConnectorResponder(resp *http.Response) (result ConnectorMappingListResult, err error)
ListByConnectorResponder handles the response to the ListByConnector request. The method always closes the http.Response Body.
func (client ConnectorMappingsClient) ListByConnectorSender(req *http.Request) (*http.Response, error)
ListByConnectorSender sends the ListByConnector request. The method will close the http.Response Body if it receives an error.
type ConnectorResourceFormat struct {
autorest.Response `json:"-"`
*Connector `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}ConnectorResourceFormat the connector resource format.
func (crf ConnectorResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ConnectorResourceFormat.
func (crf *ConnectorResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ConnectorResourceFormat struct.
ConnectorStates enumerates the values for connector states.
const (
// ConnectorStatesCreated ...
ConnectorStatesCreated ConnectorStates = "Created"
// ConnectorStatesCreating ...
ConnectorStatesCreating ConnectorStates = "Creating"
// ConnectorStatesDeleting ...
ConnectorStatesDeleting ConnectorStates = "Deleting"
// ConnectorStatesExpiring ...
ConnectorStatesExpiring ConnectorStates = "Expiring"
// ConnectorStatesFailed ...
ConnectorStatesFailed ConnectorStates = "Failed"
// ConnectorStatesReady ...
ConnectorStatesReady ConnectorStates = "Ready"
)func PossibleConnectorStatesValues() []ConnectorStates
PossibleConnectorStatesValues returns an array of possible values for the ConnectorStates const type.
ConnectorTypes enumerates the values for connector types.
const (
// AzureBlob ...
AzureBlob ConnectorTypes = "AzureBlob"
// CRM ...
CRM ConnectorTypes = "CRM"
// ExchangeOnline ...
ExchangeOnline ConnectorTypes = "ExchangeOnline"
// None ...
None ConnectorTypes = "None"
// Outbound ...
Outbound ConnectorTypes = "Outbound"
// Salesforce ...
Salesforce ConnectorTypes = "Salesforce"
)func PossibleConnectorTypesValues() []ConnectorTypes
PossibleConnectorTypesValues returns an array of possible values for the ConnectorTypes const type.
type ConnectorsClient struct {
BaseClient
}ConnectorsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewConnectorsClient(subscriptionID string) ConnectorsClient
NewConnectorsClient creates an instance of the ConnectorsClient client.
func NewConnectorsClientWithBaseURI(baseURI string, subscriptionID string) ConnectorsClient
NewConnectorsClientWithBaseURI creates an instance of the ConnectorsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ConnectorsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, connectorName string, parameters ConnectorResourceFormat) (result ConnectorsCreateOrUpdateFuture, err error)
CreateOrUpdate creates a connector or updates an existing connector in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector. parameters - parameters supplied to the CreateOrUpdate Connector operation.
func (client ConnectorsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string, parameters ConnectorResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ConnectorsClient) CreateOrUpdateResponder(resp *http.Response) (result ConnectorResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ConnectorsClient) CreateOrUpdateSender(req *http.Request) (future ConnectorsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ConnectorsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (result ConnectorsDeleteFuture, err error)
Delete deletes a connector in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector.
func (client ConnectorsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ConnectorsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ConnectorsClient) DeleteSender(req *http.Request) (future ConnectorsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ConnectorsClient) Get(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (result ConnectorResourceFormat, err error)
Get gets a connector in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. connectorName - the name of the connector.
func (client ConnectorsClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, connectorName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ConnectorsClient) GetResponder(resp *http.Response) (result ConnectorResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ConnectorsClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result ConnectorListResultPage, err error)
ListByHub gets all the connectors in the specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client ConnectorsClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result ConnectorListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client ConnectorsClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client ConnectorsClient) ListByHubResponder(resp *http.Response) (result ConnectorListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type ConnectorsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ConnectorsClient) (ConnectorResourceFormat, error)
}ConnectorsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ConnectorsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ConnectorsClient) (autorest.Response, error)
}ConnectorsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CrmConnectorEntities struct {
// LogicalName - The logical name.
LogicalName *string `json:"logicalName,omitempty"`
// DisplayName - The display name.
DisplayName *string `json:"displayName,omitempty"`
// IsProfile - Indicating whether this is profile.
IsProfile *bool `json:"isProfile,omitempty"`
}CrmConnectorEntities the CRM connector entities.
type CrmConnectorProperties struct {
// ConnectionString - The connection string.
ConnectionString *string `json:"connectionString,omitempty"`
// OrganizationID - The organization ID.
OrganizationID *string `json:"organizationId,omitempty"`
// OrganizationURL - The organization URL.
OrganizationURL *string `json:"organizationUrl,omitempty"`
// Entities - The entities like account, contact, opportunity.
Entities *[]CrmConnectorEntities `json:"entities,omitempty"`
// AccessToken - The access token.
AccessToken *string `json:"accessToken,omitempty"`
}CrmConnectorProperties the CRM connector properties.
type DataSource struct {
// Name - READ-ONLY; The data source name
Name *string `json:"name,omitempty"`
// DataSourceType - READ-ONLY; The data source type. Possible values include: 'DataSourceTypeConnector', 'DataSourceTypeLinkInteraction', 'DataSourceTypeSystemDefault'
DataSourceType DataSourceType `json:"dataSourceType,omitempty"`
// Status - READ-ONLY; The data source status. Possible values include: 'StatusNone', 'StatusActive', 'StatusDeleted'
Status Status `json:"status,omitempty"`
// ID - READ-ONLY; The data source ID.
ID *int32 `json:"id,omitempty"`
// DataSourceReferenceID - READ-ONLY; The data source reference id.
DataSourceReferenceID *string `json:"dataSourceReferenceId,omitempty"`
}DataSource 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.
type DataSourcePrecedence struct {
*DataSource `json:"dataSource,omitempty"`
// Precedence - the precedence value.
Precedence *int32 `json:"precedence,omitempty"`
}DataSourcePrecedence the data source precedence is a way to know the precedence of each data source.
func (dsp DataSourcePrecedence) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataSourcePrecedence.
func (dsp *DataSourcePrecedence) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DataSourcePrecedence struct.
DataSourceType enumerates the values for data source type.
const (
// DataSourceTypeConnector ...
DataSourceTypeConnector DataSourceType = "Connector"
// DataSourceTypeLinkInteraction ...
DataSourceTypeLinkInteraction DataSourceType = "LinkInteraction"
// DataSourceTypeSystemDefault ...
DataSourceTypeSystemDefault DataSourceType = "SystemDefault"
)func PossibleDataSourceTypeValues() []DataSourceType
PossibleDataSourceTypeValues returns an array of possible values for the DataSourceType const type.
type EnrichingKpi struct {
// EntityType - The mapping entity type. Possible values include: 'EntityTypesNone', 'EntityTypesProfile', 'EntityTypesInteraction', 'EntityTypesRelationship'
EntityType EntityTypes `json:"entityType,omitempty"`
// EntityTypeName - The mapping entity name.
EntityTypeName *string `json:"entityTypeName,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// KpiName - READ-ONLY; The KPI name.
KpiName *string `json:"kpiName,omitempty"`
// DisplayName - Localized display name for the KPI.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized description for the KPI.
Description map[string]*string `json:"description"`
// CalculationWindow - The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'
CalculationWindow CalculationWindowTypes `json:"calculationWindow,omitempty"`
// CalculationWindowFieldName - Name of calculation window field.
CalculationWindowFieldName *string `json:"calculationWindowFieldName,omitempty"`
// Function - The computation function for the KPI. Possible values include: 'KpiFunctionsSum', 'KpiFunctionsAvg', 'KpiFunctionsMin', 'KpiFunctionsMax', 'KpiFunctionsLast', 'KpiFunctionsCount', 'KpiFunctionsNone', 'KpiFunctionsCountDistinct'
Function KpiFunctions `json:"function,omitempty"`
// Expression - The computation expression for the KPI.
Expression *string `json:"expression,omitempty"`
// Unit - The unit of measurement for the KPI.
Unit *string `json:"unit,omitempty"`
// Filter - The filter expression for the KPI.
Filter *string `json:"filter,omitempty"`
// GroupBy - the group by properties for the KPI.
GroupBy *[]string `json:"groupBy,omitempty"`
// GroupByMetadata - READ-ONLY; The KPI GroupByMetadata.
GroupByMetadata *[]KpiGroupByMetadata `json:"groupByMetadata,omitempty"`
// ParticipantProfilesMetadata - READ-ONLY; The participant profiles.
ParticipantProfilesMetadata *[]KpiParticipantProfilesMetadata `json:"participantProfilesMetadata,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// ThresHolds - The KPI thresholds.
ThresHolds *KpiThresholds `json:"thresHolds,omitempty"`
// Aliases - The aliases.
Aliases *[]KpiAlias `json:"aliases,omitempty"`
// Extracts - The KPI extracts.
Extracts *[]KpiExtract `json:"extracts,omitempty"`
}EnrichingKpi the enriching KPI definition.
func (ek EnrichingKpi) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EnrichingKpi.
type EntityTypeDefinition struct {
// APIEntitySetName - The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
APIEntitySetName *string `json:"apiEntitySetName,omitempty"`
// EntityType - Type of entity. Possible values include: 'EntityTypesNone', 'EntityTypesProfile', 'EntityTypesInteraction', 'EntityTypesRelationship'
EntityType EntityTypes `json:"entityType,omitempty"`
// Fields - The properties of the Profile.
Fields *[]PropertyDefinition `json:"fields,omitempty"`
// InstancesCount - The instance count.
InstancesCount *int32 `json:"instancesCount,omitempty"`
// LastChangedUtc - READ-ONLY; The last changed time for the type definition.
LastChangedUtc *date.Time `json:"lastChangedUtc,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// SchemaItemTypeLink - The schema org link. This helps ACI identify and suggest semantic models.
SchemaItemTypeLink *string `json:"schemaItemTypeLink,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// TimestampFieldName - The timestamp property name. Represents the time when the interaction or profile update happened.
TimestampFieldName *string `json:"timestampFieldName,omitempty"`
// TypeName - The name of the entity.
TypeName *string `json:"typeName,omitempty"`
// Attributes - The attributes for the Type.
Attributes map[string][]string `json:"attributes"`
// Description - Localized descriptions for the property.
Description map[string]*string `json:"description"`
// DisplayName - Localized display names for the property.
DisplayName map[string]*string `json:"displayName"`
// LocalizedAttributes - Any custom localized attributes for the Type.
LocalizedAttributes map[string]map[string]*string `json:"localizedAttributes"`
// SmallImage - Small Image associated with the Property or EntityType.
SmallImage *string `json:"smallImage,omitempty"`
// MediumImage - Medium Image associated with the Property or EntityType.
MediumImage *string `json:"mediumImage,omitempty"`
// LargeImage - Large Image associated with the Property or EntityType.
LargeImage *string `json:"largeImage,omitempty"`
}EntityTypeDefinition describes an entity.
func (etd EntityTypeDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EntityTypeDefinition.
EntityTypes enumerates the values for entity types.
const (
// EntityTypesInteraction ...
EntityTypesInteraction EntityTypes = "Interaction"
// EntityTypesNone ...
EntityTypesNone EntityTypes = "None"
// EntityTypesProfile ...
EntityTypesProfile EntityTypes = "Profile"
// EntityTypesRelationship ...
EntityTypesRelationship EntityTypes = "Relationship"
)func PossibleEntityTypesValues() []EntityTypes
PossibleEntityTypesValues returns an array of possible values for the EntityTypes const type.
ErrorManagementTypes enumerates the values for error management types.
const (
// RejectAndContinue ...
RejectAndContinue ErrorManagementTypes = "RejectAndContinue"
// RejectUntilLimit ...
RejectUntilLimit ErrorManagementTypes = "RejectUntilLimit"
// StopImport ...
StopImport ErrorManagementTypes = "StopImport"
)func PossibleErrorManagementTypesValues() []ErrorManagementTypes
PossibleErrorManagementTypesValues returns an array of possible values for the ErrorManagementTypes const type.
FrequencyTypes enumerates the values for frequency types.
const (
// FrequencyTypesDay ...
FrequencyTypesDay FrequencyTypes = "Day"
// FrequencyTypesHour ...
FrequencyTypesHour FrequencyTypes = "Hour"
// FrequencyTypesMinute ...
FrequencyTypesMinute FrequencyTypes = "Minute"
// FrequencyTypesMonth ...
FrequencyTypesMonth FrequencyTypes = "Month"
// FrequencyTypesWeek ...
FrequencyTypesWeek FrequencyTypes = "Week"
)func PossibleFrequencyTypesValues() []FrequencyTypes
PossibleFrequencyTypesValues returns an array of possible values for the FrequencyTypes const type.
type GetImageUploadURLInput struct {
// EntityType - Type of entity. Can be Profile or Interaction.
EntityType *string `json:"entityType,omitempty"`
// EntityTypeName - Name of the entity type.
EntityTypeName *string `json:"entityTypeName,omitempty"`
// RelativePath - Relative path of the image.
RelativePath *string `json:"relativePath,omitempty"`
}GetImageUploadURLInput input type for getting image upload url.
type Hub struct {
autorest.Response `json:"-"`
*HubPropertiesFormat `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}Hub hub resource.
MarshalJSON is the custom marshaler for Hub.
UnmarshalJSON is the custom unmarshaler for Hub struct.
type HubBillingInfoFormat struct {
// SkuName - The sku name.
SkuName *string `json:"skuName,omitempty"`
// MinUnits - The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions.
MinUnits *int32 `json:"minUnits,omitempty"`
// MaxUnits - The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions.
MaxUnits *int32 `json:"maxUnits,omitempty"`
}HubBillingInfoFormat hub billing info.
type HubListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Hub `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}HubListResult response of list hub operation.
func (hlr HubListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type HubListResultIterator struct {
// contains filtered or unexported fields
}HubListResultIterator provides access to a complete listing of Hub values.
func NewHubListResultIterator(page HubListResultPage) HubListResultIterator
Creates a new instance of the HubListResultIterator type.
func (iter *HubListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *HubListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter HubListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter HubListResultIterator) Response() HubListResult
Response returns the raw server response from the last page request.
func (iter HubListResultIterator) Value() Hub
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type HubListResultPage struct {
// contains filtered or unexported fields
}HubListResultPage contains a page of Hub values.
func NewHubListResultPage(cur HubListResult, getNextPage func(context.Context, HubListResult) (HubListResult, error)) HubListResultPage
Creates a new instance of the HubListResultPage type.
func (page *HubListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *HubListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page HubListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page HubListResultPage) Response() HubListResult
Response returns the raw server response from the last page request.
func (page HubListResultPage) Values() []Hub
Values returns the slice of values for the current page or nil if there are no values.
type HubPropertiesFormat struct {
// APIEndpoint - READ-ONLY; API endpoint URL of the hub.
APIEndpoint *string `json:"apiEndpoint,omitempty"`
// WebEndpoint - READ-ONLY; Web endpoint URL of the hub.
WebEndpoint *string `json:"webEndpoint,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state of the hub.
ProvisioningState *string `json:"provisioningState,omitempty"`
// TenantFeatures - 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.
TenantFeatures *int32 `json:"tenantFeatures,omitempty"`
// HubBillingInfo - Billing settings of the hub.
HubBillingInfo *HubBillingInfoFormat `json:"hubBillingInfo,omitempty"`
}HubPropertiesFormat properties of hub.
func (hpf HubPropertiesFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HubPropertiesFormat.
type HubsClient struct {
BaseClient
}HubsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewHubsClient(subscriptionID string) HubsClient
NewHubsClient creates an instance of the HubsClient client.
func NewHubsClientWithBaseURI(baseURI string, subscriptionID string) HubsClient
NewHubsClientWithBaseURI creates an instance of the HubsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client HubsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, parameters Hub) (result Hub, err error)
CreateOrUpdate creates a hub, or updates an existing hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the Hub. parameters - parameters supplied to the CreateOrUpdate Hub operation.
func (client HubsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, parameters Hub) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client HubsClient) Delete(ctx context.Context, resourceGroupName string, hubName string) (result HubsDeleteFuture, err error)
Delete deletes the specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client HubsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client HubsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client HubsClient) DeleteSender(req *http.Request) (future HubsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client HubsClient) Get(ctx context.Context, resourceGroupName string, hubName string) (result Hub, err error)
Get gets information about the specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client HubsClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client HubsClient) List(ctx context.Context) (result HubListResultPage, err error)
List gets all hubs in the specified subscription.
func (client HubsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result HubListResultPage, err error)
ListByResourceGroup gets all the hubs in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client HubsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result HubListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client HubsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client HubsClient) ListByResourceGroupResponder(resp *http.Response) (result HubListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client HubsClient) ListComplete(ctx context.Context) (result HubListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client HubsClient) ListResponder(resp *http.Response) (result HubListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client HubsClient) Update(ctx context.Context, resourceGroupName string, hubName string, parameters Hub) (result Hub, err error)
Update updates a Hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the Hub. parameters - parameters supplied to the Update Hub operation.
func (client HubsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, parameters Hub) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type HubsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(HubsClient) (autorest.Response, error)
}HubsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImageDefinition struct {
autorest.Response `json:"-"`
// ImageExists - Whether image exists already.
ImageExists *bool `json:"imageExists,omitempty"`
// ContentURL - Content URL for the image blob.
ContentURL *string `json:"contentUrl,omitempty"`
// RelativePath - Relative path of the image.
RelativePath *string `json:"relativePath,omitempty"`
}ImageDefinition the image definition.
type ImagesClient struct {
BaseClient
}ImagesClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewImagesClient(subscriptionID string) ImagesClient
NewImagesClient creates an instance of the ImagesClient client.
func NewImagesClientWithBaseURI(baseURI string, subscriptionID string) ImagesClient
NewImagesClientWithBaseURI creates an instance of the ImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ImagesClient) GetUploadURLForData(ctx context.Context, resourceGroupName string, hubName string, parameters GetImageUploadURLInput) (result ImageDefinition, err error)
GetUploadURLForData gets data image upload URL. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. parameters - parameters supplied to the GetUploadUrlForData operation.
func (client ImagesClient) GetUploadURLForDataPreparer(ctx context.Context, resourceGroupName string, hubName string, parameters GetImageUploadURLInput) (*http.Request, error)
GetUploadURLForDataPreparer prepares the GetUploadURLForData request.
func (client ImagesClient) GetUploadURLForDataResponder(resp *http.Response) (result ImageDefinition, err error)
GetUploadURLForDataResponder handles the response to the GetUploadURLForData request. The method always closes the http.Response Body.
GetUploadURLForDataSender sends the GetUploadURLForData request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) GetUploadURLForEntityType(ctx context.Context, resourceGroupName string, hubName string, parameters GetImageUploadURLInput) (result ImageDefinition, err error)
GetUploadURLForEntityType gets entity type (profile or interaction) image upload URL. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. parameters - parameters supplied to the GetUploadUrlForEntityType operation.
func (client ImagesClient) GetUploadURLForEntityTypePreparer(ctx context.Context, resourceGroupName string, hubName string, parameters GetImageUploadURLInput) (*http.Request, error)
GetUploadURLForEntityTypePreparer prepares the GetUploadURLForEntityType request.
func (client ImagesClient) GetUploadURLForEntityTypeResponder(resp *http.Response) (result ImageDefinition, err error)
GetUploadURLForEntityTypeResponder handles the response to the GetUploadURLForEntityType request. The method always closes the http.Response Body.
func (client ImagesClient) GetUploadURLForEntityTypeSender(req *http.Request) (*http.Response, error)
GetUploadURLForEntityTypeSender sends the GetUploadURLForEntityType request. The method will close the http.Response Body if it receives an error.
InstanceOperationType enumerates the values for instance operation type.
const (
// Delete ...
Delete InstanceOperationType = "Delete"
// Upsert ...
Upsert InstanceOperationType = "Upsert"
)func PossibleInstanceOperationTypeValues() []InstanceOperationType
PossibleInstanceOperationTypeValues returns an array of possible values for the InstanceOperationType const type.
type InteractionListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]InteractionResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}InteractionListResult the response of list interaction operation.
func (ilr InteractionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type InteractionListResultIterator struct {
// contains filtered or unexported fields
}InteractionListResultIterator provides access to a complete listing of InteractionResourceFormat values.
func NewInteractionListResultIterator(page InteractionListResultPage) InteractionListResultIterator
Creates a new instance of the InteractionListResultIterator type.
func (iter *InteractionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *InteractionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter InteractionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter InteractionListResultIterator) Response() InteractionListResult
Response returns the raw server response from the last page request.
func (iter InteractionListResultIterator) Value() InteractionResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type InteractionListResultPage struct {
// contains filtered or unexported fields
}InteractionListResultPage contains a page of InteractionResourceFormat values.
func NewInteractionListResultPage(cur InteractionListResult, getNextPage func(context.Context, InteractionListResult) (InteractionListResult, error)) InteractionListResultPage
Creates a new instance of the InteractionListResultPage type.
func (page *InteractionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *InteractionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page InteractionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page InteractionListResultPage) Response() InteractionListResult
Response returns the raw server response from the last page request.
func (page InteractionListResultPage) Values() []InteractionResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type InteractionResourceFormat struct {
autorest.Response `json:"-"`
*InteractionTypeDefinition `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}InteractionResourceFormat the interaction resource format.
func (irf InteractionResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InteractionResourceFormat.
func (irf *InteractionResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for InteractionResourceFormat struct.
type InteractionTypeDefinition struct {
// IDPropertyNames - The id property names. Properties which uniquely identify an interaction instance.
IDPropertyNames *[]string `json:"idPropertyNames,omitempty"`
// ParticipantProfiles - Profiles that participated in the interaction.
ParticipantProfiles *[]Participant `json:"participantProfiles,omitempty"`
// PrimaryParticipantProfilePropertyName - 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.
PrimaryParticipantProfilePropertyName *string `json:"primaryParticipantProfilePropertyName,omitempty"`
// DataSourcePrecedenceRules - READ-ONLY; This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
DataSourcePrecedenceRules *[]DataSourcePrecedence `json:"dataSourcePrecedenceRules,omitempty"`
// DataSource - Default data source is specifically used in cases where data source is not specified in an instance.
*DataSource `json:"defaultDataSource,omitempty"`
// IsActivity - 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.
IsActivity *bool `json:"isActivity,omitempty"`
// APIEntitySetName - The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
APIEntitySetName *string `json:"apiEntitySetName,omitempty"`
// EntityType - Type of entity. Possible values include: 'EntityTypesNone', 'EntityTypesProfile', 'EntityTypesInteraction', 'EntityTypesRelationship'
EntityType EntityTypes `json:"entityType,omitempty"`
// Fields - The properties of the Profile.
Fields *[]PropertyDefinition `json:"fields,omitempty"`
// InstancesCount - The instance count.
InstancesCount *int32 `json:"instancesCount,omitempty"`
// LastChangedUtc - READ-ONLY; The last changed time for the type definition.
LastChangedUtc *date.Time `json:"lastChangedUtc,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// SchemaItemTypeLink - The schema org link. This helps ACI identify and suggest semantic models.
SchemaItemTypeLink *string `json:"schemaItemTypeLink,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// TimestampFieldName - The timestamp property name. Represents the time when the interaction or profile update happened.
TimestampFieldName *string `json:"timestampFieldName,omitempty"`
// TypeName - The name of the entity.
TypeName *string `json:"typeName,omitempty"`
// Attributes - The attributes for the Type.
Attributes map[string][]string `json:"attributes"`
// Description - Localized descriptions for the property.
Description map[string]*string `json:"description"`
// DisplayName - Localized display names for the property.
DisplayName map[string]*string `json:"displayName"`
// LocalizedAttributes - Any custom localized attributes for the Type.
LocalizedAttributes map[string]map[string]*string `json:"localizedAttributes"`
// SmallImage - Small Image associated with the Property or EntityType.
SmallImage *string `json:"smallImage,omitempty"`
// MediumImage - Medium Image associated with the Property or EntityType.
MediumImage *string `json:"mediumImage,omitempty"`
// LargeImage - Large Image associated with the Property or EntityType.
LargeImage *string `json:"largeImage,omitempty"`
}InteractionTypeDefinition the Interaction Type Definition
func (itd InteractionTypeDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InteractionTypeDefinition.
func (itd *InteractionTypeDefinition) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for InteractionTypeDefinition struct.
type InteractionsClient struct {
BaseClient
}InteractionsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewInteractionsClient(subscriptionID string) InteractionsClient
NewInteractionsClient creates an instance of the InteractionsClient client.
func NewInteractionsClientWithBaseURI(baseURI string, subscriptionID string) InteractionsClient
NewInteractionsClientWithBaseURI creates an instance of the InteractionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client InteractionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, interactionName string, parameters InteractionResourceFormat) (result InteractionsCreateOrUpdateFuture, err error)
CreateOrUpdate creates an interaction or updates an existing interaction within a hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. interactionName - the name of the interaction. parameters - parameters supplied to the CreateOrUpdate Interaction operation.
func (client InteractionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, interactionName string, parameters InteractionResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client InteractionsClient) CreateOrUpdateResponder(resp *http.Response) (result InteractionResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client InteractionsClient) CreateOrUpdateSender(req *http.Request) (future InteractionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client InteractionsClient) Get(ctx context.Context, resourceGroupName string, hubName string, interactionName string, localeCode string) (result InteractionResourceFormat, err error)
Get gets information about the specified interaction. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. interactionName - the name of the interaction. localeCode - locale of interaction to retrieve, default is en-us.
func (client InteractionsClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, interactionName string, localeCode string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client InteractionsClient) GetResponder(resp *http.Response) (result InteractionResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client InteractionsClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string, localeCode string) (result InteractionListResultPage, err error)
ListByHub gets all interactions in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. localeCode - locale of interaction to retrieve, default is en-us.
func (client InteractionsClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string, localeCode string) (result InteractionListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client InteractionsClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string, localeCode string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client InteractionsClient) ListByHubResponder(resp *http.Response) (result InteractionListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
func (client InteractionsClient) SuggestRelationshipLinks(ctx context.Context, resourceGroupName string, hubName string, interactionName string) (result SuggestRelationshipLinksResponse, err error)
SuggestRelationshipLinks suggests relationships to create relationship links. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. interactionName - the name of the interaction.
func (client InteractionsClient) SuggestRelationshipLinksPreparer(ctx context.Context, resourceGroupName string, hubName string, interactionName string) (*http.Request, error)
SuggestRelationshipLinksPreparer prepares the SuggestRelationshipLinks request.
func (client InteractionsClient) SuggestRelationshipLinksResponder(resp *http.Response) (result SuggestRelationshipLinksResponse, err error)
SuggestRelationshipLinksResponder handles the response to the SuggestRelationshipLinks request. The method always closes the http.Response Body.
func (client InteractionsClient) SuggestRelationshipLinksSender(req *http.Request) (*http.Response, error)
SuggestRelationshipLinksSender sends the SuggestRelationshipLinks request. The method will close the http.Response Body if it receives an error.
type InteractionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(InteractionsClient) (InteractionResourceFormat, error)
}InteractionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type KpiAlias struct {
// AliasName - KPI alias name.
AliasName *string `json:"aliasName,omitempty"`
// Expression - The expression.
Expression *string `json:"expression,omitempty"`
}KpiAlias the KPI alias.
type KpiClient struct {
BaseClient
}KpiClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
NewKpiClient creates an instance of the KpiClient client.
NewKpiClientWithBaseURI creates an instance of the KpiClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client KpiClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, kpiName string, parameters KpiResourceFormat) (result KpiCreateOrUpdateFuture, err error)
CreateOrUpdate creates a KPI or updates an existing KPI in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. kpiName - the name of the KPI. parameters - parameters supplied to the create/update KPI operation.
func (client KpiClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, kpiName string, parameters KpiResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client KpiClient) CreateOrUpdateResponder(resp *http.Response) (result KpiResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client KpiClient) CreateOrUpdateSender(req *http.Request) (future KpiCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client KpiClient) Delete(ctx context.Context, resourceGroupName string, hubName string, kpiName string) (result KpiDeleteFuture, err error)
Delete deletes a KPI in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. kpiName - the name of the KPI.
func (client KpiClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, kpiName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client KpiClient) Get(ctx context.Context, resourceGroupName string, hubName string, kpiName string) (result KpiResourceFormat, err error)
Get gets a KPI in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. kpiName - the name of the KPI.
func (client KpiClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, kpiName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client KpiClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result KpiListResultPage, err error)
ListByHub gets all the KPIs in the specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client KpiClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result KpiListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client KpiClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
func (client KpiClient) Reprocess(ctx context.Context, resourceGroupName string, hubName string, kpiName string) (result autorest.Response, err error)
Reprocess reprocesses the Kpi values of the specified KPI. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. kpiName - the name of the KPI.
func (client KpiClient) ReprocessPreparer(ctx context.Context, resourceGroupName string, hubName string, kpiName string) (*http.Request, error)
ReprocessPreparer prepares the Reprocess request.
func (client KpiClient) ReprocessResponder(resp *http.Response) (result autorest.Response, err error)
ReprocessResponder handles the response to the Reprocess request. The method always closes the http.Response Body.
ReprocessSender sends the Reprocess request. The method will close the http.Response Body if it receives an error.
type KpiCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(KpiClient) (KpiResourceFormat, error)
}KpiCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type KpiDefinition struct {
// EntityType - The mapping entity type. Possible values include: 'EntityTypesNone', 'EntityTypesProfile', 'EntityTypesInteraction', 'EntityTypesRelationship'
EntityType EntityTypes `json:"entityType,omitempty"`
// EntityTypeName - The mapping entity name.
EntityTypeName *string `json:"entityTypeName,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// KpiName - READ-ONLY; The KPI name.
KpiName *string `json:"kpiName,omitempty"`
// DisplayName - Localized display name for the KPI.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized description for the KPI.
Description map[string]*string `json:"description"`
// CalculationWindow - The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'
CalculationWindow CalculationWindowTypes `json:"calculationWindow,omitempty"`
// CalculationWindowFieldName - Name of calculation window field.
CalculationWindowFieldName *string `json:"calculationWindowFieldName,omitempty"`
// Function - The computation function for the KPI. Possible values include: 'KpiFunctionsSum', 'KpiFunctionsAvg', 'KpiFunctionsMin', 'KpiFunctionsMax', 'KpiFunctionsLast', 'KpiFunctionsCount', 'KpiFunctionsNone', 'KpiFunctionsCountDistinct'
Function KpiFunctions `json:"function,omitempty"`
// Expression - The computation expression for the KPI.
Expression *string `json:"expression,omitempty"`
// Unit - The unit of measurement for the KPI.
Unit *string `json:"unit,omitempty"`
// Filter - The filter expression for the KPI.
Filter *string `json:"filter,omitempty"`
// GroupBy - the group by properties for the KPI.
GroupBy *[]string `json:"groupBy,omitempty"`
// GroupByMetadata - READ-ONLY; The KPI GroupByMetadata.
GroupByMetadata *[]KpiGroupByMetadata `json:"groupByMetadata,omitempty"`
// ParticipantProfilesMetadata - READ-ONLY; The participant profiles.
ParticipantProfilesMetadata *[]KpiParticipantProfilesMetadata `json:"participantProfilesMetadata,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// ThresHolds - The KPI thresholds.
ThresHolds *KpiThresholds `json:"thresHolds,omitempty"`
// Aliases - The aliases.
Aliases *[]KpiAlias `json:"aliases,omitempty"`
// Extracts - The KPI extracts.
Extracts *[]KpiExtract `json:"extracts,omitempty"`
}KpiDefinition defines the KPI Threshold limits.
func (kd KpiDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for KpiDefinition.
type KpiDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(KpiClient) (autorest.Response, error)
}KpiDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type KpiExtract struct {
// ExtractName - KPI extract name.
ExtractName *string `json:"extractName,omitempty"`
// Expression - The expression.
Expression *string `json:"expression,omitempty"`
}KpiExtract the KPI extract.
KpiFunctions enumerates the values for kpi functions.
const (
// KpiFunctionsAvg ...
KpiFunctionsAvg KpiFunctions = "Avg"
// KpiFunctionsCount ...
KpiFunctionsCount KpiFunctions = "Count"
// KpiFunctionsCountDistinct ...
KpiFunctionsCountDistinct KpiFunctions = "CountDistinct"
// KpiFunctionsLast ...
KpiFunctionsLast KpiFunctions = "Last"
// KpiFunctionsMax ...
KpiFunctionsMax KpiFunctions = "Max"
// KpiFunctionsMin ...
KpiFunctionsMin KpiFunctions = "Min"
// KpiFunctionsNone ...
KpiFunctionsNone KpiFunctions = "None"
// KpiFunctionsSum ...
KpiFunctionsSum KpiFunctions = "Sum"
)func PossibleKpiFunctionsValues() []KpiFunctions
PossibleKpiFunctionsValues returns an array of possible values for the KpiFunctions const type.
type KpiGroupByMetadata struct {
// DisplayName - The display name.
DisplayName map[string]*string `json:"displayName"`
// FieldName - The name of the field.
FieldName *string `json:"fieldName,omitempty"`
// FieldType - The type of the field.
FieldType *string `json:"fieldType,omitempty"`
}KpiGroupByMetadata the KPI GroupBy field metadata.
func (kgbm KpiGroupByMetadata) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for KpiGroupByMetadata.
type KpiListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]KpiResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}KpiListResult the response of list KPI operation.
func (klr KpiListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type KpiListResultIterator struct {
// contains filtered or unexported fields
}KpiListResultIterator provides access to a complete listing of KpiResourceFormat values.
func NewKpiListResultIterator(page KpiListResultPage) KpiListResultIterator
Creates a new instance of the KpiListResultIterator type.
func (iter *KpiListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *KpiListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter KpiListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter KpiListResultIterator) Response() KpiListResult
Response returns the raw server response from the last page request.
func (iter KpiListResultIterator) Value() KpiResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type KpiListResultPage struct {
// contains filtered or unexported fields
}KpiListResultPage contains a page of KpiResourceFormat values.
func NewKpiListResultPage(cur KpiListResult, getNextPage func(context.Context, KpiListResult) (KpiListResult, error)) KpiListResultPage
Creates a new instance of the KpiListResultPage type.
func (page *KpiListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *KpiListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page KpiListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page KpiListResultPage) Response() KpiListResult
Response returns the raw server response from the last page request.
func (page KpiListResultPage) Values() []KpiResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type KpiParticipantProfilesMetadata struct {
// TypeName - Name of the type.
TypeName *string `json:"typeName,omitempty"`
}KpiParticipantProfilesMetadata the KPI participant profile metadata.
type KpiResourceFormat struct {
autorest.Response `json:"-"`
*KpiDefinition `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}KpiResourceFormat the KPI resource format.
func (krf KpiResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for KpiResourceFormat.
func (krf *KpiResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for KpiResourceFormat struct.
type KpiThresholds struct {
// LowerLimit - The lower threshold limit.
LowerLimit *decimal.Decimal `json:"lowerLimit,omitempty"`
// UpperLimit - The upper threshold limit.
UpperLimit *decimal.Decimal `json:"upperLimit,omitempty"`
// IncreasingKpi - Whether or not the KPI is an increasing KPI.
IncreasingKpi *bool `json:"increasingKpi,omitempty"`
}KpiThresholds defines the KPI Threshold limits.
type LinkDefinition struct {
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// LinkName - READ-ONLY; The link name.
LinkName *string `json:"linkName,omitempty"`
// SourceInteractionType - Name of the source Interaction Type.
SourceInteractionType *string `json:"sourceInteractionType,omitempty"`
// TargetProfileType - Name of the target Profile Type.
TargetProfileType *string `json:"targetProfileType,omitempty"`
// DisplayName - Localized display name for the Link.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized descriptions for the Link.
Description map[string]*string `json:"description"`
// Mappings - The set of properties mappings between the source and target Types.
Mappings *[]TypePropertiesMapping `json:"mappings,omitempty"`
// ParticipantPropertyReferences - The properties that represent the participating profile.
ParticipantPropertyReferences *[]ParticipantPropertyReference `json:"participantPropertyReferences,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// ReferenceOnly - Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
ReferenceOnly *bool `json:"referenceOnly,omitempty"`
// OperationType - Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only. Possible values include: 'Upsert', 'Delete'
OperationType InstanceOperationType `json:"operationType,omitempty"`
}LinkDefinition the definition of Link.
func (ld LinkDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkDefinition.
type LinkListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]LinkResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}LinkListResult the response of list link operation.
func (llr LinkListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type LinkListResultIterator struct {
// contains filtered or unexported fields
}LinkListResultIterator provides access to a complete listing of LinkResourceFormat values.
func NewLinkListResultIterator(page LinkListResultPage) LinkListResultIterator
Creates a new instance of the LinkListResultIterator type.
func (iter *LinkListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *LinkListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter LinkListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LinkListResultIterator) Response() LinkListResult
Response returns the raw server response from the last page request.
func (iter LinkListResultIterator) Value() LinkResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LinkListResultPage struct {
// contains filtered or unexported fields
}LinkListResultPage contains a page of LinkResourceFormat values.
func NewLinkListResultPage(cur LinkListResult, getNextPage func(context.Context, LinkListResult) (LinkListResult, error)) LinkListResultPage
Creates a new instance of the LinkListResultPage type.
func (page *LinkListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *LinkListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page LinkListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LinkListResultPage) Response() LinkListResult
Response returns the raw server response from the last page request.
func (page LinkListResultPage) Values() []LinkResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type LinkResourceFormat struct {
autorest.Response `json:"-"`
*LinkDefinition `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}LinkResourceFormat the link resource format.
func (lrf LinkResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkResourceFormat.
func (lrf *LinkResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LinkResourceFormat struct.
LinkTypes enumerates the values for link types.
const (
// CopyIfNull ...
CopyIfNull LinkTypes = "CopyIfNull"
// UpdateAlways ...
UpdateAlways LinkTypes = "UpdateAlways"
)PossibleLinkTypesValues returns an array of possible values for the LinkTypes const type.
type LinksClient struct {
BaseClient
}LinksClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewLinksClient(subscriptionID string) LinksClient
NewLinksClient creates an instance of the LinksClient client.
func NewLinksClientWithBaseURI(baseURI string, subscriptionID string) LinksClient
NewLinksClientWithBaseURI creates an instance of the LinksClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client LinksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, linkName string, parameters LinkResourceFormat) (result LinksCreateOrUpdateFuture, err error)
CreateOrUpdate creates a link or updates an existing link in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. linkName - the name of the link. parameters - parameters supplied to the CreateOrUpdate Link operation.
func (client LinksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, linkName string, parameters LinkResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client LinksClient) CreateOrUpdateResponder(resp *http.Response) (result LinkResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client LinksClient) CreateOrUpdateSender(req *http.Request) (future LinksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client LinksClient) Delete(ctx context.Context, resourceGroupName string, hubName string, linkName string) (result autorest.Response, err error)
Delete deletes a link in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. linkName - the name of the link.
func (client LinksClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, linkName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client LinksClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client LinksClient) Get(ctx context.Context, resourceGroupName string, hubName string, linkName string) (result LinkResourceFormat, err error)
Get gets a link in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. linkName - the name of the link.
func (client LinksClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, linkName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client LinksClient) GetResponder(resp *http.Response) (result LinkResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client LinksClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result LinkListResultPage, err error)
ListByHub gets all the links in the specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client LinksClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result LinkListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client LinksClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client LinksClient) ListByHubResponder(resp *http.Response) (result LinkListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type LinksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LinksClient) (LinkResourceFormat, error)
}LinksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ListKpiDefinition struct {
autorest.Response `json:"-"`
Value *[]KpiDefinition `json:"value,omitempty"`
}ListKpiDefinition ...
type MetadataDefinitionBase struct {
// Attributes - The attributes for the Type.
Attributes map[string][]string `json:"attributes"`
// Description - Localized descriptions for the property.
Description map[string]*string `json:"description"`
// DisplayName - Localized display names for the property.
DisplayName map[string]*string `json:"displayName"`
// LocalizedAttributes - Any custom localized attributes for the Type.
LocalizedAttributes map[string]map[string]*string `json:"localizedAttributes"`
// SmallImage - Small Image associated with the Property or EntityType.
SmallImage *string `json:"smallImage,omitempty"`
// MediumImage - Medium Image associated with the Property or EntityType.
MediumImage *string `json:"mediumImage,omitempty"`
// LargeImage - Large Image associated with the Property or EntityType.
LargeImage *string `json:"largeImage,omitempty"`
}MetadataDefinitionBase the Metadata definition base.
func (mdb MetadataDefinitionBase) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetadataDefinitionBase.
type Operation struct {
// Name - READ-ONLY; Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - The object that represents the operation.
Display *OperationDisplay `json:"display,omitempty"`
}Operation a Customer Insights REST API operation
MarshalJSON is the custom marshaler for Operation.
type OperationDisplay struct {
// Provider - READ-ONLY; Service provider: Microsoft.CustomerInsights
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; Resource on which the operation is performed: Invoice, etc.
Resource *string `json:"resource,omitempty"`
// Operation - READ-ONLY; Operation type: Read, write, delete, etc.
Operation *string `json:"operation,omitempty"`
}OperationDisplay the object that represents the operation.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Customer Insights operations supported by the Microsoft.CustomerInsights resource provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}OperationListResult result of the request to list Customer Insights operations. It contains a list of operations and a URL link to get the next set of results.
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage struct {
// contains filtered or unexported fields
}OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient struct {
BaseClient
}OperationsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Customer Insights REST API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Participant struct {
// ProfileTypeName - Profile type name.
ProfileTypeName *string `json:"profileTypeName,omitempty"`
// ParticipantPropertyReferences - The property references.
ParticipantPropertyReferences *[]ParticipantPropertyReference `json:"participantPropertyReferences,omitempty"`
// ParticipantName - Participant name.
ParticipantName *string `json:"participantName,omitempty"`
// DisplayName - Localized display name.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized descriptions.
Description map[string]*string `json:"description"`
// Role - The role that the participant is playing in the interaction.
Role *string `json:"role,omitempty"`
}Participant describes a profile type participating in an interaction.
func (p Participant) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Participant.
type ParticipantPropertyReference struct {
// InteractionPropertyName - The interaction property that maps to the profile property.
InteractionPropertyName *string `json:"interactionPropertyName,omitempty"`
// ProfilePropertyName - The profile property that maps to the interaction property.
ProfilePropertyName *string `json:"profilePropertyName,omitempty"`
}ParticipantPropertyReference the participant property reference.
PermissionTypes enumerates the values for permission types.
const (
// Manage ...
Manage PermissionTypes = "Manage"
// Read ...
Read PermissionTypes = "Read"
// Write ...
Write PermissionTypes = "Write"
)func PossiblePermissionTypesValues() []PermissionTypes
PossiblePermissionTypesValues returns an array of possible values for the PermissionTypes const type.
type ProfileEnumValidValuesFormat struct {
// Value - The integer value of the enum member.
Value *int32 `json:"value,omitempty"`
// LocalizedValueNames - Localized names of the enum member.
LocalizedValueNames map[string]*string `json:"localizedValueNames"`
}ProfileEnumValidValuesFormat valid enum values in case of an enum property.
func (pevvf ProfileEnumValidValuesFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileEnumValidValuesFormat.
type ProfileListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ProfileResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ProfileListResult the response of list profile operation.
func (plr ProfileListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ProfileListResultIterator struct {
// contains filtered or unexported fields
}ProfileListResultIterator provides access to a complete listing of ProfileResourceFormat values.
func NewProfileListResultIterator(page ProfileListResultPage) ProfileListResultIterator
Creates a new instance of the ProfileListResultIterator type.
func (iter *ProfileListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ProfileListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ProfileListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProfileListResultIterator) Response() ProfileListResult
Response returns the raw server response from the last page request.
func (iter ProfileListResultIterator) Value() ProfileResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ProfileListResultPage struct {
// contains filtered or unexported fields
}ProfileListResultPage contains a page of ProfileResourceFormat values.
func NewProfileListResultPage(cur ProfileListResult, getNextPage func(context.Context, ProfileListResult) (ProfileListResult, error)) ProfileListResultPage
Creates a new instance of the ProfileListResultPage type.
func (page *ProfileListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ProfileListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ProfileListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProfileListResultPage) Response() ProfileListResult
Response returns the raw server response from the last page request.
func (page ProfileListResultPage) Values() []ProfileResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type ProfileResourceFormat struct {
autorest.Response `json:"-"`
*ProfileTypeDefinition `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}ProfileResourceFormat the profile resource format.
func (prf ProfileResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileResourceFormat.
func (prf *ProfileResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProfileResourceFormat struct.
type ProfileTypeDefinition struct {
// StrongIds - The strong IDs.
StrongIds *[]StrongID `json:"strongIds,omitempty"`
// APIEntitySetName - The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
APIEntitySetName *string `json:"apiEntitySetName,omitempty"`
// EntityType - Type of entity. Possible values include: 'EntityTypesNone', 'EntityTypesProfile', 'EntityTypesInteraction', 'EntityTypesRelationship'
EntityType EntityTypes `json:"entityType,omitempty"`
// Fields - The properties of the Profile.
Fields *[]PropertyDefinition `json:"fields,omitempty"`
// InstancesCount - The instance count.
InstancesCount *int32 `json:"instancesCount,omitempty"`
// LastChangedUtc - READ-ONLY; The last changed time for the type definition.
LastChangedUtc *date.Time `json:"lastChangedUtc,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// SchemaItemTypeLink - The schema org link. This helps ACI identify and suggest semantic models.
SchemaItemTypeLink *string `json:"schemaItemTypeLink,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// TimestampFieldName - The timestamp property name. Represents the time when the interaction or profile update happened.
TimestampFieldName *string `json:"timestampFieldName,omitempty"`
// TypeName - The name of the entity.
TypeName *string `json:"typeName,omitempty"`
// Attributes - The attributes for the Type.
Attributes map[string][]string `json:"attributes"`
// Description - Localized descriptions for the property.
Description map[string]*string `json:"description"`
// DisplayName - Localized display names for the property.
DisplayName map[string]*string `json:"displayName"`
// LocalizedAttributes - Any custom localized attributes for the Type.
LocalizedAttributes map[string]map[string]*string `json:"localizedAttributes"`
// SmallImage - Small Image associated with the Property or EntityType.
SmallImage *string `json:"smallImage,omitempty"`
// MediumImage - Medium Image associated with the Property or EntityType.
MediumImage *string `json:"mediumImage,omitempty"`
// LargeImage - Large Image associated with the Property or EntityType.
LargeImage *string `json:"largeImage,omitempty"`
}ProfileTypeDefinition the profile type definition.
func (ptd ProfileTypeDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileTypeDefinition.
type ProfilesClient struct {
BaseClient
}ProfilesClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewProfilesClient(subscriptionID string) ProfilesClient
NewProfilesClient creates an instance of the ProfilesClient client.
func NewProfilesClientWithBaseURI(baseURI string, subscriptionID string) ProfilesClient
NewProfilesClientWithBaseURI creates an instance of the ProfilesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ProfilesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, profileName string, parameters ProfileResourceFormat) (result ProfilesCreateOrUpdateFuture, err error)
CreateOrUpdate creates a profile within a Hub, or updates an existing profile. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. profileName - the name of the profile. parameters - parameters supplied to the create/delete Profile type operation
func (client ProfilesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, profileName string, parameters ProfileResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProfilesClient) CreateOrUpdateResponder(resp *http.Response) (result ProfileResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProfilesClient) CreateOrUpdateSender(req *http.Request) (future ProfilesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ProfilesClient) Delete(ctx context.Context, resourceGroupName string, hubName string, profileName string, localeCode string) (result ProfilesDeleteFuture, err error)
Delete deletes a profile within a hub Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. profileName - the name of the profile. localeCode - locale of profile to retrieve, default is en-us.
func (client ProfilesClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, profileName string, localeCode string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProfilesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ProfilesClient) DeleteSender(req *http.Request) (future ProfilesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProfilesClient) Get(ctx context.Context, resourceGroupName string, hubName string, profileName string, localeCode string) (result ProfileResourceFormat, err error)
Get gets information about the specified profile. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. profileName - the name of the profile. localeCode - locale of profile to retrieve, default is en-us.
func (client ProfilesClient) GetEnrichingKpis(ctx context.Context, resourceGroupName string, hubName string, profileName string) (result ListKpiDefinition, err error)
GetEnrichingKpis 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. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. profileName - the name of the profile.
func (client ProfilesClient) GetEnrichingKpisPreparer(ctx context.Context, resourceGroupName string, hubName string, profileName string) (*http.Request, error)
GetEnrichingKpisPreparer prepares the GetEnrichingKpis request.
func (client ProfilesClient) GetEnrichingKpisResponder(resp *http.Response) (result ListKpiDefinition, err error)
GetEnrichingKpisResponder handles the response to the GetEnrichingKpis request. The method always closes the http.Response Body.
GetEnrichingKpisSender sends the GetEnrichingKpis request. The method will close the http.Response Body if it receives an error.
func (client ProfilesClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, profileName string, localeCode string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ProfilesClient) GetResponder(resp *http.Response) (result ProfileResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ProfilesClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string, localeCode string) (result ProfileListResultPage, err error)
ListByHub gets all profile in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. localeCode - locale of profile to retrieve, default is en-us.
func (client ProfilesClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string, localeCode string) (result ProfileListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProfilesClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string, localeCode string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client ProfilesClient) ListByHubResponder(resp *http.Response) (result ProfileListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type ProfilesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ProfilesClient) (ProfileResourceFormat, error)
}ProfilesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ProfilesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ProfilesClient) (autorest.Response, error)
}ProfilesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PropertyDefinition struct {
// ArrayValueSeparator - Array value separator for properties with isArray set.
ArrayValueSeparator *string `json:"arrayValueSeparator,omitempty"`
// EnumValidValues - Describes valid values for an enum property.
EnumValidValues *[]ProfileEnumValidValuesFormat `json:"enumValidValues,omitempty"`
// FieldName - Name of the property.
FieldName *string `json:"fieldName,omitempty"`
// FieldType - Type of the property.
FieldType *string `json:"fieldType,omitempty"`
// IsArray - Indicates if the property is actually an array of the fieldType above on the data api.
IsArray *bool `json:"isArray,omitempty"`
// IsEnum - Indicates if the property is an enum.
IsEnum *bool `json:"isEnum,omitempty"`
// IsFlagEnum - Indicates if the property is an flag enum.
IsFlagEnum *bool `json:"isFlagEnum,omitempty"`
// IsImage - Whether the property is an Image.
IsImage *bool `json:"isImage,omitempty"`
// IsLocalizedString - Whether the property is a localized string.
IsLocalizedString *bool `json:"isLocalizedString,omitempty"`
// IsName - Whether the property is a name or a part of name.
IsName *bool `json:"isName,omitempty"`
// IsRequired - Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
IsRequired *bool `json:"isRequired,omitempty"`
// PropertyID - The ID associated with the property.
PropertyID *string `json:"propertyId,omitempty"`
// SchemaItemPropLink - URL encoded schema.org item prop link for the property.
SchemaItemPropLink *string `json:"schemaItemPropLink,omitempty"`
// MaxLength - Max length of string. Used only if type is string.
MaxLength *int32 `json:"maxLength,omitempty"`
// IsAvailableInGraph - Whether property is available in graph or not.
IsAvailableInGraph *bool `json:"isAvailableInGraph,omitempty"`
// DataSourcePrecedenceRules - READ-ONLY; This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
DataSourcePrecedenceRules *[]DataSourcePrecedence `json:"dataSourcePrecedenceRules,omitempty"`
}PropertyDefinition property definition.
func (pd PropertyDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PropertyDefinition.
ProvisioningStates enumerates the values for provisioning states.
const (
// ProvisioningStatesDeleting ...
ProvisioningStatesDeleting ProvisioningStates = "Deleting"
// ProvisioningStatesExpiring ...
ProvisioningStatesExpiring ProvisioningStates = "Expiring"
// ProvisioningStatesFailed ...
ProvisioningStatesFailed ProvisioningStates = "Failed"
// ProvisioningStatesHumanIntervention ...
ProvisioningStatesHumanIntervention ProvisioningStates = "HumanIntervention"
// ProvisioningStatesProvisioning ...
ProvisioningStatesProvisioning ProvisioningStates = "Provisioning"
// ProvisioningStatesSucceeded ...
ProvisioningStatesSucceeded ProvisioningStates = "Succeeded"
)func PossibleProvisioningStatesValues() []ProvisioningStates
PossibleProvisioningStatesValues returns an array of possible values for the ProvisioningStates const type.
type ProxyResource struct {
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}ProxyResource common properties of proxy resource.
type RelationshipDefinition struct {
// Cardinality - The Relationship Cardinality. Possible values include: 'OneToOne', 'OneToMany', 'ManyToMany'
Cardinality CardinalityTypes `json:"cardinality,omitempty"`
// DisplayName - Localized display name for the Relationship.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized descriptions for the Relationship.
Description map[string]*string `json:"description"`
// ExpiryDateTimeUtc - The expiry date time in UTC.
ExpiryDateTimeUtc *date.Time `json:"expiryDateTimeUtc,omitempty"`
// Fields - The properties of the Relationship.
Fields *[]PropertyDefinition `json:"fields,omitempty"`
// LookupMappings - Optional property to be used to map fields in profile to their strong ids in related profile.
LookupMappings *[]RelationshipTypeMapping `json:"lookupMappings,omitempty"`
// ProfileType - Profile type.
ProfileType *string `json:"profileType,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// RelationshipName - READ-ONLY; The Relationship name.
RelationshipName *string `json:"relationshipName,omitempty"`
// RelatedProfileType - Related profile being referenced.
RelatedProfileType *string `json:"relatedProfileType,omitempty"`
// RelationshipGUIDID - READ-ONLY; The relationship guid id.
RelationshipGUIDID *string `json:"relationshipGuidId,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
}RelationshipDefinition the definition of Relationship.
func (rd RelationshipDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RelationshipDefinition.
type RelationshipLinkDefinition struct {
// DisplayName - Localized display name for the Relationship Link.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized descriptions for the Relationship Link.
Description map[string]*string `json:"description"`
// InteractionType - The InteractionType associated with the Relationship Link.
InteractionType *string `json:"interactionType,omitempty"`
// LinkName - READ-ONLY; The name of the Relationship Link.
LinkName *string `json:"linkName,omitempty"`
// Mappings - The mappings between Interaction and Relationship fields.
Mappings *[]RelationshipLinkFieldMapping `json:"mappings,omitempty"`
// ProfilePropertyReferences - The property references for the Profile of the Relationship.
ProfilePropertyReferences *[]ParticipantPropertyReference `json:"profilePropertyReferences,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// RelatedProfilePropertyReferences - The property references for the Related Profile of the Relationship.
RelatedProfilePropertyReferences *[]ParticipantPropertyReference `json:"relatedProfilePropertyReferences,omitempty"`
// RelationshipName - The Relationship associated with the Link.
RelationshipName *string `json:"relationshipName,omitempty"`
// RelationshipGUIDID - READ-ONLY; The relationship guid id.
RelationshipGUIDID *string `json:"relationshipGuidId,omitempty"`
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
}RelationshipLinkDefinition the definition of relationship link.
func (rld RelationshipLinkDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RelationshipLinkDefinition.
type RelationshipLinkFieldMapping struct {
// InteractionFieldName - The field name on the Interaction Type.
InteractionFieldName *string `json:"interactionFieldName,omitempty"`
// LinkType - Link type. Possible values include: 'UpdateAlways', 'CopyIfNull'
LinkType LinkTypes `json:"linkType,omitempty"`
// RelationshipFieldName - The field name on the Relationship metadata.
RelationshipFieldName *string `json:"relationshipFieldName,omitempty"`
}RelationshipLinkFieldMapping the fields mapping for Relationships.
type RelationshipLinkListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]RelationshipLinkResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}RelationshipLinkListResult the response of list relationship link operation.
func (rllr RelationshipLinkListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type RelationshipLinkListResultIterator struct {
// contains filtered or unexported fields
}RelationshipLinkListResultIterator provides access to a complete listing of RelationshipLinkResourceFormat values.
func NewRelationshipLinkListResultIterator(page RelationshipLinkListResultPage) RelationshipLinkListResultIterator
Creates a new instance of the RelationshipLinkListResultIterator type.
func (iter *RelationshipLinkListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *RelationshipLinkListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter RelationshipLinkListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RelationshipLinkListResultIterator) Response() RelationshipLinkListResult
Response returns the raw server response from the last page request.
func (iter RelationshipLinkListResultIterator) Value() RelationshipLinkResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type RelationshipLinkListResultPage struct {
// contains filtered or unexported fields
}RelationshipLinkListResultPage contains a page of RelationshipLinkResourceFormat values.
func NewRelationshipLinkListResultPage(cur RelationshipLinkListResult, getNextPage func(context.Context, RelationshipLinkListResult) (RelationshipLinkListResult, error)) RelationshipLinkListResultPage
Creates a new instance of the RelationshipLinkListResultPage type.
func (page *RelationshipLinkListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *RelationshipLinkListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page RelationshipLinkListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RelationshipLinkListResultPage) Response() RelationshipLinkListResult
Response returns the raw server response from the last page request.
func (page RelationshipLinkListResultPage) Values() []RelationshipLinkResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type RelationshipLinkResourceFormat struct {
autorest.Response `json:"-"`
*RelationshipLinkDefinition `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}RelationshipLinkResourceFormat the relationship link resource format.
func (rlrf RelationshipLinkResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RelationshipLinkResourceFormat.
func (rlrf *RelationshipLinkResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RelationshipLinkResourceFormat struct.
type RelationshipLinksClient struct {
BaseClient
}RelationshipLinksClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewRelationshipLinksClient(subscriptionID string) RelationshipLinksClient
NewRelationshipLinksClient creates an instance of the RelationshipLinksClient client.
func NewRelationshipLinksClientWithBaseURI(baseURI string, subscriptionID string) RelationshipLinksClient
NewRelationshipLinksClientWithBaseURI creates an instance of the RelationshipLinksClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client RelationshipLinksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string, parameters RelationshipLinkResourceFormat) (result RelationshipLinksCreateOrUpdateFuture, err error)
CreateOrUpdate creates a relationship link or updates an existing relationship link within a hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. relationshipLinkName - the name of the relationship link. parameters - parameters supplied to the CreateOrUpdate relationship link operation.
func (client RelationshipLinksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string, parameters RelationshipLinkResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client RelationshipLinksClient) CreateOrUpdateResponder(resp *http.Response) (result RelationshipLinkResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client RelationshipLinksClient) CreateOrUpdateSender(req *http.Request) (future RelationshipLinksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client RelationshipLinksClient) Delete(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string) (result RelationshipLinksDeleteFuture, err error)
Delete deletes a relationship link within a hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. relationshipLinkName - the name of the relationship.
func (client RelationshipLinksClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client RelationshipLinksClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client RelationshipLinksClient) DeleteSender(req *http.Request) (future RelationshipLinksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RelationshipLinksClient) Get(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string) (result RelationshipLinkResourceFormat, err error)
Get gets information about the specified relationship Link. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. relationshipLinkName - the name of the relationship link.
func (client RelationshipLinksClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RelationshipLinksClient) GetResponder(resp *http.Response) (result RelationshipLinkResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client RelationshipLinksClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result RelationshipLinkListResultPage, err error)
ListByHub gets all relationship links in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client RelationshipLinksClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result RelationshipLinkListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client RelationshipLinksClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client RelationshipLinksClient) ListByHubResponder(resp *http.Response) (result RelationshipLinkListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type RelationshipLinksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RelationshipLinksClient) (RelationshipLinkResourceFormat, error)
}RelationshipLinksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RelationshipLinksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RelationshipLinksClient) (autorest.Response, error)
}RelationshipLinksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RelationshipListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]RelationshipResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}RelationshipListResult the response of list relationship operation.
func (rlr RelationshipListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type RelationshipListResultIterator struct {
// contains filtered or unexported fields
}RelationshipListResultIterator provides access to a complete listing of RelationshipResourceFormat values.
func NewRelationshipListResultIterator(page RelationshipListResultPage) RelationshipListResultIterator
Creates a new instance of the RelationshipListResultIterator type.
func (iter *RelationshipListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *RelationshipListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter RelationshipListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RelationshipListResultIterator) Response() RelationshipListResult
Response returns the raw server response from the last page request.
func (iter RelationshipListResultIterator) Value() RelationshipResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type RelationshipListResultPage struct {
// contains filtered or unexported fields
}RelationshipListResultPage contains a page of RelationshipResourceFormat values.
func NewRelationshipListResultPage(cur RelationshipListResult, getNextPage func(context.Context, RelationshipListResult) (RelationshipListResult, error)) RelationshipListResultPage
Creates a new instance of the RelationshipListResultPage type.
func (page *RelationshipListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *RelationshipListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page RelationshipListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RelationshipListResultPage) Response() RelationshipListResult
Response returns the raw server response from the last page request.
func (page RelationshipListResultPage) Values() []RelationshipResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type RelationshipResourceFormat struct {
autorest.Response `json:"-"`
*RelationshipDefinition `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}RelationshipResourceFormat the relationship resource format.
func (rrf RelationshipResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RelationshipResourceFormat.
func (rrf *RelationshipResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RelationshipResourceFormat struct.
type RelationshipTypeFieldMapping struct {
// ProfileFieldName - Specifies the fieldName in profile.
ProfileFieldName *string `json:"profileFieldName,omitempty"`
// RelatedProfileKeyProperty - Specifies the KeyProperty (from StrongId) of the related profile.
RelatedProfileKeyProperty *string `json:"relatedProfileKeyProperty,omitempty"`
}RelationshipTypeFieldMapping map a field of profile to its corresponding StrongId in Related Profile.
type RelationshipTypeMapping struct {
// FieldMappings - Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
FieldMappings *[]RelationshipTypeFieldMapping `json:"fieldMappings,omitempty"`
}RelationshipTypeMapping maps fields in Profile to their corresponding StrongIds in Related Profile.
type RelationshipsClient struct {
BaseClient
}RelationshipsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewRelationshipsClient(subscriptionID string) RelationshipsClient
NewRelationshipsClient creates an instance of the RelationshipsClient client.
func NewRelationshipsClientWithBaseURI(baseURI string, subscriptionID string) RelationshipsClient
NewRelationshipsClientWithBaseURI creates an instance of the RelationshipsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client RelationshipsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, relationshipName string, parameters RelationshipResourceFormat) (result RelationshipsCreateOrUpdateFuture, err error)
CreateOrUpdate creates a relationship or updates an existing relationship within a hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. relationshipName - the name of the Relationship. parameters - parameters supplied to the CreateOrUpdate Relationship operation.
func (client RelationshipsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, relationshipName string, parameters RelationshipResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client RelationshipsClient) CreateOrUpdateResponder(resp *http.Response) (result RelationshipResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client RelationshipsClient) CreateOrUpdateSender(req *http.Request) (future RelationshipsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client RelationshipsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, relationshipName string) (result RelationshipsDeleteFuture, err error)
Delete deletes a relationship within a hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. relationshipName - the name of the relationship.
func (client RelationshipsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, relationshipName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client RelationshipsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client RelationshipsClient) DeleteSender(req *http.Request) (future RelationshipsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RelationshipsClient) Get(ctx context.Context, resourceGroupName string, hubName string, relationshipName string) (result RelationshipResourceFormat, err error)
Get gets information about the specified relationship. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. relationshipName - the name of the relationship.
func (client RelationshipsClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, relationshipName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RelationshipsClient) GetResponder(resp *http.Response) (result RelationshipResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client RelationshipsClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result RelationshipListResultPage, err error)
ListByHub gets all relationships in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client RelationshipsClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result RelationshipListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client RelationshipsClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client RelationshipsClient) ListByHubResponder(resp *http.Response) (result RelationshipListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type RelationshipsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RelationshipsClient) (RelationshipResourceFormat, error)
}RelationshipsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RelationshipsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RelationshipsClient) (autorest.Response, error)
}RelationshipsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RelationshipsLookup struct {
// ProfileName - READ-ONLY; The relationship profile.
ProfileName *string `json:"profileName,omitempty"`
// ProfilePropertyReferences - READ-ONLY; The property references for the profile type.
ProfilePropertyReferences *[]ParticipantPropertyReference `json:"profilePropertyReferences,omitempty"`
// RelatedProfileName - READ-ONLY; The related profile.
RelatedProfileName *string `json:"relatedProfileName,omitempty"`
// RelatedProfilePropertyReferences - READ-ONLY; The property references for the related profile type.
RelatedProfilePropertyReferences *[]ParticipantPropertyReference `json:"relatedProfilePropertyReferences,omitempty"`
// ExistingRelationshipName - READ-ONLY; The name of existing Relationship.
ExistingRelationshipName *string `json:"existingRelationshipName,omitempty"`
}RelationshipsLookup the definition of suggested relationship for the type.
type Resource struct {
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}Resource common properties of Azure resource.
MarshalJSON is the custom marshaler for Resource.
type ResourceSetDescription struct {
// Elements - The elements included in the set.
Elements *[]string `json:"elements,omitempty"`
// Exceptions - The elements that are not included in the set, in case elements contains '*' indicating 'all'.
Exceptions *[]string `json:"exceptions,omitempty"`
}ResourceSetDescription the resource set description.
type Role struct {
// RoleName - The role name.
RoleName *string `json:"roleName,omitempty"`
// Description - The description of the role.
Description *string `json:"description,omitempty"`
}Role the Role definition.
type RoleAssignment struct {
// TenantID - READ-ONLY; The hub name.
TenantID *string `json:"tenantId,omitempty"`
// AssignmentName - READ-ONLY; The name of the metadata object.
AssignmentName *string `json:"assignmentName,omitempty"`
// DisplayName - Localized display names for the metadata.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized description for the metadata.
Description map[string]*string `json:"description"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'ProvisioningStatesProvisioning', 'ProvisioningStatesSucceeded', 'ProvisioningStatesExpiring', 'ProvisioningStatesDeleting', 'ProvisioningStatesHumanIntervention', 'ProvisioningStatesFailed'
ProvisioningState ProvisioningStates `json:"provisioningState,omitempty"`
// Role - Type of roles. Possible values include: 'Admin', 'Reader', 'ManageAdmin', 'ManageReader', 'DataAdmin', 'DataReader'
Role RoleTypes `json:"role,omitempty"`
// Principals - The principals being assigned to.
Principals *[]AssignmentPrincipal `json:"principals,omitempty"`
// Profiles - Profiles set for the assignment.
Profiles *ResourceSetDescription `json:"profiles,omitempty"`
// Interactions - Interactions set for the assignment.
Interactions *ResourceSetDescription `json:"interactions,omitempty"`
// Links - Links set for the assignment.
Links *ResourceSetDescription `json:"links,omitempty"`
// Kpis - Kpis set for the assignment.
Kpis *ResourceSetDescription `json:"kpis,omitempty"`
// SasPolicies - Sas Policies set for the assignment.
SasPolicies *ResourceSetDescription `json:"sasPolicies,omitempty"`
// Connectors - Connectors set for the assignment.
Connectors *ResourceSetDescription `json:"connectors,omitempty"`
// Views - Views set for the assignment.
Views *ResourceSetDescription `json:"views,omitempty"`
// RelationshipLinks - The Role assignments set for the relationship links.
RelationshipLinks *ResourceSetDescription `json:"relationshipLinks,omitempty"`
// Relationships - The Role assignments set for the relationships.
Relationships *ResourceSetDescription `json:"relationships,omitempty"`
// WidgetTypes - Widget types set for the assignment.
WidgetTypes *ResourceSetDescription `json:"widgetTypes,omitempty"`
// RoleAssignments - The Role assignments set for the assignment.
RoleAssignments *ResourceSetDescription `json:"roleAssignments,omitempty"`
// ConflationPolicies - Widget types set for the assignment.
ConflationPolicies *ResourceSetDescription `json:"conflationPolicies,omitempty"`
// Segments - The Role assignments set for the assignment.
Segments *ResourceSetDescription `json:"segments,omitempty"`
}RoleAssignment the Role Assignment definition.
func (ra RoleAssignment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoleAssignment.
type RoleAssignmentListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]RoleAssignmentResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}RoleAssignmentListResult the response of list role assignment operation.
func (ralr RoleAssignmentListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type RoleAssignmentListResultIterator struct {
// contains filtered or unexported fields
}RoleAssignmentListResultIterator provides access to a complete listing of RoleAssignmentResourceFormat values.
func NewRoleAssignmentListResultIterator(page RoleAssignmentListResultPage) RoleAssignmentListResultIterator
Creates a new instance of the RoleAssignmentListResultIterator type.
func (iter *RoleAssignmentListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *RoleAssignmentListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter RoleAssignmentListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RoleAssignmentListResultIterator) Response() RoleAssignmentListResult
Response returns the raw server response from the last page request.
func (iter RoleAssignmentListResultIterator) Value() RoleAssignmentResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type RoleAssignmentListResultPage struct {
// contains filtered or unexported fields
}RoleAssignmentListResultPage contains a page of RoleAssignmentResourceFormat values.
func NewRoleAssignmentListResultPage(cur RoleAssignmentListResult, getNextPage func(context.Context, RoleAssignmentListResult) (RoleAssignmentListResult, error)) RoleAssignmentListResultPage
Creates a new instance of the RoleAssignmentListResultPage type.
func (page *RoleAssignmentListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *RoleAssignmentListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page RoleAssignmentListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RoleAssignmentListResultPage) Response() RoleAssignmentListResult
Response returns the raw server response from the last page request.
func (page RoleAssignmentListResultPage) Values() []RoleAssignmentResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type RoleAssignmentResourceFormat struct {
autorest.Response `json:"-"`
*RoleAssignment `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}RoleAssignmentResourceFormat the Role Assignment resource format.
func (rarf RoleAssignmentResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoleAssignmentResourceFormat.
func (rarf *RoleAssignmentResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RoleAssignmentResourceFormat struct.
type RoleAssignmentsClient struct {
BaseClient
}RoleAssignmentsClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewRoleAssignmentsClient(subscriptionID string) RoleAssignmentsClient
NewRoleAssignmentsClient creates an instance of the RoleAssignmentsClient client.
func NewRoleAssignmentsClientWithBaseURI(baseURI string, subscriptionID string) RoleAssignmentsClient
NewRoleAssignmentsClientWithBaseURI creates an instance of the RoleAssignmentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client RoleAssignmentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, assignmentName string, parameters RoleAssignmentResourceFormat) (result RoleAssignmentsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a role assignment in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. assignmentName - the assignment name parameters - parameters supplied to the CreateOrUpdate RoleAssignment operation.
func (client RoleAssignmentsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hubName string, assignmentName string, parameters RoleAssignmentResourceFormat) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client RoleAssignmentsClient) CreateOrUpdateResponder(resp *http.Response) (result RoleAssignmentResourceFormat, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client RoleAssignmentsClient) CreateOrUpdateSender(req *http.Request) (future RoleAssignmentsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client RoleAssignmentsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, assignmentName string) (result autorest.Response, err error)
Delete deletes the role assignment in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. assignmentName - the name of the role assignment.
func (client RoleAssignmentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hubName string, assignmentName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client RoleAssignmentsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RoleAssignmentsClient) Get(ctx context.Context, resourceGroupName string, hubName string, assignmentName string) (result RoleAssignmentResourceFormat, err error)
Get gets the role assignment in the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub. assignmentName - the name of the role assignment.
func (client RoleAssignmentsClient) GetPreparer(ctx context.Context, resourceGroupName string, hubName string, assignmentName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RoleAssignmentsClient) GetResponder(resp *http.Response) (result RoleAssignmentResourceFormat, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client RoleAssignmentsClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result RoleAssignmentListResultPage, err error)
ListByHub gets all the role assignments for the specified hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client RoleAssignmentsClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result RoleAssignmentListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client RoleAssignmentsClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client RoleAssignmentsClient) ListByHubResponder(resp *http.Response) (result RoleAssignmentListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type RoleAssignmentsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RoleAssignmentsClient) (RoleAssignmentResourceFormat, error)
}RoleAssignmentsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RoleListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]RoleResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}RoleListResult the response of list role assignment operation.
func (rlr RoleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type RoleListResultIterator struct {
// contains filtered or unexported fields
}RoleListResultIterator provides access to a complete listing of RoleResourceFormat values.
func NewRoleListResultIterator(page RoleListResultPage) RoleListResultIterator
Creates a new instance of the RoleListResultIterator type.
func (iter *RoleListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *RoleListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter RoleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RoleListResultIterator) Response() RoleListResult
Response returns the raw server response from the last page request.
func (iter RoleListResultIterator) Value() RoleResourceFormat
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type RoleListResultPage struct {
// contains filtered or unexported fields
}RoleListResultPage contains a page of RoleResourceFormat values.
func NewRoleListResultPage(cur RoleListResult, getNextPage func(context.Context, RoleListResult) (RoleListResult, error)) RoleListResultPage
Creates a new instance of the RoleListResultPage type.
func (page *RoleListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *RoleListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page RoleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RoleListResultPage) Response() RoleListResult
Response returns the raw server response from the last page request.
func (page RoleListResultPage) Values() []RoleResourceFormat
Values returns the slice of values for the current page or nil if there are no values.
type RoleResourceFormat struct {
*Role `json:"properties,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
}RoleResourceFormat the role resource format.
func (rrf RoleResourceFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoleResourceFormat.
func (rrf *RoleResourceFormat) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RoleResourceFormat struct.
RoleTypes enumerates the values for role types.
const (
// Admin ...
Admin RoleTypes = "Admin"
// DataAdmin ...
DataAdmin RoleTypes = "DataAdmin"
// DataReader ...
DataReader RoleTypes = "DataReader"
// ManageAdmin ...
ManageAdmin RoleTypes = "ManageAdmin"
// ManageReader ...
ManageReader RoleTypes = "ManageReader"
// Reader ...
Reader RoleTypes = "Reader"
)PossibleRoleTypesValues returns an array of possible values for the RoleTypes const type.
type RolesClient struct {
BaseClient
}RolesClient is the the Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.
func NewRolesClient(subscriptionID string) RolesClient
NewRolesClient creates an instance of the RolesClient client.
func NewRolesClientWithBaseURI(baseURI string, subscriptionID string) RolesClient
NewRolesClientWithBaseURI creates an instance of the RolesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client RolesClient) ListByHub(ctx context.Context, resourceGroupName string, hubName string) (result RoleListResultPage, err error)
ListByHub gets all the roles for the hub. Parameters: resourceGroupName - the name of the resource group. hubName - the name of the hub.
func (client RolesClient) ListByHubComplete(ctx context.Context, resourceGroupName string, hubName string) (result RoleListResultIterator, err error)
ListByHubComplete enumerates all values, automatically crossing page boundaries as required.
func (client RolesClient) ListByHubPreparer(ctx context.Context, resourceGroupName string, hubName string) (*http.Request, error)
ListByHubPreparer prepares the ListByHub request.
func (client RolesClient) ListByHubResponder(resp *http.Response) (result RoleListResult, err error)
ListByHubResponder handles the response to the ListByHub request. The method always closes the http.Response Body.
ListByHubSender sends the ListByHub request. The method will close the http.Response Body if it receives an error.
type SalesforceConnectorProperties struct {
// Usersetting - The user settings.
Usersetting *SalesforceDiscoverSetting `json:"usersetting,omitempty"`
// Salesforcetables - The Salesforce tables.
Salesforcetables *[]SalesforceTable `json:"salesforcetables,omitempty"`
}SalesforceConnectorProperties the Salesforce connector properties.
type SalesforceDiscoverSetting struct {
// SalesforceConnectionStringSecretURL - The salesforce connection string secret URL.
SalesforceConnectionStringSecretURL *string `json:"salesforceConnectionStringSecretUrl,omitempty"`
}SalesforceDiscoverSetting salesforce discover setting.
type SalesforceTable struct {
// IsProfile - Indicating whether this instance is profile.
IsProfile *string `json:"isProfile,omitempty"`
// TableCategory - The table category.
TableCategory *string `json:"tableCategory,omitempty"`
// TableName - The name of the table.
TableName *string `json:"tableName,omitempty"`
// TableRemarks - The table remarks.
TableRemarks *string `json:"tableRemarks,omitempty"`
// TableSchema - The table schema.
TableSchema *string `json:"tableSchema,omitempty"`
}SalesforceTable salesforce table.
Status enumerates the values for status.
const (
// StatusActive ...
StatusActive Status = "Active"
// StatusDeleted ...
StatusDeleted Status = "Deleted"
// StatusNone ...
StatusNone Status = "None"
)PossibleStatusValues returns an array of possible values for the Status const type.
type StrongID struct {
// KeyPropertyNames - The properties which make up the unique ID.
KeyPropertyNames *[]string `json:"keyPropertyNames,omitempty"`
// StrongIDName - The Name identifying the strong ID.
StrongIDName *string `json:"strongIdName,omitempty"`
// DisplayName - Localized display name.
DisplayName map[string]*string `json:"displayName"`
// Description - Localized descriptions.
Description map[string]*string `json:"description"`
}StrongID property/Properties which represent a unique ID.
MarshalJSON is the custom marshaler for StrongID.
type SuggestRelationshipLinksResponse struct {
autorest.Response `json:"-"`
// InteractionName - READ-ONLY; The interaction name.
InteractionName *string `json:"interactionName,omitempty"`
// SuggestedRelationships - READ-ONLY; Suggested relationships for the type.
SuggestedRelationships *[]RelationshipsLookup `json:"suggestedRelationships,omitempty"`
}SuggestRelationshipLinksResponse the response of suggest relationship links operation.
type TypePropertiesMapping struct {
// InteractionTypePropertyName - Property name on the source Interaction Type.
InteractionTypePropertyName *string `json:"interactionTypePropertyName,omitempty"`
// ProfileTypePropertyName - Property name on the target Profile Type.
ProfileTypePropertyName *string `json:"profileTypePropertyName,omitempty"`
// IsProfileTypeID - Flag to indicate whether the Profile Type property is an id on the Profile Type.
IsProfileTypeID *bool `json:"isProfileTypeId,omitempty"`
// LinkType - Link type. Possible values include: 'UpdateAlways', 'CopyIfNull'
LinkType LinkTypes `json:"linkType,omitempty"`
}TypePropertiesMapping metadata for a Link's property mapping.
type View struct {
// ViewName - READ-ONLY; Name of the view.
ViewName *string `json:"viewName,omitempty"`
// UserID - the user ID.
UserID *string `json:"userId,omitempty"`
// TenantID - READ-ONLY; the hub name.
TenantID *string `json:"tenantId,omitempty"`
// DisplayName - Localized display name for the view.
DisplayName map[string]*string `json:"displayName"`
// Definition - View definition.
Definition *string `json:"definition,omitempty"`
// Changed - READ-ONLY; Date time when view was last modified.
Changed *date.Time `json:"changed,omitempty"`
// Created - READ-ONLY; Date time when view was created.
Created *date.Time `json:"created,omitempty"`
}View the view in Customer 360 web application.
MarshalJSON is the custom marshaler for View.
type ViewListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ViewResourceFormat `json:"value,omitempty"`
// NextLink - Link to the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ViewListResult the response of list view operation.
func (vlr ViewListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ViewListResultIterator struct {
// contains filtered or unexported fields
}ViewListResultIterator provides access to a complete listing of ViewResourceFormat values.
func NewViewListResultIterator(page ViewListResultPage) ViewListResultIterator
Creates a new instance of the ViewListResultIterator type.
func (iter *ViewListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ViewListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ViewListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ViewListResultIterator) Response()