armcustomerinsights

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 23, 2023 License: MIT Imports: 14 Imported by: 2

README

Azure Customer Insights Module for Go

PkgGoDev

The armcustomerinsights module provides operations for working with Azure Customer Insights.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Customer Insights module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Customer Insights. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Customer Insights module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armcustomerinsights.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armcustomerinsights.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewHubsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Customer Insights label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AssignmentPrincipal 

type AssignmentPrincipal struct {
	// REQUIRED; The principal id being assigned to.
	PrincipalID *string

	// REQUIRED; The Type of the principal ID.
	PrincipalType *string

	// Other metadata for the principal.
	PrincipalMetadata map[string]*string
}

AssignmentPrincipal - The AssignmentPrincipal

func (AssignmentPrincipal) MarshalJSON 

func (a AssignmentPrincipal) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AssignmentPrincipal.

func (*AssignmentPrincipal) UnmarshalJSON added in v1.1.0 

func (a *AssignmentPrincipal) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AssignmentPrincipal.

type AuthorizationPoliciesClient 

type AuthorizationPoliciesClient struct {
	// contains filtered or unexported fields
}

AuthorizationPoliciesClient contains the methods for the AuthorizationPolicies group. Don't use this type directly, use NewAuthorizationPoliciesClient() instead.

func NewAuthorizationPoliciesClient 

func NewAuthorizationPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AuthorizationPoliciesClient, error)

NewAuthorizationPoliciesClient creates a new instance of AuthorizationPoliciesClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AuthorizationPoliciesClient) CreateOrUpdate 

func (client *AuthorizationPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string, parameters AuthorizationPolicyResourceFormat, options *AuthorizationPoliciesClientCreateOrUpdateOptions) (AuthorizationPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates an authorization policy or updates an existing authorization policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - AuthorizationPoliciesClientCreateOrUpdateOptions contains the optional parameters for the AuthorizationPoliciesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/AuthorizationPoliciesCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationPoliciesClient().CreateOrUpdate(ctx, "TestHubRG", "azSdkTestHub", "testPolicy4222", armcustomerinsights.AuthorizationPolicyResourceFormat{
		Properties: &armcustomerinsights.AuthorizationPolicy{
			Permissions: []*armcustomerinsights.PermissionTypes{
				to.Ptr(armcustomerinsights.PermissionTypesRead),
				to.Ptr(armcustomerinsights.PermissionTypesWrite),
				to.Ptr(armcustomerinsights.PermissionTypesManage)},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationPolicyResourceFormat = armcustomerinsights.AuthorizationPolicyResourceFormat{
	// 	Name: to.Ptr("testPolicy4222"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/AuthorizationPolicies"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups//TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/AuthorizationPolicies/testPolicy4222"),
	// 	Properties: &armcustomerinsights.AuthorizationPolicy{
	// 		Permissions: []*armcustomerinsights.PermissionTypes{
	// 			to.Ptr(armcustomerinsights.PermissionTypesRead),
	// 			to.Ptr(armcustomerinsights.PermissionTypesWrite),
	// 			to.Ptr(armcustomerinsights.PermissionTypesManage)},
	// 			PolicyName: to.Ptr("testPolicy4222"),
	// 			PrimaryKey: to.Ptr("<primaryKey>"),
	// 			SecondaryKey: to.Ptr("<secondaryKey>"),
	// 		},
	// 	}
}

Output:

func (*AuthorizationPoliciesClient) Get 

func (client *AuthorizationPoliciesClient) Get(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string, options *AuthorizationPoliciesClientGetOptions) (AuthorizationPoliciesClientGetResponse, error)

Get - Gets an authorization policy in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • authorizationPolicyName - The name of the policy.
  • options - AuthorizationPoliciesClientGetOptions contains the optional parameters for the AuthorizationPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/AuthorizationPoliciesGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationPoliciesClient().Get(ctx, "TestHubRG", "azSdkTestHub", "testPolicy4222", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationPolicyResourceFormat = armcustomerinsights.AuthorizationPolicyResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/testPolicy4222"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/AuthorizationPolicies"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/AuthorizationPolicies/testPolicy4222"),
	// 	Properties: &armcustomerinsights.AuthorizationPolicy{
	// 		Permissions: []*armcustomerinsights.PermissionTypes{
	// 			to.Ptr(armcustomerinsights.PermissionTypesRead),
	// 			to.Ptr(armcustomerinsights.PermissionTypesWrite),
	// 			to.Ptr(armcustomerinsights.PermissionTypesManage)},
	// 			PolicyName: to.Ptr("testPolicy4222"),
	// 			PrimaryKey: to.Ptr("<primaryKey>"),
	// 			SecondaryKey: to.Ptr("<secondaryKey>"),
	// 		},
	// 	}
}

Output:

func (*AuthorizationPoliciesClient) NewListByHubPager 

func (client *AuthorizationPoliciesClient) NewListByHubPager(resourceGroupName string, hubName string, options *AuthorizationPoliciesClientListByHubOptions) *runtime.Pager[AuthorizationPoliciesClientListByHubResponse]

NewListByHubPager - Gets all the authorization policies in a specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - AuthorizationPoliciesClientListByHubOptions contains the optional parameters for the AuthorizationPoliciesClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/AuthorizationPoliciesListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAuthorizationPoliciesClient().NewListByHubPager("TestHubRG", "azSdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AuthorizationPolicyListResult = armcustomerinsights.AuthorizationPolicyListResult{
		// 	Value: []*armcustomerinsights.AuthorizationPolicyResourceFormat{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub/RootManageSharedAccessKey"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/AuthorizationPolicies"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/AuthorizationPolicies/RootManageSharedAccessKey"),
		// 			Properties: &armcustomerinsights.AuthorizationPolicy{
		// 				Permissions: []*armcustomerinsights.PermissionTypes{
		// 					to.Ptr(armcustomerinsights.PermissionTypesRead),
		// 					to.Ptr(armcustomerinsights.PermissionTypesWrite),
		// 					to.Ptr(armcustomerinsights.PermissionTypesManage)},
		// 					PolicyName: to.Ptr("RootManageSharedAccessKey"),
		// 					PrimaryKey: to.Ptr("<primaryKey>"),
		// 					SecondaryKey: to.Ptr("<secondaryKey>"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("azSdkTestHub/testPolicy1125"),
		// 				Type: to.Ptr("Microsoft.CustomerInsights/hubs/AuthorizationPolicies"),
		// 				ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/AuthorizationPolicies/testPolicy1125"),
		// 				Properties: &armcustomerinsights.AuthorizationPolicy{
		// 					Permissions: []*armcustomerinsights.PermissionTypes{
		// 						to.Ptr(armcustomerinsights.PermissionTypesRead),
		// 						to.Ptr(armcustomerinsights.PermissionTypesWrite),
		// 						to.Ptr(armcustomerinsights.PermissionTypesManage)},
		// 						PolicyName: to.Ptr("testPolicy1125"),
		// 						PrimaryKey: to.Ptr("<primaryKey>"),
		// 						SecondaryKey: to.Ptr("<secondaryKey>"),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

func (*AuthorizationPoliciesClient) RegeneratePrimaryKey 

func (client *AuthorizationPoliciesClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string, options *AuthorizationPoliciesClientRegeneratePrimaryKeyOptions) (AuthorizationPoliciesClientRegeneratePrimaryKeyResponse, error)

RegeneratePrimaryKey - Regenerates the primary policy key of the specified authorization policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • authorizationPolicyName - The name of the policy.
  • options - AuthorizationPoliciesClientRegeneratePrimaryKeyOptions contains the optional parameters for the AuthorizationPoliciesClient.RegeneratePrimaryKey method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/AuthorizationPoliciesRegeneratePrimaryKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationPoliciesClient().RegeneratePrimaryKey(ctx, "TestHubRG", "azSdkTestHub", "testPolicy4222", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationPolicy = armcustomerinsights.AuthorizationPolicy{
	// 	Permissions: []*armcustomerinsights.PermissionTypes{
	// 		to.Ptr(armcustomerinsights.PermissionTypesRead),
	// 		to.Ptr(armcustomerinsights.PermissionTypesWrite),
	// 		to.Ptr(armcustomerinsights.PermissionTypesManage)},
	// 		PolicyName: to.Ptr("testPolicy4009"),
	// 		PrimaryKey: to.Ptr("<primaryKey>"),
	// 		SecondaryKey: to.Ptr("<secondaryKey>"),
	// 	}
}

Output:

func (*AuthorizationPoliciesClient) RegenerateSecondaryKey 

func (client *AuthorizationPoliciesClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, hubName string, authorizationPolicyName string, options *AuthorizationPoliciesClientRegenerateSecondaryKeyOptions) (AuthorizationPoliciesClientRegenerateSecondaryKeyResponse, error)

RegenerateSecondaryKey - Regenerates the secondary policy key of the specified authorization policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • authorizationPolicyName - The name of the policy.
  • options - AuthorizationPoliciesClientRegenerateSecondaryKeyOptions contains the optional parameters for the AuthorizationPoliciesClient.RegenerateSecondaryKey method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/AuthorizationPoliciesRegenerateSecondaryKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationPoliciesClient().RegenerateSecondaryKey(ctx, "TestHubRG", "azSdkTestHub", "testPolicy4222", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationPolicy = armcustomerinsights.AuthorizationPolicy{
	// 	Permissions: []*armcustomerinsights.PermissionTypes{
	// 		to.Ptr(armcustomerinsights.PermissionTypesRead),
	// 		to.Ptr(armcustomerinsights.PermissionTypesWrite),
	// 		to.Ptr(armcustomerinsights.PermissionTypesManage)},
	// 		PolicyName: to.Ptr("testPolicy4009"),
	// 		PrimaryKey: to.Ptr("<primaryKey>"),
	// 		SecondaryKey: to.Ptr("<secondaryKey>"),
	// 	}
}

Output:

type AuthorizationPoliciesClientCreateOrUpdateOptions 

type AuthorizationPoliciesClientCreateOrUpdateOptions struct {
}

AuthorizationPoliciesClientCreateOrUpdateOptions contains the optional parameters for the AuthorizationPoliciesClient.CreateOrUpdate method.

type AuthorizationPoliciesClientCreateOrUpdateResponse 

type AuthorizationPoliciesClientCreateOrUpdateResponse struct {
	// The authorization policy resource format.
	AuthorizationPolicyResourceFormat
}

AuthorizationPoliciesClientCreateOrUpdateResponse contains the response from method AuthorizationPoliciesClient.CreateOrUpdate.

type AuthorizationPoliciesClientGetOptions 

type AuthorizationPoliciesClientGetOptions struct {
}

AuthorizationPoliciesClientGetOptions contains the optional parameters for the AuthorizationPoliciesClient.Get method.

type AuthorizationPoliciesClientGetResponse 

type AuthorizationPoliciesClientGetResponse struct {
	// The authorization policy resource format.
	AuthorizationPolicyResourceFormat
}

AuthorizationPoliciesClientGetResponse contains the response from method AuthorizationPoliciesClient.Get.

type AuthorizationPoliciesClientListByHubOptions 

type AuthorizationPoliciesClientListByHubOptions struct {
}

AuthorizationPoliciesClientListByHubOptions contains the optional parameters for the AuthorizationPoliciesClient.NewListByHubPager method.

type AuthorizationPoliciesClientListByHubResponse 

type AuthorizationPoliciesClientListByHubResponse struct {
	// The response of list authorization policy operation.
	AuthorizationPolicyListResult
}

AuthorizationPoliciesClientListByHubResponse contains the response from method AuthorizationPoliciesClient.NewListByHubPager.

type AuthorizationPoliciesClientRegeneratePrimaryKeyOptions 

type AuthorizationPoliciesClientRegeneratePrimaryKeyOptions struct {
}

AuthorizationPoliciesClientRegeneratePrimaryKeyOptions contains the optional parameters for the AuthorizationPoliciesClient.RegeneratePrimaryKey method.

type AuthorizationPoliciesClientRegeneratePrimaryKeyResponse 

type AuthorizationPoliciesClientRegeneratePrimaryKeyResponse struct {
	// The authorization policy.
	AuthorizationPolicy
}

AuthorizationPoliciesClientRegeneratePrimaryKeyResponse contains the response from method AuthorizationPoliciesClient.RegeneratePrimaryKey.

type AuthorizationPoliciesClientRegenerateSecondaryKeyOptions 

type AuthorizationPoliciesClientRegenerateSecondaryKeyOptions struct {
}

AuthorizationPoliciesClientRegenerateSecondaryKeyOptions contains the optional parameters for the AuthorizationPoliciesClient.RegenerateSecondaryKey method.

type AuthorizationPoliciesClientRegenerateSecondaryKeyResponse 

type AuthorizationPoliciesClientRegenerateSecondaryKeyResponse struct {
	// The authorization policy.
	AuthorizationPolicy
}

AuthorizationPoliciesClientRegenerateSecondaryKeyResponse contains the response from method AuthorizationPoliciesClient.RegenerateSecondaryKey.

type AuthorizationPolicy 

type AuthorizationPolicy struct {
	// REQUIRED; The permissions associated with the policy.
	Permissions []*PermissionTypes

	// Primary key associated with the policy.
	PrimaryKey *string

	// Secondary key associated with the policy.
	SecondaryKey *string

	// READ-ONLY; Name of the policy.
	PolicyName *string
}

AuthorizationPolicy - The authorization policy.

func (AuthorizationPolicy) MarshalJSON 

func (a AuthorizationPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationPolicy.

func (*AuthorizationPolicy) UnmarshalJSON added in v1.1.0 

func (a *AuthorizationPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationPolicy.

type AuthorizationPolicyListResult 

type AuthorizationPolicyListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*AuthorizationPolicyResourceFormat
}

AuthorizationPolicyListResult - The response of list authorization policy operation.

func (AuthorizationPolicyListResult) MarshalJSON added in v1.1.0 

func (a AuthorizationPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationPolicyListResult.

func (*AuthorizationPolicyListResult) UnmarshalJSON added in v1.1.0 

func (a *AuthorizationPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationPolicyListResult.

type AuthorizationPolicyResourceFormat 

type AuthorizationPolicyResourceFormat struct {
	// The authorization policy.
	Properties *AuthorizationPolicy

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

AuthorizationPolicyResourceFormat - The authorization policy resource format.

func (AuthorizationPolicyResourceFormat) MarshalJSON added in v1.1.0 

func (a AuthorizationPolicyResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationPolicyResourceFormat.

func (*AuthorizationPolicyResourceFormat) UnmarshalJSON added in v1.1.0 

func (a *AuthorizationPolicyResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationPolicyResourceFormat.

type AzureBlobConnectorProperties 

type AzureBlobConnectorProperties struct {
	// REQUIRED; The connection KeyVault URL.
	ConnectionKeyVaultURL *string
}

AzureBlobConnectorProperties - The Azure Blob connector properties.

func (AzureBlobConnectorProperties) MarshalJSON added in v1.1.0 

func (a AzureBlobConnectorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBlobConnectorProperties.

func (*AzureBlobConnectorProperties) UnmarshalJSON added in v1.1.0 

func (a *AzureBlobConnectorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBlobConnectorProperties.

type CalculationWindowTypes 

type CalculationWindowTypes string

CalculationWindowTypes - The calculation window. 

const (
	CalculationWindowTypesDay      CalculationWindowTypes = "Day"
	CalculationWindowTypesHour     CalculationWindowTypes = "Hour"
	CalculationWindowTypesLifetime CalculationWindowTypes = "Lifetime"
	CalculationWindowTypesMonth    CalculationWindowTypes = "Month"
	CalculationWindowTypesWeek     CalculationWindowTypes = "Week"
)

func PossibleCalculationWindowTypesValues 

func PossibleCalculationWindowTypesValues() []CalculationWindowTypes

PossibleCalculationWindowTypesValues returns the possible values for the CalculationWindowTypes const type.

type CanonicalProfileDefinition 

type CanonicalProfileDefinition struct {
	// Canonical profile ID.
	CanonicalProfileID *int32

	// Properties of the canonical profile.
	Properties []*CanonicalProfileDefinitionPropertiesItem
}

CanonicalProfileDefinition - Definition of canonical profile.

func (CanonicalProfileDefinition) MarshalJSON added in v1.1.0 

func (c CanonicalProfileDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CanonicalProfileDefinition.

func (*CanonicalProfileDefinition) UnmarshalJSON added in v1.1.0 

func (c *CanonicalProfileDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CanonicalProfileDefinition.

type CanonicalProfileDefinitionPropertiesItem 

type CanonicalProfileDefinitionPropertiesItem struct {
	// Profile name.
	ProfileName *string

	// Property name of profile.
	ProfilePropertyName *string

	// The rank.
	Rank *int32

	// Type of canonical property value.
	Type *CanonicalPropertyValueType

	// Value of the canonical property.
	Value *string
}

CanonicalProfileDefinitionPropertiesItem - The definition of a canonical profile property.

func (CanonicalProfileDefinitionPropertiesItem) MarshalJSON added in v1.1.0 

func (c CanonicalProfileDefinitionPropertiesItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CanonicalProfileDefinitionPropertiesItem.

func (*CanonicalProfileDefinitionPropertiesItem) UnmarshalJSON added in v1.1.0 

func (c *CanonicalProfileDefinitionPropertiesItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CanonicalProfileDefinitionPropertiesItem.

type CanonicalPropertyValueType 

type CanonicalPropertyValueType string

CanonicalPropertyValueType - Type of canonical property value. 

const (
	CanonicalPropertyValueTypeCategorical        CanonicalPropertyValueType = "Categorical"
	CanonicalPropertyValueTypeDerivedCategorical CanonicalPropertyValueType = "DerivedCategorical"
	CanonicalPropertyValueTypeDerivedNumeric     CanonicalPropertyValueType = "DerivedNumeric"
	CanonicalPropertyValueTypeNumeric            CanonicalPropertyValueType = "Numeric"
)

func PossibleCanonicalPropertyValueTypeValues 

func PossibleCanonicalPropertyValueTypeValues() []CanonicalPropertyValueType

PossibleCanonicalPropertyValueTypeValues returns the possible values for the CanonicalPropertyValueType const type.

type CardinalityTypes 

type CardinalityTypes string

CardinalityTypes - The Relationship Cardinality. 

const (
	CardinalityTypesManyToMany CardinalityTypes = "ManyToMany"
	CardinalityTypesOneToMany  CardinalityTypes = "OneToMany"
	CardinalityTypesOneToOne   CardinalityTypes = "OneToOne"
)

func PossibleCardinalityTypesValues 

func PossibleCardinalityTypesValues() []CardinalityTypes

PossibleCardinalityTypesValues returns the possible values for the CardinalityTypes const type.

type ClientFactory added in v1.1.0 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v1.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAuthorizationPoliciesClient added in v1.1.0 

func (c *ClientFactory) NewAuthorizationPoliciesClient() *AuthorizationPoliciesClient

NewAuthorizationPoliciesClient creates a new instance of AuthorizationPoliciesClient.

func (*ClientFactory) NewConnectorMappingsClient added in v1.1.0 

func (c *ClientFactory) NewConnectorMappingsClient() *ConnectorMappingsClient

NewConnectorMappingsClient creates a new instance of ConnectorMappingsClient.

func (*ClientFactory) NewConnectorsClient added in v1.1.0 

func (c *ClientFactory) NewConnectorsClient() *ConnectorsClient

NewConnectorsClient creates a new instance of ConnectorsClient.

func (*ClientFactory) NewHubsClient added in v1.1.0 

func (c *ClientFactory) NewHubsClient() *HubsClient

NewHubsClient creates a new instance of HubsClient.

func (*ClientFactory) NewImagesClient added in v1.1.0 

func (c *ClientFactory) NewImagesClient() *ImagesClient

NewImagesClient creates a new instance of ImagesClient.

func (*ClientFactory) NewInteractionsClient added in v1.1.0 

func (c *ClientFactory) NewInteractionsClient() *InteractionsClient

NewInteractionsClient creates a new instance of InteractionsClient.

func (*ClientFactory) NewKpiClient added in v1.1.0 

func (c *ClientFactory) NewKpiClient() *KpiClient

NewKpiClient creates a new instance of KpiClient.

func (*ClientFactory) NewLinksClient added in v1.1.0 

func (c *ClientFactory) NewLinksClient() *LinksClient

NewLinksClient creates a new instance of LinksClient.

func (*ClientFactory) NewOperationsClient added in v1.1.0 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPredictionsClient added in v1.1.0 

func (c *ClientFactory) NewPredictionsClient() *PredictionsClient

NewPredictionsClient creates a new instance of PredictionsClient.

func (*ClientFactory) NewProfilesClient added in v1.1.0 

func (c *ClientFactory) NewProfilesClient() *ProfilesClient

NewProfilesClient creates a new instance of ProfilesClient.

func (*ClientFactory) NewRelationshipLinksClient added in v1.1.0 

func (c *ClientFactory) NewRelationshipLinksClient() *RelationshipLinksClient

NewRelationshipLinksClient creates a new instance of RelationshipLinksClient.

func (*ClientFactory) NewRelationshipsClient added in v1.1.0 

func (c *ClientFactory) NewRelationshipsClient() *RelationshipsClient

NewRelationshipsClient creates a new instance of RelationshipsClient.

func (*ClientFactory) NewRoleAssignmentsClient added in v1.1.0 

func (c *ClientFactory) NewRoleAssignmentsClient() *RoleAssignmentsClient

NewRoleAssignmentsClient creates a new instance of RoleAssignmentsClient.

func (*ClientFactory) NewRolesClient added in v1.1.0 

func (c *ClientFactory) NewRolesClient() *RolesClient

NewRolesClient creates a new instance of RolesClient.

func (*ClientFactory) NewViewsClient added in v1.1.0 

func (c *ClientFactory) NewViewsClient() *ViewsClient

NewViewsClient creates a new instance of ViewsClient.

func (*ClientFactory) NewWidgetTypesClient added in v1.1.0 

func (c *ClientFactory) NewWidgetTypesClient() *WidgetTypesClient

NewWidgetTypesClient creates a new instance of WidgetTypesClient.

type CompletionOperationTypes 

type CompletionOperationTypes string

CompletionOperationTypes - The type of completion operation. 

const (
	CompletionOperationTypesDeleteFile CompletionOperationTypes = "DeleteFile"
	CompletionOperationTypesDoNothing  CompletionOperationTypes = "DoNothing"
	CompletionOperationTypesMoveFile   CompletionOperationTypes = "MoveFile"
)

func PossibleCompletionOperationTypesValues 

func PossibleCompletionOperationTypesValues() []CompletionOperationTypes

PossibleCompletionOperationTypesValues returns the possible values for the CompletionOperationTypes const type.

type Connector 

type Connector struct {
	// REQUIRED; The connector properties.
	ConnectorProperties map[string]any

	// REQUIRED; Type of connector.
	ConnectorType *ConnectorTypes

	// Name of the connector.
	ConnectorName *string

	// Description of the connector.
	Description *string

	// Display name of the connector.
	DisplayName *string

	// If this is an internal connector.
	IsInternal *bool

	// READ-ONLY; ID of the connector.
	ConnectorID *int32

	// READ-ONLY; The created time.
	Created *time.Time

	// READ-ONLY; The last modified time.
	LastModified *time.Time

	// READ-ONLY; State of connector.
	State *ConnectorStates

	// READ-ONLY; The hub name.
	TenantID *string
}

Connector - Properties of connector.

func (Connector) MarshalJSON 

func (c Connector) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Connector.

func (*Connector) UnmarshalJSON 

func (c *Connector) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Connector.

type ConnectorListResult 

type ConnectorListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*ConnectorResourceFormat
}

ConnectorListResult - The response of list connector operation.

func (ConnectorListResult) MarshalJSON added in v1.1.0 

func (c ConnectorListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorListResult.

func (*ConnectorListResult) UnmarshalJSON added in v1.1.0 

func (c *ConnectorListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorListResult.

type ConnectorMapping 

type ConnectorMapping struct {
	// REQUIRED; Defines which entity type the file should map to.
	EntityType *EntityTypes

	// REQUIRED; The mapping entity name.
	EntityTypeName *string

	// REQUIRED; The properties of the mapping.
	MappingProperties *ConnectorMappingProperties

	// Type of connector.
	ConnectorType *ConnectorTypes

	// The description of the connector mapping.
	Description *string

	// Display name for the connector mapping.
	DisplayName *string

	// READ-ONLY; The connector mapping name
	ConnectorMappingName *string

	// READ-ONLY; The connector name.
	ConnectorName *string

	// READ-ONLY; The created time.
	Created *time.Time

	// READ-ONLY; The DataFormat ID.
	DataFormatID *string

	// READ-ONLY; The last modified time.
	LastModified *time.Time

	// READ-ONLY; The next run time based on customer's settings.
	NextRunTime *time.Time

	// READ-ONLY; The RunId.
	RunID *string

	// READ-ONLY; State of connector mapping.
	State *ConnectorMappingStates

	// READ-ONLY; The hub name.
	TenantID *string
}

ConnectorMapping - The connector mapping definition.

func (ConnectorMapping) MarshalJSON 

func (c ConnectorMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMapping.

func (*ConnectorMapping) UnmarshalJSON 

func (c *ConnectorMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMapping.

type ConnectorMappingAvailability 

type ConnectorMappingAvailability struct {
	// REQUIRED; The interval of the given frequency to use.
	Interval *int32

	// The frequency to update.
	Frequency *FrequencyTypes
}

ConnectorMappingAvailability - Connector mapping property availability.

func (ConnectorMappingAvailability) MarshalJSON added in v1.1.0 

func (c ConnectorMappingAvailability) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingAvailability.

func (*ConnectorMappingAvailability) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingAvailability) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingAvailability.

type ConnectorMappingCompleteOperation 

type ConnectorMappingCompleteOperation struct {
	// The type of completion operation.
	CompletionOperationType *CompletionOperationTypes

	// The destination folder where files will be moved to once the import is done.
	DestinationFolder *string
}

ConnectorMappingCompleteOperation - The complete operation.

func (ConnectorMappingCompleteOperation) MarshalJSON added in v1.1.0 

func (c ConnectorMappingCompleteOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingCompleteOperation.

func (*ConnectorMappingCompleteOperation) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingCompleteOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingCompleteOperation.

type ConnectorMappingErrorManagement 

type ConnectorMappingErrorManagement struct {
	// REQUIRED; The type of error management to use for the mapping.
	ErrorManagementType *ErrorManagementTypes

	// The error limit allowed while importing data.
	ErrorLimit *int32
}

ConnectorMappingErrorManagement - The error management.

func (ConnectorMappingErrorManagement) MarshalJSON added in v1.1.0 

func (c ConnectorMappingErrorManagement) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingErrorManagement.

func (*ConnectorMappingErrorManagement) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingErrorManagement) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingErrorManagement.

type ConnectorMappingFormat 

type ConnectorMappingFormat struct {
	// CONSTANT; The type mapping format.
	// Field has constant value "TextFormat", any specified value is ignored.
	FormatType *string

	// The oData language.
	AcceptLanguage *string

	// Character separating array elements.
	ArraySeparator *string

	// The character that signifies a break between columns.
	ColumnDelimiter *string

	// Quote character, used to indicate enquoted fields.
	QuoteCharacter *string

	// Escape character for quotes, can be the same as the quoteCharacter.
	QuoteEscapeCharacter *string
}

ConnectorMappingFormat - Connector mapping property format.

func (ConnectorMappingFormat) MarshalJSON added in v1.1.0 

func (c ConnectorMappingFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingFormat.

func (*ConnectorMappingFormat) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingFormat.

type ConnectorMappingListResult 

type ConnectorMappingListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*ConnectorMappingResourceFormat
}

ConnectorMappingListResult - The response of list connector mapping operation.

func (ConnectorMappingListResult) MarshalJSON added in v1.1.0 

func (c ConnectorMappingListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingListResult.

func (*ConnectorMappingListResult) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingListResult.

type ConnectorMappingProperties 

type ConnectorMappingProperties struct {
	// REQUIRED; The availability of mapping property.
	Availability *ConnectorMappingAvailability

	// REQUIRED; The operation after import is done.
	CompleteOperation *ConnectorMappingCompleteOperation

	// REQUIRED; The error management setting for the mapping.
	ErrorManagement *ConnectorMappingErrorManagement

	// REQUIRED; The format of mapping property.
	Format *ConnectorMappingFormat

	// REQUIRED; Ingestion mapping information at property level.
	Structure []*ConnectorMappingStructure

	// The file filter for the mapping.
	FileFilter *string

	// The folder path for the mapping.
	FolderPath *string

	// If the file contains a header or not.
	HasHeader *bool
}

ConnectorMappingProperties - The connector mapping properties.

func (ConnectorMappingProperties) MarshalJSON 

func (c ConnectorMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingProperties.

func (*ConnectorMappingProperties) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingProperties.

type ConnectorMappingResourceFormat 

type ConnectorMappingResourceFormat struct {
	// The connector mapping definition.
	Properties *ConnectorMapping

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

ConnectorMappingResourceFormat - The connector mapping resource format.

func (ConnectorMappingResourceFormat) MarshalJSON added in v1.1.0 

func (c ConnectorMappingResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingResourceFormat.

func (*ConnectorMappingResourceFormat) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingResourceFormat.

type ConnectorMappingStates 

type ConnectorMappingStates string

ConnectorMappingStates - State of connector mapping. 

const (
	ConnectorMappingStatesCreated  ConnectorMappingStates = "Created"
	ConnectorMappingStatesCreating ConnectorMappingStates = "Creating"
	ConnectorMappingStatesExpiring ConnectorMappingStates = "Expiring"
	ConnectorMappingStatesFailed   ConnectorMappingStates = "Failed"
	ConnectorMappingStatesReady    ConnectorMappingStates = "Ready"
	ConnectorMappingStatesRunning  ConnectorMappingStates = "Running"
	ConnectorMappingStatesStopped  ConnectorMappingStates = "Stopped"
)

func PossibleConnectorMappingStatesValues 

func PossibleConnectorMappingStatesValues() []ConnectorMappingStates

PossibleConnectorMappingStatesValues returns the possible values for the ConnectorMappingStates const type.

type ConnectorMappingStructure 

type ConnectorMappingStructure struct {
	// REQUIRED; The column name of the import file.
	ColumnName *string

	// REQUIRED; The property name of the mapping entity.
	PropertyName *string

	// Custom format specifier for input parsing.
	CustomFormatSpecifier *string

	// Indicates if the column is encrypted.
	IsEncrypted *bool
}

ConnectorMappingStructure - Connector mapping property structure.

func (ConnectorMappingStructure) MarshalJSON added in v1.1.0 

func (c ConnectorMappingStructure) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorMappingStructure.

func (*ConnectorMappingStructure) UnmarshalJSON added in v1.1.0 

func (c *ConnectorMappingStructure) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorMappingStructure.

type ConnectorMappingsClient 

type ConnectorMappingsClient struct {
	// contains filtered or unexported fields
}

ConnectorMappingsClient contains the methods for the ConnectorMappings group. Don't use this type directly, use NewConnectorMappingsClient() instead.

func NewConnectorMappingsClient 

func NewConnectorMappingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectorMappingsClient, error)

NewConnectorMappingsClient creates a new instance of ConnectorMappingsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConnectorMappingsClient) CreateOrUpdate 

func (client *ConnectorMappingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string, parameters ConnectorMappingResourceFormat, options *ConnectorMappingsClientCreateOrUpdateOptions) (ConnectorMappingsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a connector mapping or updates an existing connector mapping in the connector. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - ConnectorMappingsClientCreateOrUpdateOptions contains the optional parameters for the ConnectorMappingsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorMappingsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConnectorMappingsClient().CreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "testConnector8858", "testMapping12491", armcustomerinsights.ConnectorMappingResourceFormat{
		Properties: &armcustomerinsights.ConnectorMapping{
			Description:    to.Ptr("Test mapping"),
			DisplayName:    to.Ptr("testMapping12491"),
			EntityType:     to.Ptr(armcustomerinsights.EntityTypesInteraction),
			EntityTypeName: to.Ptr("TestInteractionType2967"),
			MappingProperties: &armcustomerinsights.ConnectorMappingProperties{
				Format: &armcustomerinsights.ConnectorMappingFormat{
					ColumnDelimiter: to.Ptr("|"),
					FormatType:      to.Ptr("TextFormat"),
				},
				Availability: &armcustomerinsights.ConnectorMappingAvailability{
					Frequency: to.Ptr(armcustomerinsights.FrequencyTypesHour),
					Interval:  to.Ptr[int32](5),
				},
				CompleteOperation: &armcustomerinsights.ConnectorMappingCompleteOperation{
					CompletionOperationType: to.Ptr(armcustomerinsights.CompletionOperationTypesDeleteFile),
					DestinationFolder:       to.Ptr("fakePath"),
				},
				ErrorManagement: &armcustomerinsights.ConnectorMappingErrorManagement{
					ErrorLimit:          to.Ptr[int32](10),
					ErrorManagementType: to.Ptr(armcustomerinsights.ErrorManagementTypesStopImport),
				},
				FileFilter: to.Ptr("unknown"),
				FolderPath: to.Ptr("http://sample.dne/file"),
				HasHeader:  to.Ptr(false),
				Structure: []*armcustomerinsights.ConnectorMappingStructure{
					{
						ColumnName:   to.Ptr("unknown1"),
						IsEncrypted:  to.Ptr(false),
						PropertyName: to.Ptr("unknwon1"),
					},
					{
						ColumnName:   to.Ptr("unknown2"),
						IsEncrypted:  to.Ptr(true),
						PropertyName: to.Ptr("unknwon2"),
					}},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConnectorMappingResourceFormat = armcustomerinsights.ConnectorMappingResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testConnector8858/testMapping12491"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/mappings"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/connectors/testConnector8858/mappings/testMapping12491"),
	// 	Properties: &armcustomerinsights.ConnectorMapping{
	// 		Description: to.Ptr("Test mapping"),
	// 		ConnectorMappingName: to.Ptr("testMapping12491"),
	// 		ConnectorName: to.Ptr("testConnector8858"),
	// 		ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
	// 		DataFormatID: to.Ptr("4619d4e7e8a64c1e9bc34907f9f46505"),
	// 		DisplayName: to.Ptr("testMapping12491"),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
	// 		EntityTypeName: to.Ptr("TestInteractionType2967"),
	// 		MappingProperties: &armcustomerinsights.ConnectorMappingProperties{
	// 			Format: &armcustomerinsights.ConnectorMappingFormat{
	// 				AcceptLanguage: to.Ptr(""),
	// 				ArraySeparator: to.Ptr(";"),
	// 				ColumnDelimiter: to.Ptr("|"),
	// 				FormatType: to.Ptr("TextFormat"),
	// 				QuoteCharacter: to.Ptr("\\\""),
	// 				QuoteEscapeCharacter: to.Ptr("\\\""),
	// 			},
	// 			Availability: &armcustomerinsights.ConnectorMappingAvailability{
	// 				Frequency: to.Ptr(armcustomerinsights.FrequencyTypesHour),
	// 				Interval: to.Ptr[int32](5),
	// 			},
	// 			CompleteOperation: &armcustomerinsights.ConnectorMappingCompleteOperation{
	// 				CompletionOperationType: to.Ptr(armcustomerinsights.CompletionOperationTypesDeleteFile),
	// 				DestinationFolder: to.Ptr("fakePath"),
	// 			},
	// 			ErrorManagement: &armcustomerinsights.ConnectorMappingErrorManagement{
	// 				ErrorLimit: to.Ptr[int32](10),
	// 				ErrorManagementType: to.Ptr(armcustomerinsights.ErrorManagementTypesStopImport),
	// 			},
	// 			FileFilter: to.Ptr("unknown"),
	// 			FolderPath: to.Ptr("http://sample.dne/file"),
	// 			HasHeader: to.Ptr(false),
	// 			Structure: []*armcustomerinsights.ConnectorMappingStructure{
	// 				{
	// 					ColumnName: to.Ptr("unknown1"),
	// 					IsEncrypted: to.Ptr(false),
	// 					PropertyName: to.Ptr("unknwon1"),
	// 				},
	// 				{
	// 					ColumnName: to.Ptr("unknown2"),
	// 					IsEncrypted: to.Ptr(true),
	// 					PropertyName: to.Ptr("unknwon2"),
	// 			}},
	// 		},
	// 		State: to.Ptr(armcustomerinsights.ConnectorMappingStatesCreated),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*ConnectorMappingsClient) Delete 

func (client *ConnectorMappingsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string, options *ConnectorMappingsClientDeleteOptions) (ConnectorMappingsClientDeleteResponse, error)

Delete - Deletes a connector mapping in the connector. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - ConnectorMappingsClientDeleteOptions contains the optional parameters for the ConnectorMappingsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorMappingsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewConnectorMappingsClient().Delete(ctx, "TestHubRG", "sdkTestHub", "testConnector8858", "testMapping12491", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ConnectorMappingsClient) Get 

func (client *ConnectorMappingsClient) Get(ctx context.Context, resourceGroupName string, hubName string, connectorName string, mappingName string, options *ConnectorMappingsClientGetOptions) (ConnectorMappingsClientGetResponse, error)

Get - Gets a connector mapping in the connector. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - ConnectorMappingsClientGetOptions contains the optional parameters for the ConnectorMappingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorMappingsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConnectorMappingsClient().Get(ctx, "TestHubRG", "sdkTestHub", "testConnector8858", "testMapping12491", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConnectorMappingResourceFormat = armcustomerinsights.ConnectorMappingResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testConnector8858/testMapping12491"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/mappings"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/connectors/testConnector8858/mappings/testMapping12491"),
	// 	Properties: &armcustomerinsights.ConnectorMapping{
	// 		Description: to.Ptr("Test mapping"),
	// 		ConnectorMappingName: to.Ptr("testMapping12491"),
	// 		ConnectorName: to.Ptr("testConnector8858"),
	// 		ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
	// 		DataFormatID: to.Ptr("4619d4e7e8a64c1e9bc34907f9f46505"),
	// 		DisplayName: to.Ptr("testMapping12491"),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
	// 		EntityTypeName: to.Ptr("TestInteractionType2967"),
	// 		MappingProperties: &armcustomerinsights.ConnectorMappingProperties{
	// 			Format: &armcustomerinsights.ConnectorMappingFormat{
	// 				AcceptLanguage: to.Ptr(""),
	// 				ArraySeparator: to.Ptr(";"),
	// 				ColumnDelimiter: to.Ptr("|"),
	// 				FormatType: to.Ptr("TextFormat"),
	// 				QuoteCharacter: to.Ptr("\\\""),
	// 				QuoteEscapeCharacter: to.Ptr("\\\""),
	// 			},
	// 			Availability: &armcustomerinsights.ConnectorMappingAvailability{
	// 				Frequency: to.Ptr(armcustomerinsights.FrequencyTypesHour),
	// 				Interval: to.Ptr[int32](5),
	// 			},
	// 			CompleteOperation: &armcustomerinsights.ConnectorMappingCompleteOperation{
	// 				CompletionOperationType: to.Ptr(armcustomerinsights.CompletionOperationTypesDeleteFile),
	// 				DestinationFolder: to.Ptr("fakePath"),
	// 			},
	// 			ErrorManagement: &armcustomerinsights.ConnectorMappingErrorManagement{
	// 				ErrorLimit: to.Ptr[int32](10),
	// 				ErrorManagementType: to.Ptr(armcustomerinsights.ErrorManagementTypesStopImport),
	// 			},
	// 			FileFilter: to.Ptr("unknown"),
	// 			FolderPath: to.Ptr("http://sample.dne/file"),
	// 			HasHeader: to.Ptr(false),
	// 			Structure: []*armcustomerinsights.ConnectorMappingStructure{
	// 				{
	// 					ColumnName: to.Ptr("unknown1"),
	// 					IsEncrypted: to.Ptr(false),
	// 					PropertyName: to.Ptr("unknwon1"),
	// 				},
	// 				{
	// 					ColumnName: to.Ptr("unknown2"),
	// 					IsEncrypted: to.Ptr(true),
	// 					PropertyName: to.Ptr("unknwon2"),
	// 			}},
	// 		},
	// 		State: to.Ptr(armcustomerinsights.ConnectorMappingStatesCreated),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*ConnectorMappingsClient) NewListByConnectorPager 

func (client *ConnectorMappingsClient) NewListByConnectorPager(resourceGroupName string, hubName string, connectorName string, options *ConnectorMappingsClientListByConnectorOptions) *runtime.Pager[ConnectorMappingsClientListByConnectorResponse]

NewListByConnectorPager - Gets all the connector mappings in the specified connector.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • connectorName - The name of the connector.
  • options - ConnectorMappingsClientListByConnectorOptions contains the optional parameters for the ConnectorMappingsClient.NewListByConnectorPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorMappingsListByConnector.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewConnectorMappingsClient().NewListByConnectorPager("TestHubRG", "sdkTestHub", "testConnector8858", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ConnectorMappingListResult = armcustomerinsights.ConnectorMappingListResult{
		// 	Value: []*armcustomerinsights.ConnectorMappingResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/testConnector8858/testMapping12491"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/mappings"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/connectors/testConnector8858/mappings/testMapping12491"),
		// 			Properties: &armcustomerinsights.ConnectorMapping{
		// 				Description: to.Ptr("Test mapping"),
		// 				ConnectorMappingName: to.Ptr("testMapping12491"),
		// 				ConnectorName: to.Ptr("testConnector8858"),
		// 				ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
		// 				DataFormatID: to.Ptr("4619d4e7e8a64c1e9bc34907f9f46505"),
		// 				DisplayName: to.Ptr("testMapping12491"),
		// 				EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
		// 				EntityTypeName: to.Ptr("TestInteractionType2967"),
		// 				MappingProperties: &armcustomerinsights.ConnectorMappingProperties{
		// 					Format: &armcustomerinsights.ConnectorMappingFormat{
		// 						AcceptLanguage: to.Ptr(""),
		// 						ArraySeparator: to.Ptr(";"),
		// 						ColumnDelimiter: to.Ptr("|"),
		// 						FormatType: to.Ptr("TextFormat"),
		// 						QuoteCharacter: to.Ptr("\\\""),
		// 						QuoteEscapeCharacter: to.Ptr("\\\""),
		// 					},
		// 					Availability: &armcustomerinsights.ConnectorMappingAvailability{
		// 						Frequency: to.Ptr(armcustomerinsights.FrequencyTypesHour),
		// 						Interval: to.Ptr[int32](5),
		// 					},
		// 					CompleteOperation: &armcustomerinsights.ConnectorMappingCompleteOperation{
		// 						CompletionOperationType: to.Ptr(armcustomerinsights.CompletionOperationTypesDeleteFile),
		// 						DestinationFolder: to.Ptr("fakePath"),
		// 					},
		// 					ErrorManagement: &armcustomerinsights.ConnectorMappingErrorManagement{
		// 						ErrorLimit: to.Ptr[int32](10),
		// 						ErrorManagementType: to.Ptr(armcustomerinsights.ErrorManagementTypesStopImport),
		// 					},
		// 					FileFilter: to.Ptr("unknown"),
		// 					FolderPath: to.Ptr("http://sample.dne/file"),
		// 					HasHeader: to.Ptr(false),
		// 					Structure: []*armcustomerinsights.ConnectorMappingStructure{
		// 						{
		// 							ColumnName: to.Ptr("unknown1"),
		// 							IsEncrypted: to.Ptr(false),
		// 							PropertyName: to.Ptr("unknwon1"),
		// 						},
		// 						{
		// 							ColumnName: to.Ptr("unknown2"),
		// 							IsEncrypted: to.Ptr(true),
		// 							PropertyName: to.Ptr("unknwon2"),
		// 					}},
		// 				},
		// 				State: to.Ptr(armcustomerinsights.ConnectorMappingStatesCreated),
		// 				TenantID: to.Ptr("sdktesthub"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type ConnectorMappingsClientCreateOrUpdateOptions 

type ConnectorMappingsClientCreateOrUpdateOptions struct {
}

ConnectorMappingsClientCreateOrUpdateOptions contains the optional parameters for the ConnectorMappingsClient.CreateOrUpdate method.

type ConnectorMappingsClientCreateOrUpdateResponse 

type ConnectorMappingsClientCreateOrUpdateResponse struct {
	// The connector mapping resource format.
	ConnectorMappingResourceFormat
}

ConnectorMappingsClientCreateOrUpdateResponse contains the response from method ConnectorMappingsClient.CreateOrUpdate.

type ConnectorMappingsClientDeleteOptions 

type ConnectorMappingsClientDeleteOptions struct {
}

ConnectorMappingsClientDeleteOptions contains the optional parameters for the ConnectorMappingsClient.Delete method.

type ConnectorMappingsClientDeleteResponse 

type ConnectorMappingsClientDeleteResponse struct {
}

ConnectorMappingsClientDeleteResponse contains the response from method ConnectorMappingsClient.Delete.

type ConnectorMappingsClientGetOptions 

type ConnectorMappingsClientGetOptions struct {
}

ConnectorMappingsClientGetOptions contains the optional parameters for the ConnectorMappingsClient.Get method.

type ConnectorMappingsClientGetResponse 

type ConnectorMappingsClientGetResponse struct {
	// The connector mapping resource format.
	ConnectorMappingResourceFormat
}

ConnectorMappingsClientGetResponse contains the response from method ConnectorMappingsClient.Get.

type ConnectorMappingsClientListByConnectorOptions 

type ConnectorMappingsClientListByConnectorOptions struct {
}

ConnectorMappingsClientListByConnectorOptions contains the optional parameters for the ConnectorMappingsClient.NewListByConnectorPager method.

type ConnectorMappingsClientListByConnectorResponse 

type ConnectorMappingsClientListByConnectorResponse struct {
	// The response of list connector mapping operation.
	ConnectorMappingListResult
}

ConnectorMappingsClientListByConnectorResponse contains the response from method ConnectorMappingsClient.NewListByConnectorPager.

type ConnectorResourceFormat 

type ConnectorResourceFormat struct {
	// Properties of connector.
	Properties *Connector

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

ConnectorResourceFormat - The connector resource format.

func (ConnectorResourceFormat) MarshalJSON added in v1.1.0 

func (c ConnectorResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectorResourceFormat.

func (*ConnectorResourceFormat) UnmarshalJSON added in v1.1.0 

func (c *ConnectorResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectorResourceFormat.

type ConnectorStates 

type ConnectorStates string

ConnectorStates - State of connector. 

const (
	ConnectorStatesCreated  ConnectorStates = "Created"
	ConnectorStatesCreating ConnectorStates = "Creating"
	ConnectorStatesDeleting ConnectorStates = "Deleting"
	ConnectorStatesExpiring ConnectorStates = "Expiring"
	ConnectorStatesFailed   ConnectorStates = "Failed"
	ConnectorStatesReady    ConnectorStates = "Ready"
)

func PossibleConnectorStatesValues 

func PossibleConnectorStatesValues() []ConnectorStates

PossibleConnectorStatesValues returns the possible values for the ConnectorStates const type.

type ConnectorTypes 

type ConnectorTypes string

ConnectorTypes - Type of connector. 

const (
	ConnectorTypesAzureBlob      ConnectorTypes = "AzureBlob"
	ConnectorTypesCRM            ConnectorTypes = "CRM"
	ConnectorTypesExchangeOnline ConnectorTypes = "ExchangeOnline"
	ConnectorTypesNone           ConnectorTypes = "None"
	ConnectorTypesOutbound       ConnectorTypes = "Outbound"
	ConnectorTypesSalesforce     ConnectorTypes = "Salesforce"
)

func PossibleConnectorTypesValues 

func PossibleConnectorTypesValues() []ConnectorTypes

PossibleConnectorTypesValues returns the possible values for the ConnectorTypes const type.

type ConnectorsClient 

type ConnectorsClient struct {
	// contains filtered or unexported fields
}

ConnectorsClient contains the methods for the Connectors group. Don't use this type directly, use NewConnectorsClient() instead.

func NewConnectorsClient 

func NewConnectorsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectorsClient, error)

NewConnectorsClient creates a new instance of ConnectorsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConnectorsClient) BeginCreateOrUpdate 

func (client *ConnectorsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, connectorName string, parameters ConnectorResourceFormat, options *ConnectorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConnectorsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a connector or updates an existing connector in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - ConnectorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectorsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewConnectorsClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "testConnector", armcustomerinsights.ConnectorResourceFormat{
		Properties: &armcustomerinsights.Connector{
			Description: to.Ptr("Test connector"),
			ConnectorProperties: map[string]any{
				"connectionKeyVaultUrl": map[string]any{
					"organizationId":  "XXX",
					"organizationUrl": "https://XXX.crmlivetie.com/",
				},
			},
			ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
			DisplayName:   to.Ptr("testConnector"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConnectorResourceFormat = armcustomerinsights.ConnectorResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testConnector"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/connectors"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/connectors/testConnector"),
	// 	Properties: &armcustomerinsights.Connector{
	// 		Description: to.Ptr("Test connector"),
	// 		ConnectorID: to.Ptr[int32](0),
	// 		ConnectorName: to.Ptr("testConnector"),
	// 		ConnectorProperties: map[string]any{
	// 			"connectionKeyVaultUrl": map[string]any{
	// 				"organizationId": "XXX",
	// 				"organizationUrl": "https://XXX.crmlivetie.com/",
	// 			},
	// 		},
	// 		ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
	// 		DisplayName: to.Ptr("testConnector"),
	// 		State: to.Ptr(armcustomerinsights.ConnectorStatesCreating),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*ConnectorsClient) BeginDelete 

func (client *ConnectorsClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, connectorName string, options *ConnectorsClientBeginDeleteOptions) (*runtime.Poller[ConnectorsClientDeleteResponse], error)

BeginDelete - Deletes a connector in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • connectorName - The name of the connector.
  • options - ConnectorsClientBeginDeleteOptions contains the optional parameters for the ConnectorsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewConnectorsClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", "testConnector", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*ConnectorsClient) Get 

func (client *ConnectorsClient) Get(ctx context.Context, resourceGroupName string, hubName string, connectorName string, options *ConnectorsClientGetOptions) (ConnectorsClientGetResponse, error)

Get - Gets a connector in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • connectorName - The name of the connector.
  • options - ConnectorsClientGetOptions contains the optional parameters for the ConnectorsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConnectorsClient().Get(ctx, "TestHubRG", "sdkTestHub", "testConnector", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConnectorResourceFormat = armcustomerinsights.ConnectorResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testConnector"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/connectors"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/connectors/testConnector"),
	// 	Properties: &armcustomerinsights.Connector{
	// 		Description: to.Ptr("Test connector"),
	// 		ConnectorID: to.Ptr[int32](0),
	// 		ConnectorName: to.Ptr("testConnector"),
	// 		ConnectorProperties: map[string]any{
	// 			"connectionKeyVaultUrl": map[string]any{
	// 				"organizationId": "XXX",
	// 				"organizationUrl": "https://XXX.crmlivetie.com/",
	// 			},
	// 		},
	// 		ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
	// 		DisplayName: to.Ptr("testConnector"),
	// 		State: to.Ptr(armcustomerinsights.ConnectorStatesCreating),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*ConnectorsClient) NewListByHubPager 

func (client *ConnectorsClient) NewListByHubPager(resourceGroupName string, hubName string, options *ConnectorsClientListByHubOptions) *runtime.Pager[ConnectorsClientListByHubResponse]

NewListByHubPager - Gets all the connectors in the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - ConnectorsClientListByHubOptions contains the optional parameters for the ConnectorsClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ConnectorsListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewConnectorsClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ConnectorListResult = armcustomerinsights.ConnectorListResult{
		// 	Value: []*armcustomerinsights.ConnectorResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/testConnector"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/connectors"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/connectors/testConnector"),
		// 			Properties: &armcustomerinsights.Connector{
		// 				Description: to.Ptr("Test connector"),
		// 				ConnectorID: to.Ptr[int32](0),
		// 				ConnectorName: to.Ptr("testConnector"),
		// 				ConnectorProperties: map[string]any{
		// 					"connectionKeyVaultUrl": map[string]any{
		// 						"organizationId": "XXX",
		// 						"organizationUrl": "https://XXX.crmlivetie.com/",
		// 					},
		// 				},
		// 				ConnectorType: to.Ptr(armcustomerinsights.ConnectorTypesAzureBlob),
		// 				DisplayName: to.Ptr("testConnector"),
		// 				State: to.Ptr(armcustomerinsights.ConnectorStatesCreating),
		// 				TenantID: to.Ptr("sdktesthub"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type ConnectorsClientBeginCreateOrUpdateOptions 

type ConnectorsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectorsClient.BeginCreateOrUpdate method.

type ConnectorsClientBeginDeleteOptions 

type ConnectorsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectorsClientBeginDeleteOptions contains the optional parameters for the ConnectorsClient.BeginDelete method.

type ConnectorsClientCreateOrUpdateResponse 

type ConnectorsClientCreateOrUpdateResponse struct {
	// The connector resource format.
	ConnectorResourceFormat
}

ConnectorsClientCreateOrUpdateResponse contains the response from method ConnectorsClient.BeginCreateOrUpdate.

type ConnectorsClientDeleteResponse 

type ConnectorsClientDeleteResponse struct {
}

ConnectorsClientDeleteResponse contains the response from method ConnectorsClient.BeginDelete.

type ConnectorsClientGetOptions 

type ConnectorsClientGetOptions struct {
}

ConnectorsClientGetOptions contains the optional parameters for the ConnectorsClient.Get method.

type ConnectorsClientGetResponse 

type ConnectorsClientGetResponse struct {
	// The connector resource format.
	ConnectorResourceFormat
}

ConnectorsClientGetResponse contains the response from method ConnectorsClient.Get.

type ConnectorsClientListByHubOptions 

type ConnectorsClientListByHubOptions struct {
}

ConnectorsClientListByHubOptions contains the optional parameters for the ConnectorsClient.NewListByHubPager method.

type ConnectorsClientListByHubResponse 

type ConnectorsClientListByHubResponse struct {
	// The response of list connector operation.
	ConnectorListResult
}

ConnectorsClientListByHubResponse contains the response from method ConnectorsClient.NewListByHubPager.

type CrmConnectorEntities 

type CrmConnectorEntities struct {
	// REQUIRED; The logical name.
	LogicalName *string

	// The display name.
	DisplayName *string

	// Indicating whether this is profile.
	IsProfile *bool
}

CrmConnectorEntities - The CRM connector entities.

func (CrmConnectorEntities) MarshalJSON added in v1.1.0 

func (c CrmConnectorEntities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrmConnectorEntities.

func (*CrmConnectorEntities) UnmarshalJSON added in v1.1.0 

func (c *CrmConnectorEntities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrmConnectorEntities.

type CrmConnectorProperties 

type CrmConnectorProperties struct {
	// REQUIRED; The entities like account, contact, opportunity.
	Entities []*CrmConnectorEntities

	// REQUIRED; The organization ID.
	OrganizationID *string

	// REQUIRED; The organization URL.
	OrganizationURL *string

	// The access token.
	AccessToken *string

	// The connection string.
	ConnectionString *string
}

CrmConnectorProperties - The CRM connector properties.

func (CrmConnectorProperties) MarshalJSON added in v1.1.0 

func (c CrmConnectorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrmConnectorProperties.

func (*CrmConnectorProperties) UnmarshalJSON added in v1.1.0 

func (c *CrmConnectorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrmConnectorProperties.

type DataSource 

type DataSource struct {
	// READ-ONLY; The data source reference id.
	DataSourceReferenceID *string

	// READ-ONLY; The data source type.
	DataSourceType *DataSourceType

	// READ-ONLY; The data source ID.
	ID *int32

	// READ-ONLY; The data source name
	Name *string

	// READ-ONLY; The data source status.
	Status *Status
}

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.

func (DataSource) MarshalJSON added in v1.1.0 

func (d DataSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataSource.

func (*DataSource) UnmarshalJSON added in v1.1.0 

func (d *DataSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataSource.

type DataSourcePrecedence 

type DataSourcePrecedence struct {
	// 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.
	DataSource *DataSource

	// the precedence value.
	Precedence *int32
}

DataSourcePrecedence - The data source precedence is a way to know the precedence of each data source.

func (DataSourcePrecedence) MarshalJSON added in v1.1.0 

func (d DataSourcePrecedence) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataSourcePrecedence.

func (*DataSourcePrecedence) UnmarshalJSON added in v1.1.0 

func (d *DataSourcePrecedence) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataSourcePrecedence.

type DataSourceType 

type DataSourceType string

DataSourceType - The data source type. 

const (
	DataSourceTypeConnector       DataSourceType = "Connector"
	DataSourceTypeLinkInteraction DataSourceType = "LinkInteraction"
	DataSourceTypeSystemDefault   DataSourceType = "SystemDefault"
)

func PossibleDataSourceTypeValues 

func PossibleDataSourceTypeValues() []DataSourceType

PossibleDataSourceTypeValues returns the possible values for the DataSourceType const type.

type EnrichingKpi 

type EnrichingKpi struct {
	// REQUIRED; The calculation window.
	CalculationWindow *CalculationWindowTypes

	// REQUIRED; The mapping entity type.
	EntityType *EntityTypes

	// REQUIRED; The mapping entity name.
	EntityTypeName *string

	// REQUIRED; The computation expression for the KPI.
	Expression *string

	// REQUIRED; The computation function for the KPI.
	Function *KpiFunctions

	// The aliases.
	Aliases []*KpiAlias

	// Name of calculation window field.
	CalculationWindowFieldName *string

	// Localized description for the KPI.
	Description map[string]*string

	// Localized display name for the KPI.
	DisplayName map[string]*string

	// The KPI extracts.
	Extracts []*KpiExtract

	// The filter expression for the KPI.
	Filter *string

	// the group by properties for the KPI.
	GroupBy []*string

	// The KPI thresholds.
	ThresHolds *KpiThresholds

	// The unit of measurement for the KPI.
	Unit *string

	// READ-ONLY; The KPI GroupByMetadata.
	GroupByMetadata []*KpiGroupByMetadata

	// READ-ONLY; The KPI name.
	KpiName *string

	// READ-ONLY; The participant profiles.
	ParticipantProfilesMetadata []*KpiParticipantProfilesMetadata

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

EnrichingKpi - The enriching KPI definition.

func (EnrichingKpi) MarshalJSON 

func (e EnrichingKpi) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnrichingKpi.

func (*EnrichingKpi) UnmarshalJSON added in v1.1.0 

func (e *EnrichingKpi) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnrichingKpi.

type EntityType 

type EntityType string

EntityType - Type of source entity. 

const (
	EntityTypeInteraction  EntityType = "Interaction"
	EntityTypeNone         EntityType = "None"
	EntityTypeProfile      EntityType = "Profile"
	EntityTypeRelationship EntityType = "Relationship"
)

func PossibleEntityTypeValues 

func PossibleEntityTypeValues() []EntityType

PossibleEntityTypeValues returns the possible values for the EntityType const type.

type EntityTypeDefinition 

type EntityTypeDefinition struct {
	// The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
	APIEntitySetName *string

	// The attributes for the Type.
	Attributes map[string][]*string

	// Localized descriptions for the property.
	Description map[string]*string

	// Localized display names for the property.
	DisplayName map[string]*string

	// Type of entity.
	EntityType *EntityTypes

	// The properties of the Profile.
	Fields []*PropertyDefinition

	// The instance count.
	InstancesCount *int32

	// Large Image associated with the Property or EntityType.
	LargeImage *string

	// Any custom localized attributes for the Type.
	LocalizedAttributes map[string]map[string]*string

	// Medium Image associated with the Property or EntityType.
	MediumImage *string

	// The schema org link. This helps ACI identify and suggest semantic models.
	SchemaItemTypeLink *string

	// Small Image associated with the Property or EntityType.
	SmallImage *string

	// The timestamp property name. Represents the time when the interaction or profile update happened.
	TimestampFieldName *string

	// The name of the entity.
	TypeName *string

	// READ-ONLY; The last changed time for the type definition.
	LastChangedUTC *time.Time

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

EntityTypeDefinition - Describes an entity.

func (EntityTypeDefinition) MarshalJSON 

func (e EntityTypeDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EntityTypeDefinition.

func (*EntityTypeDefinition) UnmarshalJSON 

func (e *EntityTypeDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EntityTypeDefinition.

type EntityTypes 

type EntityTypes string

EntityTypes - Type of entity. 

const (
	EntityTypesInteraction  EntityTypes = "Interaction"
	EntityTypesNone         EntityTypes = "None"
	EntityTypesProfile      EntityTypes = "Profile"
	EntityTypesRelationship EntityTypes = "Relationship"
)

func PossibleEntityTypesValues 

func PossibleEntityTypesValues() []EntityTypes

PossibleEntityTypesValues returns the possible values for the EntityTypes const type.

type ErrorManagementTypes 

type ErrorManagementTypes string

ErrorManagementTypes - The type of error management to use for the mapping. 

const (
	ErrorManagementTypesRejectAndContinue ErrorManagementTypes = "RejectAndContinue"
	ErrorManagementTypesRejectUntilLimit  ErrorManagementTypes = "RejectUntilLimit"
	ErrorManagementTypesStopImport        ErrorManagementTypes = "StopImport"
)

func PossibleErrorManagementTypesValues 

func PossibleErrorManagementTypesValues() []ErrorManagementTypes

PossibleErrorManagementTypesValues returns the possible values for the ErrorManagementTypes const type.

type FrequencyTypes 

type FrequencyTypes string

FrequencyTypes - The frequency to update. 

const (
	FrequencyTypesDay    FrequencyTypes = "Day"
	FrequencyTypesHour   FrequencyTypes = "Hour"
	FrequencyTypesMinute FrequencyTypes = "Minute"
	FrequencyTypesMonth  FrequencyTypes = "Month"
	FrequencyTypesWeek   FrequencyTypes = "Week"
)

func PossibleFrequencyTypesValues 

func PossibleFrequencyTypesValues() []FrequencyTypes

PossibleFrequencyTypesValues returns the possible values for the FrequencyTypes const type.

type GetImageUploadURLInput 

type GetImageUploadURLInput struct {
	// Type of entity. Can be Profile or Interaction.
	EntityType *string

	// Name of the entity type.
	EntityTypeName *string

	// Relative path of the image.
	RelativePath *string
}

GetImageUploadURLInput - Input type for getting image upload url.

func (GetImageUploadURLInput) MarshalJSON added in v1.1.0 

func (g GetImageUploadURLInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GetImageUploadURLInput.

func (*GetImageUploadURLInput) UnmarshalJSON added in v1.1.0 

func (g *GetImageUploadURLInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GetImageUploadURLInput.

type Hub 

type Hub struct {
	// Resource location.
	Location *string

	// Properties of hub.
	Properties *HubPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

Hub resource.

func (Hub) MarshalJSON 

func (h Hub) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Hub.

func (*Hub) UnmarshalJSON added in v1.1.0 

func (h *Hub) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Hub.

type HubBillingInfoFormat 

type HubBillingInfoFormat struct {
	// The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions.
	MaxUnits *int32

	// The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions.
	MinUnits *int32

	// The sku name.
	SKUName *string
}

HubBillingInfoFormat - Hub billing info.

func (HubBillingInfoFormat) MarshalJSON added in v1.1.0 

func (h HubBillingInfoFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubBillingInfoFormat.

func (*HubBillingInfoFormat) UnmarshalJSON added in v1.1.0 

func (h *HubBillingInfoFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubBillingInfoFormat.

type HubListResult 

type HubListResult struct {
	// Link for next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*Hub
}

HubListResult - Response of list hub operation.

func (HubListResult) MarshalJSON added in v1.1.0 

func (h HubListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubListResult.

func (*HubListResult) UnmarshalJSON added in v1.1.0 

func (h *HubListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubListResult.

type HubPropertiesFormat 

type HubPropertiesFormat struct {
	// Billing settings of the hub.
	HubBillingInfo *HubBillingInfoFormat

	// 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

	// READ-ONLY; API endpoint URL of the hub.
	APIEndpoint *string

	// READ-ONLY; Provisioning state of the hub.
	ProvisioningState *string

	// READ-ONLY; Web endpoint URL of the hub.
	WebEndpoint *string
}

HubPropertiesFormat - Properties of hub.

func (HubPropertiesFormat) MarshalJSON added in v1.1.0 

func (h HubPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubPropertiesFormat.

func (*HubPropertiesFormat) UnmarshalJSON added in v1.1.0 

func (h *HubPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubPropertiesFormat.

type HubsClient 

type HubsClient struct {
	// contains filtered or unexported fields
}

HubsClient contains the methods for the Hubs group. Don't use this type directly, use NewHubsClient() instead.

func NewHubsClient 

func NewHubsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*HubsClient, error)

NewHubsClient creates a new instance of HubsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*HubsClient) BeginDelete 

func (client *HubsClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, options *HubsClientBeginDeleteOptions) (*runtime.Poller[HubsClientDeleteResponse], error)

BeginDelete - Deletes the specified hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - HubsClientBeginDeleteOptions contains the optional parameters for the HubsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/HubsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewHubsClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*HubsClient) CreateOrUpdate 

func (client *HubsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, parameters Hub, options *HubsClientCreateOrUpdateOptions) (HubsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a hub, or updates an existing hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the Hub.
  • parameters - Parameters supplied to the CreateOrUpdate Hub operation.
  • options - HubsClientCreateOrUpdateOptions contains the optional parameters for the HubsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/HubsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHubsClient().CreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", armcustomerinsights.Hub{
		Location: to.Ptr("West US"),
		Properties: &armcustomerinsights.HubPropertiesFormat{
			HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
				MaxUnits: to.Ptr[int32](5),
				MinUnits: to.Ptr[int32](1),
				SKUName:  to.Ptr("B0"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Hub = armcustomerinsights.Hub{
	// 	Name: to.Ptr("testHub2839"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/testHub2839"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcustomerinsights.HubPropertiesFormat{
	// 		APIEndpoint: to.Ptr("https://testHub2839.dfd.projectuic-int.net"),
	// 		HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
	// 			MaxUnits: to.Ptr[int32](5),
	// 			MinUnits: to.Ptr[int32](1),
	// 			SKUName: to.Ptr("B0"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		TenantFeatures: to.Ptr[int32](0),
	// 		WebEndpoint: to.Ptr("https://testHub2839.dfdapps.projectuic-int.net"),
	// 	},
	// }
}

Output:

func (*HubsClient) Get 

func (client *HubsClient) Get(ctx context.Context, resourceGroupName string, hubName string, options *HubsClientGetOptions) (HubsClientGetResponse, error)

Get - Gets information about the specified hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - HubsClientGetOptions contains the optional parameters for the HubsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/HubsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHubsClient().Get(ctx, "TestHubRG", "sdkTestHub", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Hub = armcustomerinsights.Hub{
	// 	Name: to.Ptr("testHub2839"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/testHub2839"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcustomerinsights.HubPropertiesFormat{
	// 		APIEndpoint: to.Ptr("https://testHub2839.dfd.projectuic-int.net"),
	// 		HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
	// 			MaxUnits: to.Ptr[int32](5),
	// 			MinUnits: to.Ptr[int32](1),
	// 			SKUName: to.Ptr("B0"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		TenantFeatures: to.Ptr[int32](0),
	// 		WebEndpoint: to.Ptr("https://testHub2839.dfdapps.projectuic-int.net"),
	// 	},
	// }
}

Output:

func (*HubsClient) NewListByResourceGroupPager 

func (client *HubsClient) NewListByResourceGroupPager(resourceGroupName string, options *HubsClientListByResourceGroupOptions) *runtime.Pager[HubsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all the hubs in a resource group.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • options - HubsClientListByResourceGroupOptions contains the optional parameters for the HubsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/HubsListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewHubsClient().NewListByResourceGroupPager("TestHubRG", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.HubListResult = armcustomerinsights.HubListResult{
		// 	Value: []*armcustomerinsights.Hub{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcustomerinsights.HubPropertiesFormat{
		// 				APIEndpoint: to.Ptr("https://azSdkTestHub.dfd.projectuic-int.net"),
		// 				HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
		// 					MaxUnits: to.Ptr[int32](1),
		// 					MinUnits: to.Ptr[int32](1),
		// 					SKUName: to.Ptr("B0"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				TenantFeatures: to.Ptr[int32](0),
		// 				WebEndpoint: to.Ptr("https://azSdkTestHub.dfdapps.projectuic-int.net"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testHub1058"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/testHub1058"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcustomerinsights.HubPropertiesFormat{
		// 				APIEndpoint: to.Ptr("https://testHub1058.dfd.projectuic-int.net"),
		// 				HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
		// 					MaxUnits: to.Ptr[int32](5),
		// 					MinUnits: to.Ptr[int32](1),
		// 					SKUName: to.Ptr("B0"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				TenantFeatures: to.Ptr[int32](0),
		// 				WebEndpoint: to.Ptr("https://testHub1058.dfdapps.projectuic-int.net"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*HubsClient) NewListPager 

func (client *HubsClient) NewListPager(options *HubsClientListOptions) *runtime.Pager[HubsClientListResponse]

NewListPager - Gets all hubs in the specified subscription.

Generated from API version 2017-04-26

  • options - HubsClientListOptions contains the optional parameters for the HubsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/HubsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewHubsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.HubListResult = armcustomerinsights.HubListResult{
		// 	Value: []*armcustomerinsights.Hub{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcustomerinsights.HubPropertiesFormat{
		// 				APIEndpoint: to.Ptr("https://azSdkTestHub.dfd.projectuic-int.net"),
		// 				HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
		// 					MaxUnits: to.Ptr[int32](1),
		// 					MinUnits: to.Ptr[int32](1),
		// 					SKUName: to.Ptr("B0"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				TenantFeatures: to.Ptr[int32](0),
		// 				WebEndpoint: to.Ptr("https://azSdkTestHub.dfdapps.projectuic-int.net"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testHub1058"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/testHub1058"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcustomerinsights.HubPropertiesFormat{
		// 				APIEndpoint: to.Ptr("https://testHub1058.dfd.projectuic-int.net"),
		// 				HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
		// 					MaxUnits: to.Ptr[int32](5),
		// 					MinUnits: to.Ptr[int32](1),
		// 					SKUName: to.Ptr("B0"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				TenantFeatures: to.Ptr[int32](0),
		// 				WebEndpoint: to.Ptr("https://testHub1058.dfdapps.projectuic-int.net"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*HubsClient) Update 

func (client *HubsClient) Update(ctx context.Context, resourceGroupName string, hubName string, parameters Hub, options *HubsClientUpdateOptions) (HubsClientUpdateResponse, error)

Update - Updates a Hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the Hub.
  • parameters - Parameters supplied to the Update Hub operation.
  • options - HubsClientUpdateOptions contains the optional parameters for the HubsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/HubsUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHubsClient().Update(ctx, "TestHubRG", "sdkTestHub", armcustomerinsights.Hub{
		Location: to.Ptr("West US"),
		Properties: &armcustomerinsights.HubPropertiesFormat{
			HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
				MaxUnits: to.Ptr[int32](5),
				MinUnits: to.Ptr[int32](1),
				SKUName:  to.Ptr("B0"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Hub = armcustomerinsights.Hub{
	// 	Name: to.Ptr("testHub2839"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/testHub2839"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcustomerinsights.HubPropertiesFormat{
	// 		APIEndpoint: to.Ptr("https://testHub2839.dfd.projectuic-int.net"),
	// 		HubBillingInfo: &armcustomerinsights.HubBillingInfoFormat{
	// 			MaxUnits: to.Ptr[int32](5),
	// 			MinUnits: to.Ptr[int32](1),
	// 			SKUName: to.Ptr("B0"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		TenantFeatures: to.Ptr[int32](0),
	// 		WebEndpoint: to.Ptr("https://testHub2839.dfdapps.projectuic-int.net"),
	// 	},
	// }
}

Output:

type HubsClientBeginDeleteOptions 

type HubsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

HubsClientBeginDeleteOptions contains the optional parameters for the HubsClient.BeginDelete method.

type HubsClientCreateOrUpdateOptions 

type HubsClientCreateOrUpdateOptions struct {
}

HubsClientCreateOrUpdateOptions contains the optional parameters for the HubsClient.CreateOrUpdate method.

type HubsClientCreateOrUpdateResponse 

type HubsClientCreateOrUpdateResponse struct {
	// Hub resource.
	Hub
}

HubsClientCreateOrUpdateResponse contains the response from method HubsClient.CreateOrUpdate.

type HubsClientDeleteResponse 

type HubsClientDeleteResponse struct {
}

HubsClientDeleteResponse contains the response from method HubsClient.BeginDelete.

type HubsClientGetOptions 

type HubsClientGetOptions struct {
}

HubsClientGetOptions contains the optional parameters for the HubsClient.Get method.

type HubsClientGetResponse 

type HubsClientGetResponse struct {
	// Hub resource.
	Hub
}

HubsClientGetResponse contains the response from method HubsClient.Get.

type HubsClientListByResourceGroupOptions 

type HubsClientListByResourceGroupOptions struct {
}

HubsClientListByResourceGroupOptions contains the optional parameters for the HubsClient.NewListByResourceGroupPager method.

type HubsClientListByResourceGroupResponse 

type HubsClientListByResourceGroupResponse struct {
	// Response of list hub operation.
	HubListResult
}

HubsClientListByResourceGroupResponse contains the response from method HubsClient.NewListByResourceGroupPager.

type HubsClientListOptions 

type HubsClientListOptions struct {
}

HubsClientListOptions contains the optional parameters for the HubsClient.NewListPager method.

type HubsClientListResponse 

type HubsClientListResponse struct {
	// Response of list hub operation.
	HubListResult
}

HubsClientListResponse contains the response from method HubsClient.NewListPager.

type HubsClientUpdateOptions 

type HubsClientUpdateOptions struct {
}

HubsClientUpdateOptions contains the optional parameters for the HubsClient.Update method.

type HubsClientUpdateResponse 

type HubsClientUpdateResponse struct {
	// Hub resource.
	Hub
}

HubsClientUpdateResponse contains the response from method HubsClient.Update.

type ImageDefinition 

type ImageDefinition struct {
	// Content URL for the image blob.
	ContentURL *string

	// Whether image exists already.
	ImageExists *bool

	// Relative path of the image.
	RelativePath *string
}

ImageDefinition - The image definition.

func (ImageDefinition) MarshalJSON added in v1.1.0 

func (i ImageDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageDefinition.

func (*ImageDefinition) UnmarshalJSON added in v1.1.0 

func (i *ImageDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageDefinition.

type ImagesClient 

type ImagesClient struct {
	// contains filtered or unexported fields
}

ImagesClient contains the methods for the Images group. Don't use this type directly, use NewImagesClient() instead.

func NewImagesClient 

func NewImagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ImagesClient, error)

NewImagesClient creates a new instance of ImagesClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ImagesClient) GetUploadURLForData 

func (client *ImagesClient) GetUploadURLForData(ctx context.Context, resourceGroupName string, hubName string, parameters GetImageUploadURLInput, options *ImagesClientGetUploadURLForDataOptions) (ImagesClientGetUploadURLForDataResponse, error)

GetUploadURLForData - Gets data image upload URL. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • parameters - Parameters supplied to the GetUploadUrlForData operation.
  • options - ImagesClientGetUploadURLForDataOptions contains the optional parameters for the ImagesClient.GetUploadURLForData method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ImagesGetUploadUrlForData.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewImagesClient().GetUploadURLForData(ctx, "TestHubRG", "sdkTestHub", armcustomerinsights.GetImageUploadURLInput{
		EntityType:     to.Ptr("Profile"),
		EntityTypeName: to.Ptr("Contact"),
		RelativePath:   to.Ptr("images/profile1.png"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ImageDefinition = armcustomerinsights.ImageDefinition{
	// 	ContentURL: to.Ptr("https://ucidfdbl2001img.blob.core.windows.net/images/3ac3a97a5e3246ffb41812f60fd9f83c/EntityTypeImage/Profile/Contact/images/profile1.png?sv=2015-04-05&sr=b&sig=yIt7DGVRTyNl15%2BPc0kO%2FDITJ2cExnBPVvvh6p86qdc%3D&se=2017-01-06T01%3A56%3A43Z&sp=cw"),
	// 	ImageExists: to.Ptr(false),
	// 	RelativePath: to.Ptr("images/profile1.png"),
	// }
}

Output:

func (*ImagesClient) GetUploadURLForEntityType 

func (client *ImagesClient) GetUploadURLForEntityType(ctx context.Context, resourceGroupName string, hubName string, parameters GetImageUploadURLInput, options *ImagesClientGetUploadURLForEntityTypeOptions) (ImagesClientGetUploadURLForEntityTypeResponse, error)

GetUploadURLForEntityType - Gets entity type (profile or interaction) image upload URL. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • parameters - Parameters supplied to the GetUploadUrlForEntityType operation.
  • options - ImagesClientGetUploadURLForEntityTypeOptions contains the optional parameters for the ImagesClient.GetUploadURLForEntityType method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ImagesGetUploadUrlForEntityType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewImagesClient().GetUploadURLForEntityType(ctx, "TestHubRG", "sdkTestHub", armcustomerinsights.GetImageUploadURLInput{
		EntityType:     to.Ptr("Profile"),
		EntityTypeName: to.Ptr("Contact"),
		RelativePath:   to.Ptr("images/profile1.png"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ImageDefinition = armcustomerinsights.ImageDefinition{
	// 	ContentURL: to.Ptr("https://ucidfdbl2001img.blob.core.windows.net/images/3ac3a97a5e3246ffb41812f60fd9f83c/EntityTypeImage/Profile/Contact/images/profile1.png?sv=2015-04-05&sr=b&sig=yIt7DGVRTyNl15%2BPc0kO%2FDITJ2cExnBPVvvh6p86qdc%3D&se=2017-01-06T01%3A56%3A43Z&sp=cw"),
	// 	ImageExists: to.Ptr(false),
	// 	RelativePath: to.Ptr("images/profile1.png"),
	// }
}

Output:

type ImagesClientGetUploadURLForDataOptions 

type ImagesClientGetUploadURLForDataOptions struct {
}

ImagesClientGetUploadURLForDataOptions contains the optional parameters for the ImagesClient.GetUploadURLForData method.

type ImagesClientGetUploadURLForDataResponse 

type ImagesClientGetUploadURLForDataResponse struct {
	// The image definition.
	ImageDefinition
}

ImagesClientGetUploadURLForDataResponse contains the response from method ImagesClient.GetUploadURLForData.

type ImagesClientGetUploadURLForEntityTypeOptions 

type ImagesClientGetUploadURLForEntityTypeOptions struct {
}

ImagesClientGetUploadURLForEntityTypeOptions contains the optional parameters for the ImagesClient.GetUploadURLForEntityType method.

type ImagesClientGetUploadURLForEntityTypeResponse 

type ImagesClientGetUploadURLForEntityTypeResponse struct {
	// The image definition.
	ImageDefinition
}

ImagesClientGetUploadURLForEntityTypeResponse contains the response from method ImagesClient.GetUploadURLForEntityType.

type InstanceOperationType 

type InstanceOperationType string

InstanceOperationType - Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only. 

const (
	InstanceOperationTypeDelete InstanceOperationType = "Delete"
	InstanceOperationTypeUpsert InstanceOperationType = "Upsert"
)

func PossibleInstanceOperationTypeValues 

func PossibleInstanceOperationTypeValues() []InstanceOperationType

PossibleInstanceOperationTypeValues returns the possible values for the InstanceOperationType const type.

type InteractionListResult 

type InteractionListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*InteractionResourceFormat
}

InteractionListResult - The response of list interaction operation.

func (InteractionListResult) MarshalJSON added in v1.1.0 

func (i InteractionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InteractionListResult.

func (*InteractionListResult) UnmarshalJSON added in v1.1.0 

func (i *InteractionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InteractionListResult.

type InteractionResourceFormat 

type InteractionResourceFormat struct {
	// The Interaction Type Definition
	Properties *InteractionTypeDefinition

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

InteractionResourceFormat - The interaction resource format.

func (InteractionResourceFormat) MarshalJSON added in v1.1.0 

func (i InteractionResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InteractionResourceFormat.

func (*InteractionResourceFormat) UnmarshalJSON added in v1.1.0 

func (i *InteractionResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InteractionResourceFormat.

type InteractionTypeDefinition 

type InteractionTypeDefinition struct {
	// The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
	APIEntitySetName *string

	// The attributes for the Type.
	Attributes map[string][]*string

	// Default data source is specifically used in cases where data source is not specified in an instance.
	DefaultDataSource *DataSource

	// Localized descriptions for the property.
	Description map[string]*string

	// Localized display names for the property.
	DisplayName map[string]*string

	// Type of entity.
	EntityType *EntityTypes

	// The properties of the Profile.
	Fields []*PropertyDefinition

	// The id property names. Properties which uniquely identify an interaction instance.
	IDPropertyNames []*string

	// The instance count.
	InstancesCount *int32

	// 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

	// Large Image associated with the Property or EntityType.
	LargeImage *string

	// Any custom localized attributes for the Type.
	LocalizedAttributes map[string]map[string]*string

	// Medium Image associated with the Property or EntityType.
	MediumImage *string

	// Profiles that participated in the interaction.
	ParticipantProfiles []*Participant

	// 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

	// The schema org link. This helps ACI identify and suggest semantic models.
	SchemaItemTypeLink *string

	// Small Image associated with the Property or EntityType.
	SmallImage *string

	// The timestamp property name. Represents the time when the interaction or profile update happened.
	TimestampFieldName *string

	// The name of the entity.
	TypeName *string

	// 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

	// READ-ONLY; The last changed time for the type definition.
	LastChangedUTC *time.Time

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

InteractionTypeDefinition - The Interaction Type Definition

func (InteractionTypeDefinition) MarshalJSON 

func (i InteractionTypeDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InteractionTypeDefinition.

func (*InteractionTypeDefinition) UnmarshalJSON 

func (i *InteractionTypeDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InteractionTypeDefinition.

type InteractionsClient 

type InteractionsClient struct {
	// contains filtered or unexported fields
}

InteractionsClient contains the methods for the Interactions group. Don't use this type directly, use NewInteractionsClient() instead.

func NewInteractionsClient 

func NewInteractionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*InteractionsClient, error)

NewInteractionsClient creates a new instance of InteractionsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*InteractionsClient) BeginCreateOrUpdate 

func (client *InteractionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, interactionName string, parameters InteractionResourceFormat, options *InteractionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[InteractionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates an interaction or updates an existing interaction within a hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - InteractionsClientBeginCreateOrUpdateOptions contains the optional parameters for the InteractionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/InteractionsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewInteractionsClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "TestProfileType396", armcustomerinsights.InteractionResourceFormat{
		Properties: &armcustomerinsights.InteractionTypeDefinition{
			LargeImage:       to.Ptr("\\\\Images\\\\LargeImage"),
			MediumImage:      to.Ptr("\\\\Images\\\\MediumImage"),
			SmallImage:       to.Ptr("\\\\Images\\\\smallImage"),
			APIEntitySetName: to.Ptr("TestInteractionType6358"),
			Fields: []*armcustomerinsights.PropertyDefinition{
				{
					FieldName:  to.Ptr("TestInteractionType6358"),
					FieldType:  to.Ptr("Edm.String"),
					IsArray:    to.Ptr(false),
					IsRequired: to.Ptr(true),
				},
				{
					FieldName: to.Ptr("profile1"),
					FieldType: to.Ptr("Edm.String"),
				}},
			IDPropertyNames: []*string{
				to.Ptr("TestInteractionType6358")},
			PrimaryParticipantProfilePropertyName: to.Ptr("profile1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.InteractionResourceFormat = armcustomerinsights.InteractionResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/TestInteractionType6358"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/interactions"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/interactions/TestInteractionType6358"),
	// 	Properties: &armcustomerinsights.InteractionTypeDefinition{
	// 		LargeImage: to.Ptr("\\\\Images\\\\LargeImage"),
	// 		MediumImage: to.Ptr("\\\\Images\\\\MediumImage"),
	// 		SmallImage: to.Ptr("\\\\Images\\\\smallImage"),
	// 		APIEntitySetName: to.Ptr("TestInteractionType6358"),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
	// 		Fields: []*armcustomerinsights.PropertyDefinition{
	// 			{
	// 				FieldName: to.Ptr("TestInteractionType6358"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("profile1"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 		}},
	// 		InstancesCount: to.Ptr[int32](0),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 		TypeName: to.Ptr("TestInteractionType6358"),
	// 		IDPropertyNames: []*string{
	// 			to.Ptr("TestInteractionType6358")},
	// 			PrimaryParticipantProfilePropertyName: to.Ptr("profile1"),
	// 		},
	// 	}
}

Output:

func (*InteractionsClient) Get 

func (client *InteractionsClient) Get(ctx context.Context, resourceGroupName string, hubName string, interactionName string, options *InteractionsClientGetOptions) (InteractionsClientGetResponse, error)

Get - Gets information about the specified interaction. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • interactionName - The name of the interaction.
  • options - InteractionsClientGetOptions contains the optional parameters for the InteractionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/InteractionsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInteractionsClient().Get(ctx, "TestHubRG", "sdkTestHub", "TestInteractionType6358", &armcustomerinsights.InteractionsClientGetOptions{LocaleCode: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.InteractionResourceFormat = armcustomerinsights.InteractionResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/TestInteractionType6358"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/interactions"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/interactions/TestInteractionType6358"),
	// 	Properties: &armcustomerinsights.InteractionTypeDefinition{
	// 		LargeImage: to.Ptr("\\\\Images\\\\LargeImage"),
	// 		MediumImage: to.Ptr("\\\\Images\\\\MediumImage"),
	// 		SmallImage: to.Ptr("\\\\Images\\\\smallImage"),
	// 		APIEntitySetName: to.Ptr("TestInteractionType6358"),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
	// 		Fields: []*armcustomerinsights.PropertyDefinition{
	// 			{
	// 				DataSourcePrecedenceRules: []*armcustomerinsights.DataSourcePrecedence{
	// 				},
	// 				FieldName: to.Ptr("TestInteractionType6358"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				DataSourcePrecedenceRules: []*armcustomerinsights.DataSourcePrecedence{
	// 					{
	// 						DataSource: &armcustomerinsights.DataSource{
	// 							Name: to.Ptr("crm2"),
	// 							DataSourceReferenceID: to.Ptr("70"),
	// 							DataSourceType: to.Ptr(armcustomerinsights.DataSourceTypeConnector),
	// 							ID: to.Ptr[int32](1),
	// 							Status: to.Ptr(armcustomerinsights.StatusActive),
	// 						},
	// 						Precedence: to.Ptr[int32](50),
	// 				}},
	// 				FieldName: to.Ptr("profile1"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 		}},
	// 		InstancesCount: to.Ptr[int32](0),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 		TypeName: to.Ptr("TestInteractionType6358"),
	// 		DataSourcePrecedenceRules: []*armcustomerinsights.DataSourcePrecedence{
	// 			{
	// 				DataSource: &armcustomerinsights.DataSource{
	// 					Name: to.Ptr("crm2"),
	// 					DataSourceReferenceID: to.Ptr("70"),
	// 					DataSourceType: to.Ptr(armcustomerinsights.DataSourceTypeConnector),
	// 					ID: to.Ptr[int32](1),
	// 					Status: to.Ptr(armcustomerinsights.StatusActive),
	// 				},
	// 				Precedence: to.Ptr[int32](50),
	// 		}},
	// 		DefaultDataSource: &armcustomerinsights.DataSource{
	// 			Name: to.Ptr("crm2"),
	// 			DataSourceReferenceID: to.Ptr("70"),
	// 			DataSourceType: to.Ptr(armcustomerinsights.DataSourceTypeConnector),
	// 			ID: to.Ptr[int32](1),
	// 			Status: to.Ptr(armcustomerinsights.StatusActive),
	// 		},
	// 		IDPropertyNames: []*string{
	// 			to.Ptr("TestInteractionType6358")},
	// 			IsActivity: to.Ptr(true),
	// 			PrimaryParticipantProfilePropertyName: to.Ptr("profile1"),
	// 		},
	// 	}
}

Output:

func (*InteractionsClient) NewListByHubPager 

func (client *InteractionsClient) NewListByHubPager(resourceGroupName string, hubName string, options *InteractionsClientListByHubOptions) *runtime.Pager[InteractionsClientListByHubResponse]

NewListByHubPager - Gets all interactions in the hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - InteractionsClientListByHubOptions contains the optional parameters for the InteractionsClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/InteractionsListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewInteractionsClient().NewListByHubPager("TestHubRG", "sdkTestHub", &armcustomerinsights.InteractionsClientListByHubOptions{LocaleCode: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.InteractionListResult = armcustomerinsights.InteractionListResult{
		// 	Value: []*armcustomerinsights.InteractionResourceFormat{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub/TestInteractionType6358"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/interactions"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/interactions/TestInteractionType6358"),
		// 			Properties: &armcustomerinsights.InteractionTypeDefinition{
		// 				LargeImage: to.Ptr("\\\\Images\\\\LargeImage"),
		// 				MediumImage: to.Ptr("\\\\Images\\\\MediumImage"),
		// 				SmallImage: to.Ptr("\\\\Images\\\\smallImage"),
		// 				APIEntitySetName: to.Ptr("TestInteractionType6358"),
		// 				EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
		// 				Fields: []*armcustomerinsights.PropertyDefinition{
		// 					{
		// 						DataSourcePrecedenceRules: []*armcustomerinsights.DataSourcePrecedence{
		// 						},
		// 						FieldName: to.Ptr("TestInteractionType6358"),
		// 						FieldType: to.Ptr("Edm.String"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 					},
		// 					{
		// 						DataSourcePrecedenceRules: []*armcustomerinsights.DataSourcePrecedence{
		// 							{
		// 								DataSource: &armcustomerinsights.DataSource{
		// 									Name: to.Ptr("crm2"),
		// 									DataSourceReferenceID: to.Ptr("70"),
		// 									DataSourceType: to.Ptr(armcustomerinsights.DataSourceTypeConnector),
		// 									ID: to.Ptr[int32](1),
		// 									Status: to.Ptr(armcustomerinsights.StatusActive),
		// 								},
		// 								Precedence: to.Ptr[int32](50),
		// 						}},
		// 						FieldName: to.Ptr("profile1"),
		// 						FieldType: to.Ptr("Edm.String"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 				}},
		// 				InstancesCount: to.Ptr[int32](0),
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				TenantID: to.Ptr("azsdktesthub"),
		// 				TypeName: to.Ptr("TestInteractionType6358"),
		// 				DataSourcePrecedenceRules: []*armcustomerinsights.DataSourcePrecedence{
		// 					{
		// 						DataSource: &armcustomerinsights.DataSource{
		// 							Name: to.Ptr("crm2"),
		// 							DataSourceReferenceID: to.Ptr("70"),
		// 							DataSourceType: to.Ptr(armcustomerinsights.DataSourceTypeConnector),
		// 							ID: to.Ptr[int32](1),
		// 							Status: to.Ptr(armcustomerinsights.StatusActive),
		// 						},
		// 						Precedence: to.Ptr[int32](50),
		// 				}},
		// 				DefaultDataSource: &armcustomerinsights.DataSource{
		// 					Name: to.Ptr("crm2"),
		// 					DataSourceReferenceID: to.Ptr("70"),
		// 					DataSourceType: to.Ptr(armcustomerinsights.DataSourceTypeConnector),
		// 					ID: to.Ptr[int32](1),
		// 					Status: to.Ptr(armcustomerinsights.StatusActive),
		// 				},
		// 				IDPropertyNames: []*string{
		// 					to.Ptr("TestInteractionType6358")},
		// 					IsActivity: to.Ptr(true),
		// 					PrimaryParticipantProfilePropertyName: to.Ptr("profile1"),
		// 				},
		// 		}},
		// 	}
	}
}

Output:


func (client *InteractionsClient) SuggestRelationshipLinks(ctx context.Context, resourceGroupName string, hubName string, interactionName string, options *InteractionsClientSuggestRelationshipLinksOptions) (InteractionsClientSuggestRelationshipLinksResponse, error)

SuggestRelationshipLinks - Suggests relationships to create relationship links. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • interactionName - The name of the interaction.
  • options - InteractionsClientSuggestRelationshipLinksOptions contains the optional parameters for the InteractionsClient.SuggestRelationshipLinks method.

type InteractionsClientBeginCreateOrUpdateOptions 

type InteractionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InteractionsClientBeginCreateOrUpdateOptions contains the optional parameters for the InteractionsClient.BeginCreateOrUpdate method.

type InteractionsClientCreateOrUpdateResponse 

type InteractionsClientCreateOrUpdateResponse struct {
	// The interaction resource format.
	InteractionResourceFormat
}

InteractionsClientCreateOrUpdateResponse contains the response from method InteractionsClient.BeginCreateOrUpdate.

type InteractionsClientGetOptions 

type InteractionsClientGetOptions struct {
	// Locale of interaction to retrieve, default is en-us.
	LocaleCode *string
}

InteractionsClientGetOptions contains the optional parameters for the InteractionsClient.Get method.

type InteractionsClientGetResponse 

type InteractionsClientGetResponse struct {
	// The interaction resource format.
	InteractionResourceFormat
}

InteractionsClientGetResponse contains the response from method InteractionsClient.Get.

type InteractionsClientListByHubOptions 

type InteractionsClientListByHubOptions struct {
	// Locale of interaction to retrieve, default is en-us.
	LocaleCode *string
}

InteractionsClientListByHubOptions contains the optional parameters for the InteractionsClient.NewListByHubPager method.

type InteractionsClientListByHubResponse 

type InteractionsClientListByHubResponse struct {
	// The response of list interaction operation.
	InteractionListResult
}

InteractionsClientListByHubResponse contains the response from method InteractionsClient.NewListByHubPager.

type InteractionsClientSuggestRelationshipLinksOptions 

type InteractionsClientSuggestRelationshipLinksOptions struct {
}

InteractionsClientSuggestRelationshipLinksOptions contains the optional parameters for the InteractionsClient.SuggestRelationshipLinks method.

type InteractionsClientSuggestRelationshipLinksResponse 

type InteractionsClientSuggestRelationshipLinksResponse struct {
	// The response of suggest relationship links operation.
	SuggestRelationshipLinksResponse
}

InteractionsClientSuggestRelationshipLinksResponse contains the response from method InteractionsClient.SuggestRelationshipLinks.

type KpiAlias 

type KpiAlias struct {
	// REQUIRED; KPI alias name.
	AliasName *string

	// REQUIRED; The expression.
	Expression *string
}

KpiAlias - The KPI alias.

func (KpiAlias) MarshalJSON added in v1.1.0 

func (k KpiAlias) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiAlias.

func (*KpiAlias) UnmarshalJSON added in v1.1.0 

func (k *KpiAlias) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiAlias.

type KpiClient 

type KpiClient struct {
	// contains filtered or unexported fields
}

KpiClient contains the methods for the Kpi group. Don't use this type directly, use NewKpiClient() instead.

func NewKpiClient 

func NewKpiClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KpiClient, error)

NewKpiClient creates a new instance of KpiClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KpiClient) BeginCreateOrUpdate 

func (client *KpiClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, kpiName string, parameters KpiResourceFormat, options *KpiClientBeginCreateOrUpdateOptions) (*runtime.Poller[KpiClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a KPI or updates an existing KPI in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - KpiClientBeginCreateOrUpdateOptions contains the optional parameters for the KpiClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/KpiCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKpiClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "kpiTest45453647", armcustomerinsights.KpiResourceFormat{
		Properties: &armcustomerinsights.KpiDefinition{
			Description: map[string]*string{
				"en-us": to.Ptr("Kpi Description"),
			},
			Aliases: []*armcustomerinsights.KpiAlias{
				{
					AliasName:  to.Ptr("alias"),
					Expression: to.Ptr("Id+4"),
				}},
			CalculationWindow: to.Ptr(armcustomerinsights.CalculationWindowTypesDay),
			DisplayName: map[string]*string{
				"en-us": to.Ptr("Kpi DisplayName"),
			},
			EntityType:     to.Ptr(armcustomerinsights.EntityTypesProfile),
			EntityTypeName: to.Ptr("testProfile2327128"),
			Expression:     to.Ptr("SavingAccountBalance"),
			Function:       to.Ptr(armcustomerinsights.KpiFunctionsSum),
			GroupBy: []*string{
				to.Ptr("SavingAccountBalance")},
			ThresHolds: &armcustomerinsights.KpiThresholds{
				IncreasingKpi: to.Ptr(true),
				LowerLimit:    to.Ptr[float64](5),
				UpperLimit:    to.Ptr[float64](50),
			},
			Unit: to.Ptr("unit"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KpiResourceFormat = armcustomerinsights.KpiResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/kpiTest45453647"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/kpi"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/kpi/kpiTest45453647"),
	// 	Properties: &armcustomerinsights.KpiDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Kpi Description"),
	// 		},
	// 		Aliases: []*armcustomerinsights.KpiAlias{
	// 			{
	// 				AliasName: to.Ptr("alias"),
	// 				Expression: to.Ptr("Id+4"),
	// 		}},
	// 		CalculationWindow: to.Ptr(armcustomerinsights.CalculationWindowTypesDay),
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Kpi DisplayName"),
	// 		},
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesProfile),
	// 		EntityTypeName: to.Ptr("testProfile2327128"),
	// 		Expression: to.Ptr("SavingAccountBalance"),
	// 		Function: to.Ptr(armcustomerinsights.KpiFunctionsSum),
	// 		GroupBy: []*string{
	// 			to.Ptr("SavingAccountBalance")},
	// 			KpiName: to.Ptr("kpiTest45453647"),
	// 			ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 			TenantID: to.Ptr("sdktesthub"),
	// 			ThresHolds: &armcustomerinsights.KpiThresholds{
	// 				IncreasingKpi: to.Ptr(true),
	// 				LowerLimit: to.Ptr[float64](5),
	// 				UpperLimit: to.Ptr[float64](50),
	// 			},
	// 			Unit: to.Ptr("unit"),
	// 		},
	// 	}
}

Output:

func (*KpiClient) BeginDelete 

func (client *KpiClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, kpiName string, options *KpiClientBeginDeleteOptions) (*runtime.Poller[KpiClientDeleteResponse], error)

BeginDelete - Deletes a KPI in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • kpiName - The name of the KPI.
  • options - KpiClientBeginDeleteOptions contains the optional parameters for the KpiClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/KpiDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKpiClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", "kpiTest45453647", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KpiClient) Get 

func (client *KpiClient) Get(ctx context.Context, resourceGroupName string, hubName string, kpiName string, options *KpiClientGetOptions) (KpiClientGetResponse, error)

Get - Gets a KPI in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • kpiName - The name of the KPI.
  • options - KpiClientGetOptions contains the optional parameters for the KpiClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/KpiGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKpiClient().Get(ctx, "TestHubRG", "sdkTestHub", "kpiTest45453647", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KpiResourceFormat = armcustomerinsights.KpiResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/kpiTest45453647"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/kpi"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/kpi/kpiTest45453647"),
	// 	Properties: &armcustomerinsights.KpiDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Kpi Description"),
	// 		},
	// 		Aliases: []*armcustomerinsights.KpiAlias{
	// 			{
	// 				AliasName: to.Ptr("alias"),
	// 				Expression: to.Ptr("Id+4"),
	// 		}},
	// 		CalculationWindow: to.Ptr(armcustomerinsights.CalculationWindowTypesDay),
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Kpi DisplayName"),
	// 		},
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesProfile),
	// 		EntityTypeName: to.Ptr("testProfile2327128"),
	// 		Expression: to.Ptr("SavingAccountBalance"),
	// 		Function: to.Ptr(armcustomerinsights.KpiFunctionsSum),
	// 		GroupBy: []*string{
	// 			to.Ptr("SavingAccountBalance")},
	// 			KpiName: to.Ptr("kpiTest45453647"),
	// 			ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 			TenantID: to.Ptr("sdktesthub"),
	// 			ThresHolds: &armcustomerinsights.KpiThresholds{
	// 				IncreasingKpi: to.Ptr(true),
	// 				LowerLimit: to.Ptr[float64](5),
	// 				UpperLimit: to.Ptr[float64](50),
	// 			},
	// 			Unit: to.Ptr("unit"),
	// 		},
	// 	}
}

Output:

func (*KpiClient) NewListByHubPager 

func (client *KpiClient) NewListByHubPager(resourceGroupName string, hubName string, options *KpiClientListByHubOptions) *runtime.Pager[KpiClientListByHubResponse]

NewListByHubPager - Gets all the KPIs in the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - KpiClientListByHubOptions contains the optional parameters for the KpiClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/KpiListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKpiClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.KpiListResult = armcustomerinsights.KpiListResult{
		// 	Value: []*armcustomerinsights.KpiResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/kpiTest45453647"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/kpi"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/kpi/kpiTest45453647"),
		// 			Properties: &armcustomerinsights.KpiDefinition{
		// 				Description: map[string]*string{
		// 					"en-us": to.Ptr("Kpi Description"),
		// 				},
		// 				Aliases: []*armcustomerinsights.KpiAlias{
		// 					{
		// 						AliasName: to.Ptr("alias"),
		// 						Expression: to.Ptr("Id+4"),
		// 				}},
		// 				CalculationWindow: to.Ptr(armcustomerinsights.CalculationWindowTypesDay),
		// 				DisplayName: map[string]*string{
		// 					"en-us": to.Ptr("Kpi DisplayName"),
		// 				},
		// 				EntityType: to.Ptr(armcustomerinsights.EntityTypesProfile),
		// 				EntityTypeName: to.Ptr("testProfile2327128"),
		// 				Expression: to.Ptr("SavingAccountBalance"),
		// 				Function: to.Ptr(armcustomerinsights.KpiFunctionsSum),
		// 				GroupBy: []*string{
		// 					to.Ptr("SavingAccountBalance")},
		// 					KpiName: to.Ptr("kpiTest45453647"),
		// 					ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 					TenantID: to.Ptr("sdktesthub"),
		// 					ThresHolds: &armcustomerinsights.KpiThresholds{
		// 						IncreasingKpi: to.Ptr(true),
		// 						LowerLimit: to.Ptr[float64](5),
		// 						UpperLimit: to.Ptr[float64](50),
		// 					},
		// 					Unit: to.Ptr("unit"),
		// 				},
		// 		}},
		// 	}
	}
}

Output:

func (*KpiClient) Reprocess 

func (client *KpiClient) Reprocess(ctx context.Context, resourceGroupName string, hubName string, kpiName string, options *KpiClientReprocessOptions) (KpiClientReprocessResponse, error)

Reprocess - Reprocesses the Kpi values of the specified KPI. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • kpiName - The name of the KPI.
  • options - KpiClientReprocessOptions contains the optional parameters for the KpiClient.Reprocess method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/KpiReprocess.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewKpiClient().Reprocess(ctx, "TestHubRG", "sdkTestHub", "kpiTest45453647", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type KpiClientBeginCreateOrUpdateOptions 

type KpiClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KpiClientBeginCreateOrUpdateOptions contains the optional parameters for the KpiClient.BeginCreateOrUpdate method.

type KpiClientBeginDeleteOptions 

type KpiClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KpiClientBeginDeleteOptions contains the optional parameters for the KpiClient.BeginDelete method.

type KpiClientCreateOrUpdateResponse 

type KpiClientCreateOrUpdateResponse struct {
	// The KPI resource format.
	KpiResourceFormat
}

KpiClientCreateOrUpdateResponse contains the response from method KpiClient.BeginCreateOrUpdate.

type KpiClientDeleteResponse 

type KpiClientDeleteResponse struct {
}

KpiClientDeleteResponse contains the response from method KpiClient.BeginDelete.

type KpiClientGetOptions 

type KpiClientGetOptions struct {
}

KpiClientGetOptions contains the optional parameters for the KpiClient.Get method.

type KpiClientGetResponse 

type KpiClientGetResponse struct {
	// The KPI resource format.
	KpiResourceFormat
}

KpiClientGetResponse contains the response from method KpiClient.Get.

type KpiClientListByHubOptions 

type KpiClientListByHubOptions struct {
}

KpiClientListByHubOptions contains the optional parameters for the KpiClient.NewListByHubPager method.

type KpiClientListByHubResponse 

type KpiClientListByHubResponse struct {
	// The response of list KPI operation.
	KpiListResult
}

KpiClientListByHubResponse contains the response from method KpiClient.NewListByHubPager.

type KpiClientReprocessOptions 

type KpiClientReprocessOptions struct {
}

KpiClientReprocessOptions contains the optional parameters for the KpiClient.Reprocess method.

type KpiClientReprocessResponse 

type KpiClientReprocessResponse struct {
}

KpiClientReprocessResponse contains the response from method KpiClient.Reprocess.

type KpiDefinition 

type KpiDefinition struct {
	// REQUIRED; The calculation window.
	CalculationWindow *CalculationWindowTypes

	// REQUIRED; The mapping entity type.
	EntityType *EntityTypes

	// REQUIRED; The mapping entity name.
	EntityTypeName *string

	// REQUIRED; The computation expression for the KPI.
	Expression *string

	// REQUIRED; The computation function for the KPI.
	Function *KpiFunctions

	// The aliases.
	Aliases []*KpiAlias

	// Name of calculation window field.
	CalculationWindowFieldName *string

	// Localized description for the KPI.
	Description map[string]*string

	// Localized display name for the KPI.
	DisplayName map[string]*string

	// The KPI extracts.
	Extracts []*KpiExtract

	// The filter expression for the KPI.
	Filter *string

	// the group by properties for the KPI.
	GroupBy []*string

	// The KPI thresholds.
	ThresHolds *KpiThresholds

	// The unit of measurement for the KPI.
	Unit *string

	// READ-ONLY; The KPI GroupByMetadata.
	GroupByMetadata []*KpiGroupByMetadata

	// READ-ONLY; The KPI name.
	KpiName *string

	// READ-ONLY; The participant profiles.
	ParticipantProfilesMetadata []*KpiParticipantProfilesMetadata

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

KpiDefinition - Defines the KPI Threshold limits.

func (KpiDefinition) MarshalJSON 

func (k KpiDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiDefinition.

func (*KpiDefinition) UnmarshalJSON added in v1.1.0 

func (k *KpiDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiDefinition.

type KpiExtract 

type KpiExtract struct {
	// REQUIRED; The expression.
	Expression *string

	// REQUIRED; KPI extract name.
	ExtractName *string
}

KpiExtract - The KPI extract.

func (KpiExtract) MarshalJSON added in v1.1.0 

func (k KpiExtract) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiExtract.

func (*KpiExtract) UnmarshalJSON added in v1.1.0 

func (k *KpiExtract) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiExtract.

type KpiFunctions 

type KpiFunctions string

KpiFunctions - The computation function for the KPI. 

const (
	KpiFunctionsAvg           KpiFunctions = "Avg"
	KpiFunctionsCount         KpiFunctions = "Count"
	KpiFunctionsCountDistinct KpiFunctions = "CountDistinct"
	KpiFunctionsLast          KpiFunctions = "Last"
	KpiFunctionsMax           KpiFunctions = "Max"
	KpiFunctionsMin           KpiFunctions = "Min"
	KpiFunctionsNone          KpiFunctions = "None"
	KpiFunctionsSum           KpiFunctions = "Sum"
)

func PossibleKpiFunctionsValues 

func PossibleKpiFunctionsValues() []KpiFunctions

PossibleKpiFunctionsValues returns the possible values for the KpiFunctions const type.

type KpiGroupByMetadata 

type KpiGroupByMetadata struct {
	// The display name.
	DisplayName map[string]*string

	// The name of the field.
	FieldName *string

	// The type of the field.
	FieldType *string
}

KpiGroupByMetadata - The KPI GroupBy field metadata.

func (KpiGroupByMetadata) MarshalJSON 

func (k KpiGroupByMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiGroupByMetadata.

func (*KpiGroupByMetadata) UnmarshalJSON added in v1.1.0 

func (k *KpiGroupByMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiGroupByMetadata.

type KpiListResult 

type KpiListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*KpiResourceFormat
}

KpiListResult - The response of list KPI operation.

func (KpiListResult) MarshalJSON added in v1.1.0 

func (k KpiListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiListResult.

func (*KpiListResult) UnmarshalJSON added in v1.1.0 

func (k *KpiListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiListResult.

type KpiParticipantProfilesMetadata 

type KpiParticipantProfilesMetadata struct {
	// REQUIRED; Name of the type.
	TypeName *string
}

KpiParticipantProfilesMetadata - The KPI participant profile metadata.

func (KpiParticipantProfilesMetadata) MarshalJSON added in v1.1.0 

func (k KpiParticipantProfilesMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiParticipantProfilesMetadata.

func (*KpiParticipantProfilesMetadata) UnmarshalJSON added in v1.1.0 

func (k *KpiParticipantProfilesMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiParticipantProfilesMetadata.

type KpiResourceFormat 

type KpiResourceFormat struct {
	// Defines the KPI Threshold limits.
	Properties *KpiDefinition

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

KpiResourceFormat - The KPI resource format.

func (KpiResourceFormat) MarshalJSON added in v1.1.0 

func (k KpiResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiResourceFormat.

func (*KpiResourceFormat) UnmarshalJSON added in v1.1.0 

func (k *KpiResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiResourceFormat.

type KpiThresholds 

type KpiThresholds struct {
	// REQUIRED; Whether or not the KPI is an increasing KPI.
	IncreasingKpi *bool

	// REQUIRED; The lower threshold limit.
	LowerLimit *float64

	// REQUIRED; The upper threshold limit.
	UpperLimit *float64
}

KpiThresholds - Defines the KPI Threshold limits.

func (KpiThresholds) MarshalJSON added in v1.1.0 

func (k KpiThresholds) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KpiThresholds.

func (*KpiThresholds) UnmarshalJSON added in v1.1.0 

func (k *KpiThresholds) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KpiThresholds.

type LinkDefinition 

type LinkDefinition struct {
	// REQUIRED; The properties that represent the participating profile.
	ParticipantPropertyReferences []*ParticipantPropertyReference

	// REQUIRED; Type of source entity.
	SourceEntityType *EntityType

	// REQUIRED; Name of the source Entity Type.
	SourceEntityTypeName *string

	// REQUIRED; Type of target entity.
	TargetEntityType *EntityType

	// REQUIRED; Name of the target Entity Type.
	TargetEntityTypeName *string

	// Localized descriptions for the Link.
	Description map[string]*string

	// Localized display name for the Link.
	DisplayName map[string]*string

	// The set of properties mappings between the source and target Types.
	Mappings []*TypePropertiesMapping

	// Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
	OperationType *InstanceOperationType

	// 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

	// READ-ONLY; The link name.
	LinkName *string

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

LinkDefinition - The definition of Link.

func (LinkDefinition) MarshalJSON 

func (l LinkDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkDefinition.

func (*LinkDefinition) UnmarshalJSON added in v1.1.0 

func (l *LinkDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkDefinition.

type LinkListResult 

type LinkListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*LinkResourceFormat
}

LinkListResult - The response of list link operation.

func (LinkListResult) MarshalJSON added in v1.1.0 

func (l LinkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkListResult.

func (*LinkListResult) UnmarshalJSON added in v1.1.0 

func (l *LinkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkListResult.

type LinkResourceFormat 

type LinkResourceFormat struct {
	// The definition of Link.
	Properties *LinkDefinition

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

LinkResourceFormat - The link resource format.

func (LinkResourceFormat) MarshalJSON added in v1.1.0 

func (l LinkResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkResourceFormat.

func (*LinkResourceFormat) UnmarshalJSON added in v1.1.0 

func (l *LinkResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkResourceFormat.

type LinkTypes 

type LinkTypes string

LinkTypes - Link type. 

const (
	LinkTypesCopyIfNull   LinkTypes = "CopyIfNull"
	LinkTypesUpdateAlways LinkTypes = "UpdateAlways"
)

func PossibleLinkTypesValues 

func PossibleLinkTypesValues() []LinkTypes

PossibleLinkTypesValues returns the possible values for the LinkTypes const type.

type LinksClient 

type LinksClient struct {
	// contains filtered or unexported fields
}

LinksClient contains the methods for the Links group. Don't use this type directly, use NewLinksClient() instead.

func NewLinksClient 

func NewLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LinksClient, error)

NewLinksClient creates a new instance of LinksClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*LinksClient) BeginCreateOrUpdate 

func (client *LinksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, linkName string, parameters LinkResourceFormat, options *LinksClientBeginCreateOrUpdateOptions) (*runtime.Poller[LinksClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a link or updates an existing link in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - LinksClientBeginCreateOrUpdateOptions contains the optional parameters for the LinksClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/LinksCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewLinksClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "linkTest4806", armcustomerinsights.LinkResourceFormat{
		Properties: &armcustomerinsights.LinkDefinition{
			Description: map[string]*string{
				"en-us": to.Ptr("Link Description"),
			},
			DisplayName: map[string]*string{
				"en-us": to.Ptr("Link DisplayName"),
			},
			LinkName: to.Ptr("linkTest4806"),
			Mappings: []*armcustomerinsights.TypePropertiesMapping{
				{
					LinkType:           to.Ptr(armcustomerinsights.LinkTypesUpdateAlways),
					SourcePropertyName: to.Ptr("testInteraction1949"),
					TargetPropertyName: to.Ptr("testProfile1446"),
				}},
			ParticipantPropertyReferences: []*armcustomerinsights.ParticipantPropertyReference{
				{
					SourcePropertyName: to.Ptr("testInteraction1949"),
					TargetPropertyName: to.Ptr("ProfileId"),
				}},
			SourceEntityType:     to.Ptr(armcustomerinsights.EntityTypeInteraction),
			SourceEntityTypeName: to.Ptr("testInteraction1949"),
			TargetEntityType:     to.Ptr(armcustomerinsights.EntityTypeProfile),
			TargetEntityTypeName: to.Ptr("testProfile1446"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LinkResourceFormat = armcustomerinsights.LinkResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/linkTest4806"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/links"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/links/linkTest4806"),
	// 	Properties: &armcustomerinsights.LinkDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Link Description"),
	// 		},
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Link DisplayName"),
	// 		},
	// 		LinkName: to.Ptr("linkTest4806"),
	// 		Mappings: []*armcustomerinsights.TypePropertiesMapping{
	// 			{
	// 				LinkType: to.Ptr(armcustomerinsights.LinkTypesUpdateAlways),
	// 				SourcePropertyName: to.Ptr("testInteraction1949"),
	// 				TargetPropertyName: to.Ptr("testProfile1446"),
	// 		}},
	// 		ParticipantPropertyReferences: []*armcustomerinsights.ParticipantPropertyReference{
	// 			{
	// 				SourcePropertyName: to.Ptr("testInteraction1949"),
	// 				TargetPropertyName: to.Ptr("ProfileId"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		ReferenceOnly: to.Ptr(false),
	// 		SourceEntityType: to.Ptr(armcustomerinsights.EntityTypeInteraction),
	// 		SourceEntityTypeName: to.Ptr("testInteraction1949"),
	// 		TargetEntityType: to.Ptr(armcustomerinsights.EntityTypeProfile),
	// 		TargetEntityTypeName: to.Ptr("testProfile1446"),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 	},
	// }
}

Output:

func (*LinksClient) Delete 

func (client *LinksClient) Delete(ctx context.Context, resourceGroupName string, hubName string, linkName string, options *LinksClientDeleteOptions) (LinksClientDeleteResponse, error)

Delete - Deletes a link in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • linkName - The name of the link.
  • options - LinksClientDeleteOptions contains the optional parameters for the LinksClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/LinksDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewLinksClient().Delete(ctx, "TestHubRG", "sdkTestHub", "linkTest4806", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*LinksClient) Get 

func (client *LinksClient) Get(ctx context.Context, resourceGroupName string, hubName string, linkName string, options *LinksClientGetOptions) (LinksClientGetResponse, error)

Get - Gets a link in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • linkName - The name of the link.
  • options - LinksClientGetOptions contains the optional parameters for the LinksClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/LinksGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLinksClient().Get(ctx, "TestHubRG", "sdkTestHub", "linkTest4806", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LinkResourceFormat = armcustomerinsights.LinkResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/linkTest4806"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/links"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/links/linkTest4806"),
	// 	Properties: &armcustomerinsights.LinkDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Link Description"),
	// 		},
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Link DisplayName"),
	// 		},
	// 		LinkName: to.Ptr("linkTest4806"),
	// 		Mappings: []*armcustomerinsights.TypePropertiesMapping{
	// 			{
	// 				LinkType: to.Ptr(armcustomerinsights.LinkTypesUpdateAlways),
	// 				SourcePropertyName: to.Ptr("testInteraction1949"),
	// 				TargetPropertyName: to.Ptr("testProfile1446"),
	// 		}},
	// 		ParticipantPropertyReferences: []*armcustomerinsights.ParticipantPropertyReference{
	// 			{
	// 				SourcePropertyName: to.Ptr("testInteraction1949"),
	// 				TargetPropertyName: to.Ptr("ProfileId"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		ReferenceOnly: to.Ptr(false),
	// 		SourceEntityType: to.Ptr(armcustomerinsights.EntityTypeInteraction),
	// 		SourceEntityTypeName: to.Ptr("testInteraction1949"),
	// 		TargetEntityType: to.Ptr(armcustomerinsights.EntityTypeProfile),
	// 		TargetEntityTypeName: to.Ptr("testProfile1446"),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 	},
	// }
}

Output:

func (*LinksClient) NewListByHubPager 

func (client *LinksClient) NewListByHubPager(resourceGroupName string, hubName string, options *LinksClientListByHubOptions) *runtime.Pager[LinksClientListByHubResponse]

NewListByHubPager - Gets all the links in the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - LinksClientListByHubOptions contains the optional parameters for the LinksClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/LinksListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLinksClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LinkListResult = armcustomerinsights.LinkListResult{
		// 	Value: []*armcustomerinsights.LinkResourceFormat{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub/linkTest4806"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/links"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/links/linkTest4806"),
		// 			Properties: &armcustomerinsights.LinkDefinition{
		// 				Description: map[string]*string{
		// 					"en-us": to.Ptr("Link Description"),
		// 				},
		// 				DisplayName: map[string]*string{
		// 					"en-us": to.Ptr("Link DisplayName"),
		// 				},
		// 				LinkName: to.Ptr("linkTest4806"),
		// 				Mappings: []*armcustomerinsights.TypePropertiesMapping{
		// 					{
		// 						LinkType: to.Ptr(armcustomerinsights.LinkTypesUpdateAlways),
		// 						SourcePropertyName: to.Ptr("testInteraction1949"),
		// 						TargetPropertyName: to.Ptr("testProfile1446"),
		// 				}},
		// 				ParticipantPropertyReferences: []*armcustomerinsights.ParticipantPropertyReference{
		// 					{
		// 						SourcePropertyName: to.Ptr("testInteraction1949"),
		// 						TargetPropertyName: to.Ptr("ProfileId"),
		// 				}},
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				ReferenceOnly: to.Ptr(false),
		// 				SourceEntityType: to.Ptr(armcustomerinsights.EntityTypeInteraction),
		// 				SourceEntityTypeName: to.Ptr("testInteraction1949"),
		// 				TargetEntityType: to.Ptr(armcustomerinsights.EntityTypeProfile),
		// 				TargetEntityTypeName: to.Ptr("testProfile1446"),
		// 				TenantID: to.Ptr("azsdktesthub"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type LinksClientBeginCreateOrUpdateOptions 

type LinksClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LinksClientBeginCreateOrUpdateOptions contains the optional parameters for the LinksClient.BeginCreateOrUpdate method.

type LinksClientCreateOrUpdateResponse 

type LinksClientCreateOrUpdateResponse struct {
	// The link resource format.
	LinkResourceFormat
}

LinksClientCreateOrUpdateResponse contains the response from method LinksClient.BeginCreateOrUpdate.

type LinksClientDeleteOptions 

type LinksClientDeleteOptions struct {
}

LinksClientDeleteOptions contains the optional parameters for the LinksClient.Delete method.

type LinksClientDeleteResponse 

type LinksClientDeleteResponse struct {
}

LinksClientDeleteResponse contains the response from method LinksClient.Delete.

type LinksClientGetOptions 

type LinksClientGetOptions struct {
}

LinksClientGetOptions contains the optional parameters for the LinksClient.Get method.

type LinksClientGetResponse 

type LinksClientGetResponse struct {
	// The link resource format.
	LinkResourceFormat
}

LinksClientGetResponse contains the response from method LinksClient.Get.

type LinksClientListByHubOptions 

type LinksClientListByHubOptions struct {
}

LinksClientListByHubOptions contains the optional parameters for the LinksClient.NewListByHubPager method.

type LinksClientListByHubResponse 

type LinksClientListByHubResponse struct {
	// The response of list link operation.
	LinkListResult
}

LinksClientListByHubResponse contains the response from method LinksClient.NewListByHubPager.

type MetadataDefinitionBase 

type MetadataDefinitionBase struct {
	// The attributes for the Type.
	Attributes map[string][]*string

	// Localized descriptions for the property.
	Description map[string]*string

	// Localized display names for the property.
	DisplayName map[string]*string

	// Large Image associated with the Property or EntityType.
	LargeImage *string

	// Any custom localized attributes for the Type.
	LocalizedAttributes map[string]map[string]*string

	// Medium Image associated with the Property or EntityType.
	MediumImage *string

	// Small Image associated with the Property or EntityType.
	SmallImage *string
}

MetadataDefinitionBase - The Metadata definition base.

func (MetadataDefinitionBase) MarshalJSON 

func (m MetadataDefinitionBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetadataDefinitionBase.

func (*MetadataDefinitionBase) UnmarshalJSON added in v1.1.0 

func (m *MetadataDefinitionBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetadataDefinitionBase.

type Operation 

type Operation struct {
	// The object that represents the operation.
	Display *OperationDisplay

	// READ-ONLY; Operation name: {provider}/{resource}/{operation}
	Name *string
}

Operation - A Customer Insights REST API operation

func (Operation) MarshalJSON added in v1.1.0 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v1.1.0 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; Operation type: Read, write, delete, etc.
	Operation *string

	// READ-ONLY; Service provider: Microsoft.CustomerInsights
	Provider *string

	// READ-ONLY; Resource on which the operation is performed: Invoice, etc.
	Resource *string
}

OperationDisplay - The object that represents the operation.

func (OperationDisplay) MarshalJSON added in v1.1.0 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON added in v1.1.0 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string

	// READ-ONLY; List of Customer Insights operations supported by the Microsoft.CustomerInsights resource provider.
	Value []*Operation
}

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 (OperationListResult) MarshalJSON added in v1.1.0 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON added in v1.1.0 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available Customer Insights REST API operations.

Generated from API version 2017-04-26

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/DCIOperations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationListResult = armcustomerinsights.OperationListResult{
		// 	Value: []*armcustomerinsights.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Hub"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Hubs"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Hub"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Hubs"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights Hub"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Hubs"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/views/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights App View"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights App Views"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/views/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights App View"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights App Views"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/views/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights App View"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights App Views"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Connector"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Connectors"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Connector"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Connectors"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights Connector"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Connectors"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/mappings/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Connector Mapping"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Connector Mappings"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/mappings/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Connector Mapping"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Connector Mappings"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/connectors/mappings/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights App View"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Connector Mappings"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/interactions/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Interaction"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Interactions"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/interactions/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Interaction"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Interactions"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/profiles/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Profile"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Profiles"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/profiles/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Profile"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Profiles"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/kpi/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Key Performance Indicator"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Create or Update Customer Insights Key Performance Indicators"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/kpi/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Key Performance Indicator"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Create or Update Customer Insights Key Performance Indicators"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/kpi/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights Key Performance Indicator"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Create or Update Customer Insights Key Performance Indicators"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/roleAssignments/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Rbac Assignment"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Rbac Assignments"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/roleAssignments/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Rbac Assignment"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Rbac Assignments"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/roleAssignments/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights Rbac Assignment"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Rbac Assignments"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/authorizationPolicies/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read Azure Customer Insights Shared Access Signature Policy"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Shared Access Signature Policies"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/authorizationPolicies/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Azure Customer Insights Shared Access Signature Policy"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Shared Access Signature Policies"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/authorizationPolicies/delete"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Delete Azure Customer Insights Shared Access Signature Policy"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Shared Access Signature Policies"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/authorizationPolicies/regeneratePrimaryKey/action"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Regenerate Azure Customer Insights Shared Access Signature Policy primary key"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Shared Access Signature Policies"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/authorizationPolicies/regenerateSecondaryKey/action"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Regenerate Azure Customer Insights Shared Access Signature Policy secondary key"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Azure Customer Insights Shared Access Signature Policies"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/providers/Microsoft.Insights/metricDefinitions/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read resource metric definitions"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Microsoft Azure Customer Insights Metric Definition"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/providers/Microsoft.Insights/logDefinitions/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Read resource log definitions"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Microsoft Azure Customer Insights Log Definition"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/providers/Microsoft.Insights/diagnosticSettings/read"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Diagnostic setting read"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Microsoft Azure Customer Insights Diagnostic Settings"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CustomerInsights/hubs/providers/Microsoft.Insights/diagnosticSettings/write"),
		// 			Display: &armcustomerinsights.OperationDisplay{
		// 				Operation: to.Ptr("Diagnostic setting write"),
		// 				Provider: to.Ptr("Microsoft Azure Customer Insights"),
		// 				Resource: to.Ptr("Microsoft Azure Customer Insights Diagnostic Settings"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// 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.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type Participant 

type Participant struct {
	// REQUIRED; Participant name.
	ParticipantName *string

	// REQUIRED; The property references.
	ParticipantPropertyReferences []*ParticipantPropertyReference

	// REQUIRED; Profile type name.
	ProfileTypeName *string

	// Localized descriptions.
	Description map[string]*string

	// Localized display name.
	DisplayName map[string]*string

	// The role that the participant is playing in the interaction.
	Role *string
}

Participant - Describes a profile type participating in an interaction.

func (Participant) MarshalJSON 

func (p Participant) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Participant.

func (*Participant) UnmarshalJSON added in v1.1.0 

func (p *Participant) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Participant.

type ParticipantProfilePropertyReference 

type ParticipantProfilePropertyReference struct {
	// REQUIRED; The source interaction property that maps to the target profile property.
	InteractionPropertyName *string

	// REQUIRED; The target profile property that maps to the source interaction property.
	ProfilePropertyName *string
}

ParticipantProfilePropertyReference - The participant profile property reference.

func (ParticipantProfilePropertyReference) MarshalJSON added in v1.1.0 

func (p ParticipantProfilePropertyReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ParticipantProfilePropertyReference.

func (*ParticipantProfilePropertyReference) UnmarshalJSON added in v1.1.0 

func (p *ParticipantProfilePropertyReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ParticipantProfilePropertyReference.

type ParticipantPropertyReference 

type ParticipantPropertyReference struct {
	// REQUIRED; The source property that maps to the target property.
	SourcePropertyName *string

	// REQUIRED; The target property that maps to the source property.
	TargetPropertyName *string
}

ParticipantPropertyReference - The participant property reference.

func (ParticipantPropertyReference) MarshalJSON added in v1.1.0 

func (p ParticipantPropertyReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ParticipantPropertyReference.

func (*ParticipantPropertyReference) UnmarshalJSON added in v1.1.0 

func (p *ParticipantPropertyReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ParticipantPropertyReference.

type PermissionTypes 

type PermissionTypes string

PermissionTypes - Supported permission types. 

const (
	PermissionTypesManage PermissionTypes = "Manage"
	PermissionTypesRead   PermissionTypes = "Read"
	PermissionTypesWrite  PermissionTypes = "Write"
)

func PossiblePermissionTypesValues 

func PossiblePermissionTypesValues() []PermissionTypes

PossiblePermissionTypesValues returns the possible values for the PermissionTypes const type.

type Prediction 

type Prediction struct {
	// REQUIRED; Whether do auto analyze.
	AutoAnalyze *bool

	// REQUIRED; Definition of the link mapping of prediction.
	Mappings *PredictionMappings

	// REQUIRED; Negative outcome expression.
	NegativeOutcomeExpression *string

	// REQUIRED; Positive outcome expression.
	PositiveOutcomeExpression *string

	// REQUIRED; Primary profile type.
	PrimaryProfileType *string

	// REQUIRED; Scope expression.
	ScopeExpression *string

	// REQUIRED; Score label.
	ScoreLabel *string

	// Description of the prediction.
	Description map[string]*string

	// Display name of the prediction.
	DisplayName map[string]*string

	// The prediction grades.
	Grades []*PredictionGradesItem

	// Interaction types involved in the prediction.
	InvolvedInteractionTypes []*string

	// KPI types involved in the prediction.
	InvolvedKpiTypes []*string

	// Relationships involved in the prediction.
	InvolvedRelationships []*string

	// Name of the prediction.
	PredictionName *string

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; System generated entities.
	SystemGeneratedEntities *PredictionSystemGeneratedEntities

	// READ-ONLY; The hub name.
	TenantID *string
}

Prediction - The prediction definition.

func (Prediction) MarshalJSON 

func (p Prediction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Prediction.

func (*Prediction) UnmarshalJSON added in v1.1.0 

func (p *Prediction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Prediction.

type PredictionDistributionDefinition 

type PredictionDistributionDefinition struct {
	// Distributions of the prediction.
	Distributions []*PredictionDistributionDefinitionDistributionsItem

	// Total negatives in the distribution.
	TotalNegatives *int64

	// Total positive in the distribution.
	TotalPositives *int64
}

PredictionDistributionDefinition - The definition of the prediction distribution.

func (PredictionDistributionDefinition) MarshalJSON added in v1.1.0 

func (p PredictionDistributionDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionDistributionDefinition.

func (*PredictionDistributionDefinition) UnmarshalJSON added in v1.1.0 

func (p *PredictionDistributionDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionDistributionDefinition.

type PredictionDistributionDefinitionDistributionsItem 

type PredictionDistributionDefinitionDistributionsItem struct {
	// Number of negatives.
	Negatives *int64

	// Number of negatives above threshold.
	NegativesAboveThreshold *int64

	// Number of positives.
	Positives *int64

	// Number of positives above threshold.
	PositivesAboveThreshold *int64

	// Score threshold.
	ScoreThreshold *int32
}

PredictionDistributionDefinitionDistributionsItem - The definition of a prediction distribution.

func (PredictionDistributionDefinitionDistributionsItem) MarshalJSON added in v1.1.0 

func (p PredictionDistributionDefinitionDistributionsItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionDistributionDefinitionDistributionsItem.

func (*PredictionDistributionDefinitionDistributionsItem) UnmarshalJSON added in v1.1.0 

func (p *PredictionDistributionDefinitionDistributionsItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionDistributionDefinitionDistributionsItem.

type PredictionGradesItem 

type PredictionGradesItem struct {
	// Name of the grade.
	GradeName *string

	// Maximum score threshold.
	MaxScoreThreshold *int32

	// Minimum score threshold.
	MinScoreThreshold *int32
}

PredictionGradesItem - The definition of a prediction grade.

func (PredictionGradesItem) MarshalJSON added in v1.1.0 

func (p PredictionGradesItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionGradesItem.

func (*PredictionGradesItem) UnmarshalJSON added in v1.1.0 

func (p *PredictionGradesItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionGradesItem.

type PredictionListResult 

type PredictionListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*PredictionResourceFormat
}

PredictionListResult - The response of list predictions operation.

func (PredictionListResult) MarshalJSON added in v1.1.0 

func (p PredictionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionListResult.

func (*PredictionListResult) UnmarshalJSON added in v1.1.0 

func (p *PredictionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionListResult.

type PredictionMappings 

type PredictionMappings struct {
	// REQUIRED; The grade of the link mapping.
	Grade *string

	// REQUIRED; The reason of the link mapping.
	Reason *string

	// REQUIRED; The score of the link mapping.
	Score *string
}

PredictionMappings - Definition of the link mapping of prediction.

func (PredictionMappings) MarshalJSON added in v1.1.0 

func (p PredictionMappings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionMappings.

func (*PredictionMappings) UnmarshalJSON added in v1.1.0 

func (p *PredictionMappings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionMappings.

type PredictionModelLifeCycle 

type PredictionModelLifeCycle string

PredictionModelLifeCycle - Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the status to PendingFeaturing or Active through API. 

const (
	PredictionModelLifeCycleActive                   PredictionModelLifeCycle = "Active"
	PredictionModelLifeCycleDeleted                  PredictionModelLifeCycle = "Deleted"
	PredictionModelLifeCycleDiscovering              PredictionModelLifeCycle = "Discovering"
	PredictionModelLifeCycleEvaluating               PredictionModelLifeCycle = "Evaluating"
	PredictionModelLifeCycleEvaluatingFailed         PredictionModelLifeCycle = "EvaluatingFailed"
	PredictionModelLifeCycleFailed                   PredictionModelLifeCycle = "Failed"
	PredictionModelLifeCycleFeaturing                PredictionModelLifeCycle = "Featuring"
	PredictionModelLifeCycleFeaturingFailed          PredictionModelLifeCycle = "FeaturingFailed"
	PredictionModelLifeCycleHumanIntervention        PredictionModelLifeCycle = "HumanIntervention"
	PredictionModelLifeCycleNew                      PredictionModelLifeCycle = "New"
	PredictionModelLifeCyclePendingDiscovering       PredictionModelLifeCycle = "PendingDiscovering"
	PredictionModelLifeCyclePendingFeaturing         PredictionModelLifeCycle = "PendingFeaturing"
	PredictionModelLifeCyclePendingModelConfirmation PredictionModelLifeCycle = "PendingModelConfirmation"
	PredictionModelLifeCyclePendingTraining          PredictionModelLifeCycle = "PendingTraining"
	PredictionModelLifeCycleProvisioning             PredictionModelLifeCycle = "Provisioning"
	PredictionModelLifeCycleProvisioningFailed       PredictionModelLifeCycle = "ProvisioningFailed"
	PredictionModelLifeCycleTraining                 PredictionModelLifeCycle = "Training"
	PredictionModelLifeCycleTrainingFailed           PredictionModelLifeCycle = "TrainingFailed"
)

func PossiblePredictionModelLifeCycleValues 

func PossiblePredictionModelLifeCycleValues() []PredictionModelLifeCycle

PossiblePredictionModelLifeCycleValues returns the possible values for the PredictionModelLifeCycle const type.

type PredictionModelStatus 

type PredictionModelStatus struct {
	// REQUIRED; Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the
	// status to PendingFeaturing or Active through API.
	Status *PredictionModelLifeCycle

	// READ-ONLY; The model status message.
	Message *string

	// READ-ONLY; Version of the model.
	ModelVersion *string

	// READ-ONLY; The prediction GUID ID.
	PredictionGUIDID *string

	// READ-ONLY; The prediction name.
	PredictionName *string

	// READ-ONLY; The signals used.
	SignalsUsed *int32

	// READ-ONLY; The hub name.
	TenantID *string

	// READ-ONLY; Count of the test set.
	TestSetCount *int32

	// READ-ONLY; The training accuracy.
	TrainingAccuracy *float64

	// READ-ONLY; Count of the training set.
	TrainingSetCount *int32

	// READ-ONLY; Count of the validation set.
	ValidationSetCount *int32
}

PredictionModelStatus - The prediction model status.

func (PredictionModelStatus) MarshalJSON added in v1.1.0 

func (p PredictionModelStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionModelStatus.

func (*PredictionModelStatus) UnmarshalJSON added in v1.1.0 

func (p *PredictionModelStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionModelStatus.

type PredictionResourceFormat 

type PredictionResourceFormat struct {
	// The prediction definition.
	Properties *Prediction

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

PredictionResourceFormat - The prediction resource format.

func (PredictionResourceFormat) MarshalJSON added in v1.1.0 

func (p PredictionResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionResourceFormat.

func (*PredictionResourceFormat) UnmarshalJSON added in v1.1.0 

func (p *PredictionResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionResourceFormat.

type PredictionSystemGeneratedEntities 

type PredictionSystemGeneratedEntities struct {
	// Generated interaction types.
	GeneratedInteractionTypes []*string

	// Generated KPIs.
	GeneratedKpis map[string]*string

	// Generated links.
	GeneratedLinks []*string
}

PredictionSystemGeneratedEntities - System generated entities.

func (PredictionSystemGeneratedEntities) MarshalJSON 

func (p PredictionSystemGeneratedEntities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionSystemGeneratedEntities.

func (*PredictionSystemGeneratedEntities) UnmarshalJSON added in v1.1.0 

func (p *PredictionSystemGeneratedEntities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionSystemGeneratedEntities.

type PredictionTrainingResults 

type PredictionTrainingResults struct {
	// READ-ONLY; Canonical profiles.
	CanonicalProfiles []*CanonicalProfileDefinition

	// READ-ONLY; Prediction distribution.
	PredictionDistribution *PredictionDistributionDefinition

	// READ-ONLY; Instance count of the primary profile.
	PrimaryProfileInstanceCount *int64

	// READ-ONLY; Score name.
	ScoreName *string

	// READ-ONLY; The hub name.
	TenantID *string
}

PredictionTrainingResults - The training results of the prediction.

func (PredictionTrainingResults) MarshalJSON added in v1.1.0 

func (p PredictionTrainingResults) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredictionTrainingResults.

func (*PredictionTrainingResults) UnmarshalJSON added in v1.1.0 

func (p *PredictionTrainingResults) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredictionTrainingResults.

type PredictionsClient 

type PredictionsClient struct {
	// contains filtered or unexported fields
}

PredictionsClient contains the methods for the Predictions group. Don't use this type directly, use NewPredictionsClient() instead.

func NewPredictionsClient 

func NewPredictionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PredictionsClient, error)

NewPredictionsClient creates a new instance of PredictionsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PredictionsClient) BeginCreateOrUpdate 

func (client *PredictionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, predictionName string, parameters PredictionResourceFormat, options *PredictionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PredictionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a Prediction or updates an existing Prediction in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • predictionName - The name of the Prediction.
  • parameters - Parameters supplied to the create/update Prediction operation.
  • options - PredictionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PredictionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPredictionsClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "sdktest", armcustomerinsights.PredictionResourceFormat{
		Properties: &armcustomerinsights.Prediction{
			Description: map[string]*string{
				"en-us": to.Ptr("sdktest"),
			},
			AutoAnalyze: to.Ptr(true),
			DisplayName: map[string]*string{
				"en-us": to.Ptr("sdktest"),
			},
			Grades:                   []*armcustomerinsights.PredictionGradesItem{},
			InvolvedInteractionTypes: []*string{},
			InvolvedKpiTypes:         []*string{},
			InvolvedRelationships:    []*string{},
			Mappings: &armcustomerinsights.PredictionMappings{
				Grade:  to.Ptr("sdktest_Grade"),
				Reason: to.Ptr("sdktest_Reason"),
				Score:  to.Ptr("sdktest_Score"),
			},
			NegativeOutcomeExpression: to.Ptr("Customers.FirstName = 'Mike'"),
			PositiveOutcomeExpression: to.Ptr("Customers.FirstName = 'David'"),
			PredictionName:            to.Ptr("sdktest"),
			PrimaryProfileType:        to.Ptr("Customers"),
			ScopeExpression:           to.Ptr("*"),
			ScoreLabel:                to.Ptr("score label"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PredictionResourceFormat = armcustomerinsights.PredictionResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/sdktest"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/predictions"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/predictions/sdktest"),
	// 	Properties: &armcustomerinsights.Prediction{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("sdktest"),
	// 		},
	// 		AutoAnalyze: to.Ptr(true),
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("sdktest"),
	// 		},
	// 		Grades: []*armcustomerinsights.PredictionGradesItem{
	// 		},
	// 		InvolvedInteractionTypes: []*string{
	// 		},
	// 		InvolvedKpiTypes: []*string{
	// 		},
	// 		InvolvedRelationships: []*string{
	// 		},
	// 		Mappings: &armcustomerinsights.PredictionMappings{
	// 			Grade: to.Ptr("sdktest_Grade"),
	// 			Reason: to.Ptr("sdktest_Reason"),
	// 			Score: to.Ptr("sdktest_Score"),
	// 		},
	// 		NegativeOutcomeExpression: to.Ptr("Customers.FirstName = 'Mike'"),
	// 		PositiveOutcomeExpression: to.Ptr("Customers.FirstName = 'David'"),
	// 		PredictionName: to.Ptr("sdktest"),
	// 		PrimaryProfileType: to.Ptr("Customers"),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		ScopeExpression: to.Ptr("*"),
	// 		ScoreLabel: to.Ptr("score label"),
	// 		SystemGeneratedEntities: &armcustomerinsights.PredictionSystemGeneratedEntities{
	// 			GeneratedInteractionTypes: []*string{
	// 				to.Ptr("_predictions_sdktest")},
	// 				GeneratedKpis: map[string]*string{
	// 					"leadingProfiles": to.Ptr("_predictions_sdktest_LeadingProfiles"),
	// 					"negativeOutcomeByGrade": to.Ptr("_predictions_sdktest_NegativeOutcomeByGrade"),
	// 					"positiveOutcomeByGrade": to.Ptr("_predictions_sdktest_PositiveOutcomeByGrade"),
	// 					"predictionPerformance": to.Ptr("_predictions_sdktest_PredictionPerformance"),
	// 				},
	// 				GeneratedLinks: []*string{
	// 					to.Ptr("_predictions_link_sdktest")},
	// 				},
	// 				TenantID: to.Ptr("predtest620"),
	// 			},
	// 		}
}

Output:

func (*PredictionsClient) BeginDelete 

func (client *PredictionsClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, predictionName string, options *PredictionsClientBeginDeleteOptions) (*runtime.Poller[PredictionsClientDeleteResponse], error)

BeginDelete - Deletes a Prediction in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • predictionName - The name of the Prediction.
  • options - PredictionsClientBeginDeleteOptions contains the optional parameters for the PredictionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPredictionsClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", "sdktest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*PredictionsClient) Get 

func (client *PredictionsClient) Get(ctx context.Context, resourceGroupName string, hubName string, predictionName string, options *PredictionsClientGetOptions) (PredictionsClientGetResponse, error)

Get - Gets a Prediction in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • predictionName - The name of the Prediction.
  • options - PredictionsClientGetOptions contains the optional parameters for the PredictionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPredictionsClient().Get(ctx, "TestHubRG", "sdkTestHub", "sdktest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PredictionResourceFormat = armcustomerinsights.PredictionResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/sdktest"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/predictions"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/predictions/sdktest"),
	// 	Properties: &armcustomerinsights.Prediction{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("sdktest"),
	// 		},
	// 		AutoAnalyze: to.Ptr(true),
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("sdktest"),
	// 		},
	// 		Grades: []*armcustomerinsights.PredictionGradesItem{
	// 		},
	// 		InvolvedInteractionTypes: []*string{
	// 		},
	// 		InvolvedKpiTypes: []*string{
	// 		},
	// 		InvolvedRelationships: []*string{
	// 		},
	// 		Mappings: &armcustomerinsights.PredictionMappings{
	// 			Grade: to.Ptr("sdktest_Grade"),
	// 			Reason: to.Ptr("sdktest_Reason"),
	// 			Score: to.Ptr("sdktest_Score"),
	// 		},
	// 		NegativeOutcomeExpression: to.Ptr("Customers.FirstName = 'Mike'"),
	// 		PositiveOutcomeExpression: to.Ptr("Customers.FirstName = 'David'"),
	// 		PredictionName: to.Ptr("sdktest"),
	// 		PrimaryProfileType: to.Ptr("Customers"),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		ScopeExpression: to.Ptr("*"),
	// 		ScoreLabel: to.Ptr("score label"),
	// 		SystemGeneratedEntities: &armcustomerinsights.PredictionSystemGeneratedEntities{
	// 			GeneratedInteractionTypes: []*string{
	// 				to.Ptr("_predictions_sdktest")},
	// 				GeneratedKpis: map[string]*string{
	// 					"leadingProfiles": to.Ptr("_predictions_sdktest_LeadingProfiles"),
	// 					"negativeOutcomeByGrade": to.Ptr("_predictions_sdktest_NegativeOutcomeByGrade"),
	// 					"positiveOutcomeByGrade": to.Ptr("_predictions_sdktest_PositiveOutcomeByGrade"),
	// 					"predictionPerformance": to.Ptr("_predictions_sdktest_PredictionPerformance"),
	// 				},
	// 				GeneratedLinks: []*string{
	// 					to.Ptr("_predictions_link_sdktest")},
	// 				},
	// 				TenantID: to.Ptr("predtest620"),
	// 			},
	// 		}
}

Output:

func (*PredictionsClient) GetModelStatus 

func (client *PredictionsClient) GetModelStatus(ctx context.Context, resourceGroupName string, hubName string, predictionName string, options *PredictionsClientGetModelStatusOptions) (PredictionsClientGetModelStatusResponse, error)

GetModelStatus - Gets model status of the prediction. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • predictionName - The name of the Prediction.
  • options - PredictionsClientGetModelStatusOptions contains the optional parameters for the PredictionsClient.GetModelStatus method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsGetModelStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPredictionsClient().GetModelStatus(ctx, "TestHubRG", "sdkTestHub", "sdktest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PredictionModelStatus = armcustomerinsights.PredictionModelStatus{
	// 	ModelVersion: to.Ptr("1.0"),
	// 	PredictionGUIDID: to.Ptr("abe4eb1f-d05a-e711-80c2-0004ffa07bea"),
	// 	PredictionName: to.Ptr("sdktest"),
	// 	Status: to.Ptr(armcustomerinsights.PredictionModelLifeCycleNew),
	// 	TenantID: to.Ptr("sdkTestHub"),
	// }
}

Output:

func (*PredictionsClient) GetTrainingResults 

func (client *PredictionsClient) GetTrainingResults(ctx context.Context, resourceGroupName string, hubName string, predictionName string, options *PredictionsClientGetTrainingResultsOptions) (PredictionsClientGetTrainingResultsResponse, error)

GetTrainingResults - Gets training results. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • predictionName - The name of the Prediction.
  • options - PredictionsClientGetTrainingResultsOptions contains the optional parameters for the PredictionsClient.GetTrainingResults method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsGetTrainingResults.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPredictionsClient().GetTrainingResults(ctx, "TestHubRG", "sdkTestHub", "sdktest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PredictionTrainingResults = armcustomerinsights.PredictionTrainingResults{
	// 	CanonicalProfiles: []*armcustomerinsights.CanonicalProfileDefinition{
	// 		{
	// 			CanonicalProfileID: to.Ptr[int32](100),
	// 			Properties: []*armcustomerinsights.CanonicalProfileDefinitionPropertiesItem{
	// 				{
	// 					Type: to.Ptr(armcustomerinsights.CanonicalPropertyValueTypeNumeric),
	// 					ProfileName: to.Ptr("Customers"),
	// 					ProfilePropertyName: to.Ptr("MobilePhone"),
	// 					Rank: to.Ptr[int32](1),
	// 					Value: to.Ptr("139162668.0000 - 34325747410.0000"),
	// 				},
	// 				{
	// 					Type: to.Ptr(armcustomerinsights.CanonicalPropertyValueTypeNumeric),
	// 					ProfileName: to.Ptr("Customers"),
	// 					ProfilePropertyName: to.Ptr("CustomerId"),
	// 					Rank: to.Ptr[int32](2),
	// 					Value: to.Ptr("592266139745.0000 - 592266139864.0000"),
	// 			}},
	// 	}},
	// 	PredictionDistribution: &armcustomerinsights.PredictionDistributionDefinition{
	// 		Distributions: []*armcustomerinsights.PredictionDistributionDefinitionDistributionsItem{
	// 			{
	// 				Negatives: to.Ptr[int64](0),
	// 				NegativesAboveThreshold: to.Ptr[int64](0),
	// 				Positives: to.Ptr[int64](0),
	// 				PositivesAboveThreshold: to.Ptr[int64](0),
	// 				ScoreThreshold: to.Ptr[int32](0),
	// 			},
	// 			{
	// 				Negatives: to.Ptr[int64](0),
	// 				NegativesAboveThreshold: to.Ptr[int64](0),
	// 				Positives: to.Ptr[int64](0),
	// 				PositivesAboveThreshold: to.Ptr[int64](0),
	// 				ScoreThreshold: to.Ptr[int32](1),
	// 		}},
	// 		TotalNegatives: to.Ptr[int64](0),
	// 		TotalPositives: to.Ptr[int64](0),
	// 	},
	// 	PrimaryProfileInstanceCount: to.Ptr[int64](0),
	// 	ScoreName: to.Ptr("sdktest"),
	// 	TenantID: to.Ptr("sdkTestHub"),
	// }
}

Output:

func (*PredictionsClient) ModelStatus 

func (client *PredictionsClient) ModelStatus(ctx context.Context, resourceGroupName string, hubName string, predictionName string, parameters PredictionModelStatus, options *PredictionsClientModelStatusOptions) (PredictionsClientModelStatusResponse, error)

ModelStatus - Creates or updates the model status of prediction. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • predictionName - The name of the Prediction.
  • parameters - Parameters supplied to the create/update prediction model status operation.
  • options - PredictionsClientModelStatusOptions contains the optional parameters for the PredictionsClient.ModelStatus method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsModelStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewPredictionsClient().ModelStatus(ctx, "TestHubRG", "sdkTestHub", "sdktest", armcustomerinsights.PredictionModelStatus{
		Status: to.Ptr(armcustomerinsights.PredictionModelLifeCycleTraining),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*PredictionsClient) NewListByHubPager 

func (client *PredictionsClient) NewListByHubPager(resourceGroupName string, hubName string, options *PredictionsClientListByHubOptions) *runtime.Pager[PredictionsClientListByHubResponse]

NewListByHubPager - Gets all the predictions in the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - PredictionsClientListByHubOptions contains the optional parameters for the PredictionsClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/PredictionsListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPredictionsClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PredictionListResult = armcustomerinsights.PredictionListResult{
		// 	Value: []*armcustomerinsights.PredictionResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/sdktest"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/predictions"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/predictions/sdktest"),
		// 			Properties: &armcustomerinsights.Prediction{
		// 				Description: map[string]*string{
		// 					"en-us": to.Ptr("sdktest"),
		// 				},
		// 				AutoAnalyze: to.Ptr(true),
		// 				DisplayName: map[string]*string{
		// 					"en-us": to.Ptr("sdktest"),
		// 				},
		// 				Grades: []*armcustomerinsights.PredictionGradesItem{
		// 				},
		// 				InvolvedInteractionTypes: []*string{
		// 				},
		// 				InvolvedKpiTypes: []*string{
		// 				},
		// 				InvolvedRelationships: []*string{
		// 				},
		// 				Mappings: &armcustomerinsights.PredictionMappings{
		// 					Grade: to.Ptr("sdktest_Grade"),
		// 					Reason: to.Ptr("sdktest_Reason"),
		// 					Score: to.Ptr("sdktest_Score"),
		// 				},
		// 				NegativeOutcomeExpression: to.Ptr("Customers.FirstName = 'Mike'"),
		// 				PositiveOutcomeExpression: to.Ptr("Customers.FirstName = 'David'"),
		// 				PredictionName: to.Ptr("sdktest"),
		// 				PrimaryProfileType: to.Ptr("Customers"),
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				ScopeExpression: to.Ptr("*"),
		// 				ScoreLabel: to.Ptr("score label"),
		// 				SystemGeneratedEntities: &armcustomerinsights.PredictionSystemGeneratedEntities{
		// 					GeneratedInteractionTypes: []*string{
		// 						to.Ptr("_predictions_sdktest")},
		// 						GeneratedKpis: map[string]*string{
		// 							"leadingProfiles": to.Ptr("_predictions_sdktest_LeadingProfiles"),
		// 							"negativeOutcomeByGrade": to.Ptr("_predictions_sdktest_NegativeOutcomeByGrade"),
		// 							"positiveOutcomeByGrade": to.Ptr("_predictions_sdktest_PositiveOutcomeByGrade"),
		// 							"predictionPerformance": to.Ptr("_predictions_sdktest_PredictionPerformance"),
		// 						},
		// 						GeneratedLinks: []*string{
		// 							to.Ptr("_predictions_link_sdktest")},
		// 						},
		// 						TenantID: to.Ptr("predtest620"),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type PredictionsClientBeginCreateOrUpdateOptions 

type PredictionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PredictionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PredictionsClient.BeginCreateOrUpdate method.

type PredictionsClientBeginDeleteOptions 

type PredictionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PredictionsClientBeginDeleteOptions contains the optional parameters for the PredictionsClient.BeginDelete method.

type PredictionsClientCreateOrUpdateResponse 

type PredictionsClientCreateOrUpdateResponse struct {
	// The prediction resource format.
	PredictionResourceFormat
}

PredictionsClientCreateOrUpdateResponse contains the response from method PredictionsClient.BeginCreateOrUpdate.

type PredictionsClientDeleteResponse 

type PredictionsClientDeleteResponse struct {
}

PredictionsClientDeleteResponse contains the response from method PredictionsClient.BeginDelete.

type PredictionsClientGetModelStatusOptions 

type PredictionsClientGetModelStatusOptions struct {
}

PredictionsClientGetModelStatusOptions contains the optional parameters for the PredictionsClient.GetModelStatus method.

type PredictionsClientGetModelStatusResponse 

type PredictionsClientGetModelStatusResponse struct {
	// The prediction model status.
	PredictionModelStatus
}

PredictionsClientGetModelStatusResponse contains the response from method PredictionsClient.GetModelStatus.

type PredictionsClientGetOptions 

type PredictionsClientGetOptions struct {
}

PredictionsClientGetOptions contains the optional parameters for the PredictionsClient.Get method.

type PredictionsClientGetResponse 

type PredictionsClientGetResponse struct {
	// The prediction resource format.
	PredictionResourceFormat
}

PredictionsClientGetResponse contains the response from method PredictionsClient.Get.

type PredictionsClientGetTrainingResultsOptions 

type PredictionsClientGetTrainingResultsOptions struct {
}

PredictionsClientGetTrainingResultsOptions contains the optional parameters for the PredictionsClient.GetTrainingResults method.

type PredictionsClientGetTrainingResultsResponse 

type PredictionsClientGetTrainingResultsResponse struct {
	// The training results of the prediction.
	PredictionTrainingResults
}

PredictionsClientGetTrainingResultsResponse contains the response from method PredictionsClient.GetTrainingResults.

type PredictionsClientListByHubOptions 

type PredictionsClientListByHubOptions struct {
}

PredictionsClientListByHubOptions contains the optional parameters for the PredictionsClient.NewListByHubPager method.

type PredictionsClientListByHubResponse 

type PredictionsClientListByHubResponse struct {
	// The response of list predictions operation.
	PredictionListResult
}

PredictionsClientListByHubResponse contains the response from method PredictionsClient.NewListByHubPager.

type PredictionsClientModelStatusOptions 

type PredictionsClientModelStatusOptions struct {
}

PredictionsClientModelStatusOptions contains the optional parameters for the PredictionsClient.ModelStatus method.

type PredictionsClientModelStatusResponse 

type PredictionsClientModelStatusResponse struct {
}

PredictionsClientModelStatusResponse contains the response from method PredictionsClient.ModelStatus.

type ProfileEnumValidValuesFormat 

type ProfileEnumValidValuesFormat struct {
	// Localized names of the enum member.
	LocalizedValueNames map[string]*string

	// The integer value of the enum member.
	Value *int32
}

ProfileEnumValidValuesFormat - Valid enum values in case of an enum property.

func (ProfileEnumValidValuesFormat) MarshalJSON 

func (p ProfileEnumValidValuesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfileEnumValidValuesFormat.

func (*ProfileEnumValidValuesFormat) UnmarshalJSON added in v1.1.0 

func (p *ProfileEnumValidValuesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProfileEnumValidValuesFormat.

type ProfileListResult 

type ProfileListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*ProfileResourceFormat
}

ProfileListResult - The response of list profile operation.

func (ProfileListResult) MarshalJSON added in v1.1.0 

func (p ProfileListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfileListResult.

func (*ProfileListResult) UnmarshalJSON added in v1.1.0 

func (p *ProfileListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProfileListResult.

type ProfileResourceFormat 

type ProfileResourceFormat struct {
	// The profile type definition.
	Properties *ProfileTypeDefinition

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

ProfileResourceFormat - The profile resource format.

func (ProfileResourceFormat) MarshalJSON added in v1.1.0 

func (p ProfileResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfileResourceFormat.

func (*ProfileResourceFormat) UnmarshalJSON added in v1.1.0 

func (p *ProfileResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProfileResourceFormat.

type ProfileTypeDefinition 

type ProfileTypeDefinition struct {
	// The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
	APIEntitySetName *string

	// The attributes for the Type.
	Attributes map[string][]*string

	// Localized descriptions for the property.
	Description map[string]*string

	// Localized display names for the property.
	DisplayName map[string]*string

	// Type of entity.
	EntityType *EntityTypes

	// The properties of the Profile.
	Fields []*PropertyDefinition

	// The instance count.
	InstancesCount *int32

	// Large Image associated with the Property or EntityType.
	LargeImage *string

	// Any custom localized attributes for the Type.
	LocalizedAttributes map[string]map[string]*string

	// Medium Image associated with the Property or EntityType.
	MediumImage *string

	// The schema org link. This helps ACI identify and suggest semantic models.
	SchemaItemTypeLink *string

	// Small Image associated with the Property or EntityType.
	SmallImage *string

	// The strong IDs.
	StrongIDs []*StrongID

	// The timestamp property name. Represents the time when the interaction or profile update happened.
	TimestampFieldName *string

	// The name of the entity.
	TypeName *string

	// READ-ONLY; The last changed time for the type definition.
	LastChangedUTC *time.Time

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

ProfileTypeDefinition - The profile type definition.

func (ProfileTypeDefinition) MarshalJSON 

func (p ProfileTypeDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfileTypeDefinition.

func (*ProfileTypeDefinition) UnmarshalJSON 

func (p *ProfileTypeDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProfileTypeDefinition.

type ProfilesClient 

type ProfilesClient struct {
	// contains filtered or unexported fields
}

ProfilesClient contains the methods for the Profiles group. Don't use this type directly, use NewProfilesClient() instead.

func NewProfilesClient 

func NewProfilesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProfilesClient, error)

NewProfilesClient creates a new instance of ProfilesClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ProfilesClient) BeginCreateOrUpdate 

func (client *ProfilesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, profileName string, parameters ProfileResourceFormat, options *ProfilesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ProfilesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a profile within a Hub, or updates an existing profile. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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
  • options - ProfilesClientBeginCreateOrUpdateOptions contains the optional parameters for the ProfilesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ProfilesCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProfilesClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "TestProfileType396", armcustomerinsights.ProfileResourceFormat{
		Properties: &armcustomerinsights.ProfileTypeDefinition{
			LargeImage:       to.Ptr("\\\\Images\\\\LargeImage"),
			MediumImage:      to.Ptr("\\\\Images\\\\MediumImage"),
			SmallImage:       to.Ptr("\\\\Images\\\\smallImage"),
			APIEntitySetName: to.Ptr("TestProfileType396"),
			Fields: []*armcustomerinsights.PropertyDefinition{
				{
					FieldName:  to.Ptr("Id"),
					FieldType:  to.Ptr("Edm.String"),
					IsArray:    to.Ptr(false),
					IsRequired: to.Ptr(true),
				},
				{
					FieldName:  to.Ptr("ProfileId"),
					FieldType:  to.Ptr("Edm.String"),
					IsArray:    to.Ptr(false),
					IsRequired: to.Ptr(true),
				},
				{
					FieldName:  to.Ptr("LastName"),
					FieldType:  to.Ptr("Edm.String"),
					IsArray:    to.Ptr(false),
					IsRequired: to.Ptr(true),
				},
				{
					FieldName:  to.Ptr("TestProfileType396"),
					FieldType:  to.Ptr("Edm.String"),
					IsArray:    to.Ptr(false),
					IsRequired: to.Ptr(true),
				},
				{
					FieldName:  to.Ptr("SavingAccountBalance"),
					FieldType:  to.Ptr("Edm.Int32"),
					IsArray:    to.Ptr(false),
					IsRequired: to.Ptr(true),
				}},
			SchemaItemTypeLink: to.Ptr("SchemaItemTypeLink"),
			StrongIDs: []*armcustomerinsights.StrongID{
				{
					KeyPropertyNames: []*string{
						to.Ptr("Id"),
						to.Ptr("SavingAccountBalance")},
					StrongIDName: to.Ptr("Id"),
				},
				{
					KeyPropertyNames: []*string{
						to.Ptr("ProfileId"),
						to.Ptr("LastName")},
					StrongIDName: to.Ptr("ProfileId"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProfileResourceFormat = armcustomerinsights.ProfileResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/TestProfileType396"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/profiles"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/profiles/TestProfileType396"),
	// 	Properties: &armcustomerinsights.ProfileTypeDefinition{
	// 		LargeImage: to.Ptr("\\\\Images\\\\LargeImage"),
	// 		MediumImage: to.Ptr("\\\\Images\\\\MediumImage"),
	// 		SmallImage: to.Ptr("\\\\Images\\\\smallImage"),
	// 		APIEntitySetName: to.Ptr("TestProfileType396"),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesProfile),
	// 		Fields: []*armcustomerinsights.PropertyDefinition{
	// 			{
	// 				FieldName: to.Ptr("Id"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("ProfileId"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("LastName"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("TestProfileType396"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("SavingAccountBalance"),
	// 				FieldType: to.Ptr("Edm.Int32"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 		}},
	// 		InstancesCount: to.Ptr[int32](0),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		SchemaItemTypeLink: to.Ptr("SchemaItemTypeLink"),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 		TypeName: to.Ptr("TestProfileType396"),
	// 		StrongIDs: []*armcustomerinsights.StrongID{
	// 			{
	// 				KeyPropertyNames: []*string{
	// 					to.Ptr("Id"),
	// 					to.Ptr("savingAccountBalance")},
	// 					StrongIDName: to.Ptr("Id"),
	// 				},
	// 				{
	// 					KeyPropertyNames: []*string{
	// 						to.Ptr("ProfileId"),
	// 						to.Ptr("LastName")},
	// 						StrongIDName: to.Ptr("ProfileId"),
	// 					},
	// 					{
	// 						KeyPropertyNames: []*string{
	// 							to.Ptr("ProfileId")},
	// 							StrongIDName: to.Ptr("ProfileId"),
	// 					}},
	// 				},
	// 			}
}

Output:

func (*ProfilesClient) BeginDelete 

func (client *ProfilesClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, profileName string, options *ProfilesClientBeginDeleteOptions) (*runtime.Poller[ProfilesClientDeleteResponse], error)

BeginDelete - Deletes a profile within a hub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • profileName - The name of the profile.
  • options - ProfilesClientBeginDeleteOptions contains the optional parameters for the ProfilesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ProfilesDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProfilesClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", "TestProfileType396", &armcustomerinsights.ProfilesClientBeginDeleteOptions{LocaleCode: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*ProfilesClient) Get 

func (client *ProfilesClient) Get(ctx context.Context, resourceGroupName string, hubName string, profileName string, options *ProfilesClientGetOptions) (ProfilesClientGetResponse, error)

Get - Gets information about the specified profile. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • profileName - The name of the profile.
  • options - ProfilesClientGetOptions contains the optional parameters for the ProfilesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ProfilesGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProfilesClient().Get(ctx, "TestHubRG", "sdkTestHub", "TestProfileType396", &armcustomerinsights.ProfilesClientGetOptions{LocaleCode: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProfileResourceFormat = armcustomerinsights.ProfileResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/TestProfileType396"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/profiles"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/profiles/TestProfileType396"),
	// 	Properties: &armcustomerinsights.ProfileTypeDefinition{
	// 		LargeImage: to.Ptr("\\\\Images\\\\LargeImage"),
	// 		MediumImage: to.Ptr("\\\\Images\\\\MediumImage"),
	// 		SmallImage: to.Ptr("\\\\Images\\\\smallImage"),
	// 		APIEntitySetName: to.Ptr("TestProfileType396"),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesProfile),
	// 		Fields: []*armcustomerinsights.PropertyDefinition{
	// 			{
	// 				FieldName: to.Ptr("Id"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("ProfileId"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("LastName"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("TestProfileType396"),
	// 				FieldType: to.Ptr("Edm.String"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 			},
	// 			{
	// 				FieldName: to.Ptr("SavingAccountBalance"),
	// 				FieldType: to.Ptr("Edm.Int32"),
	// 				IsArray: to.Ptr(false),
	// 				IsEnum: to.Ptr(false),
	// 				IsFlagEnum: to.Ptr(false),
	// 				IsImage: to.Ptr(false),
	// 				IsLocalizedString: to.Ptr(false),
	// 				IsName: to.Ptr(false),
	// 				IsRequired: to.Ptr(true),
	// 				PropertyID: to.Ptr("id1"),
	// 		}},
	// 		InstancesCount: to.Ptr[int32](0),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		SchemaItemTypeLink: to.Ptr("SchemaItemTypeLink"),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 		TypeName: to.Ptr("TestProfileType396"),
	// 		StrongIDs: []*armcustomerinsights.StrongID{
	// 			{
	// 				KeyPropertyNames: []*string{
	// 					to.Ptr("Id"),
	// 					to.Ptr("savingAccountBalance")},
	// 					StrongIDName: to.Ptr("Id"),
	// 				},
	// 				{
	// 					KeyPropertyNames: []*string{
	// 						to.Ptr("ProfileId"),
	// 						to.Ptr("LastName")},
	// 						StrongIDName: to.Ptr("ProfileId"),
	// 					},
	// 					{
	// 						KeyPropertyNames: []*string{
	// 							to.Ptr("ProfileId")},
	// 							StrongIDName: to.Ptr("ProfileId"),
	// 					}},
	// 				},
	// 			}
}

Output:

func (*ProfilesClient) GetEnrichingKpis 

func (client *ProfilesClient) GetEnrichingKpis(ctx context.Context, resourceGroupName string, hubName string, profileName string, options *ProfilesClientGetEnrichingKpisOptions) (ProfilesClientGetEnrichingKpisResponse, 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. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • profileName - The name of the profile.
  • options - ProfilesClientGetEnrichingKpisOptions contains the optional parameters for the ProfilesClient.GetEnrichingKpis method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ProfileGetEnrichingKpis.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProfilesClient().GetEnrichingKpis(ctx, "TestHubRG", "sdkTestHub", "TestProfileType396", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KpiDefinitionArray = []*armcustomerinsights.KpiDefinition{
	// 	{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("MonthlyDeposits"),
	// 		},
	// 		CalculationWindow: to.Ptr(armcustomerinsights.CalculationWindowTypesMonth),
	// 		CalculationWindowFieldName: to.Ptr(""),
	// 		EntityType: to.Ptr(armcustomerinsights.EntityTypesInteraction),
	// 		EntityTypeName: to.Ptr("Deposit"),
	// 		Expression: to.Ptr("Amount"),
	// 		Filter: to.Ptr(""),
	// 		Function: to.Ptr(armcustomerinsights.KpiFunctionsSum),
	// 		GroupBy: []*string{
	// 			to.Ptr("AccountType"),
	// 			to.Ptr("BranchId"),
	// 			to.Ptr("ContactId"),
	// 			to.Ptr("Location"),
	// 			to.Ptr("Type")},
	// 			GroupByMetadata: []*armcustomerinsights.KpiGroupByMetadata{
	// 				{
	// 					DisplayName: map[string]*string{
	// 						"en-us": to.Ptr("AccountType"),
	// 					},
	// 					FieldName: to.Ptr("AccountType"),
	// 					FieldType: to.Ptr("Edm.String"),
	// 				},
	// 				{
	// 					DisplayName: map[string]*string{
	// 						"en-us": to.Ptr("BranchId"),
	// 					},
	// 					FieldName: to.Ptr("BranchId"),
	// 					FieldType: to.Ptr("Edm.Int32"),
	// 				},
	// 				{
	// 					DisplayName: map[string]*string{
	// 						"en-us": to.Ptr("ContactId"),
	// 					},
	// 					FieldName: to.Ptr("ContactId"),
	// 					FieldType: to.Ptr("Edm.Int32"),
	// 				},
	// 				{
	// 					DisplayName: map[string]*string{
	// 						"en-us": to.Ptr("Location"),
	// 					},
	// 					FieldName: to.Ptr("Location"),
	// 					FieldType: to.Ptr("Edm.String"),
	// 				},
	// 				{
	// 					DisplayName: map[string]*string{
	// 						"en-us": to.Ptr("Type"),
	// 					},
	// 					FieldName: to.Ptr("Type"),
	// 					FieldType: to.Ptr("Edm.String"),
	// 			}},
	// 			KpiName: to.Ptr("MonthlyDeposits"),
	// 			ParticipantProfilesMetadata: []*armcustomerinsights.KpiParticipantProfilesMetadata{
	// 			},
	// 			ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 			TenantID: to.Ptr("sdkTestHub"),
	// 			ThresHolds: &armcustomerinsights.KpiThresholds{
	// 				IncreasingKpi: to.Ptr(true),
	// 				LowerLimit: to.Ptr[float64](0),
	// 				UpperLimit: to.Ptr[float64](0),
	// 			},
	// 			Unit: to.Ptr(""),
	// 	}}
}

Output:

func (*ProfilesClient) NewListByHubPager 

func (client *ProfilesClient) NewListByHubPager(resourceGroupName string, hubName string, options *ProfilesClientListByHubOptions) *runtime.Pager[ProfilesClientListByHubResponse]

NewListByHubPager - Gets all profile in the hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - ProfilesClientListByHubOptions contains the optional parameters for the ProfilesClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ProfilesListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProfilesClient().NewListByHubPager("TestHubRG", "sdkTestHub", &armcustomerinsights.ProfilesClientListByHubOptions{LocaleCode: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProfileListResult = armcustomerinsights.ProfileListResult{
		// 	Value: []*armcustomerinsights.ProfileResourceFormat{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub/TestProfileType396"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/profiles"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/profiles/TestProfileType396"),
		// 			Properties: &armcustomerinsights.ProfileTypeDefinition{
		// 				LargeImage: to.Ptr("\\\\Images\\\\LargeImage"),
		// 				MediumImage: to.Ptr("\\\\Images\\\\MediumImage"),
		// 				SmallImage: to.Ptr("\\\\Images\\\\smallImage"),
		// 				APIEntitySetName: to.Ptr("TestProfileType396"),
		// 				EntityType: to.Ptr(armcustomerinsights.EntityTypesProfile),
		// 				Fields: []*armcustomerinsights.PropertyDefinition{
		// 					{
		// 						FieldName: to.Ptr("Id"),
		// 						FieldType: to.Ptr("Edm.String"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 					},
		// 					{
		// 						FieldName: to.Ptr("ProfileId"),
		// 						FieldType: to.Ptr("Edm.String"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 					},
		// 					{
		// 						FieldName: to.Ptr("LastName"),
		// 						FieldType: to.Ptr("Edm.String"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 					},
		// 					{
		// 						FieldName: to.Ptr("TestProfileType396"),
		// 						FieldType: to.Ptr("Edm.String"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 					},
		// 					{
		// 						FieldName: to.Ptr("SavingAccountBalance"),
		// 						FieldType: to.Ptr("Edm.Int32"),
		// 						IsArray: to.Ptr(false),
		// 						IsEnum: to.Ptr(false),
		// 						IsFlagEnum: to.Ptr(false),
		// 						IsImage: to.Ptr(false),
		// 						IsLocalizedString: to.Ptr(false),
		// 						IsName: to.Ptr(false),
		// 						IsRequired: to.Ptr(true),
		// 						PropertyID: to.Ptr("id1"),
		// 				}},
		// 				InstancesCount: to.Ptr[int32](0),
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				SchemaItemTypeLink: to.Ptr("SchemaItemTypeLink"),
		// 				TenantID: to.Ptr("azsdktesthub"),
		// 				TypeName: to.Ptr("TestProfileType396"),
		// 				StrongIDs: []*armcustomerinsights.StrongID{
		// 					{
		// 						KeyPropertyNames: []*string{
		// 							to.Ptr("Id"),
		// 							to.Ptr("savingAccountBalance")},
		// 							StrongIDName: to.Ptr("Id"),
		// 						},
		// 						{
		// 							KeyPropertyNames: []*string{
		// 								to.Ptr("ProfileId"),
		// 								to.Ptr("LastName")},
		// 								StrongIDName: to.Ptr("ProfileId"),
		// 							},
		// 							{
		// 								KeyPropertyNames: []*string{
		// 									to.Ptr("ProfileId")},
		// 									StrongIDName: to.Ptr("ProfileId"),
		// 							}},
		// 						},
		// 				}},
		// 			}
	}
}

Output:

type ProfilesClientBeginCreateOrUpdateOptions 

type ProfilesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ProfilesClientBeginCreateOrUpdateOptions contains the optional parameters for the ProfilesClient.BeginCreateOrUpdate method.

type ProfilesClientBeginDeleteOptions 

type ProfilesClientBeginDeleteOptions struct {
	// Locale of profile to retrieve, default is en-us.
	LocaleCode *string

	// Resumes the LRO from the provided token.
	ResumeToken string
}

ProfilesClientBeginDeleteOptions contains the optional parameters for the ProfilesClient.BeginDelete method.

type ProfilesClientCreateOrUpdateResponse 

type ProfilesClientCreateOrUpdateResponse struct {
	// The profile resource format.
	ProfileResourceFormat
}

ProfilesClientCreateOrUpdateResponse contains the response from method ProfilesClient.BeginCreateOrUpdate.

type ProfilesClientDeleteResponse 

type ProfilesClientDeleteResponse struct {
}

ProfilesClientDeleteResponse contains the response from method ProfilesClient.BeginDelete.

type ProfilesClientGetEnrichingKpisOptions 

type ProfilesClientGetEnrichingKpisOptions struct {
}

ProfilesClientGetEnrichingKpisOptions contains the optional parameters for the ProfilesClient.GetEnrichingKpis method.

type ProfilesClientGetEnrichingKpisResponse 

type ProfilesClientGetEnrichingKpisResponse struct {
	// Array of KpiDefinition
	KpiDefinitionArray []*KpiDefinition
}

ProfilesClientGetEnrichingKpisResponse contains the response from method ProfilesClient.GetEnrichingKpis.

type ProfilesClientGetOptions 

type ProfilesClientGetOptions struct {
	// Locale of profile to retrieve, default is en-us.
	LocaleCode *string
}

ProfilesClientGetOptions contains the optional parameters for the ProfilesClient.Get method.

type ProfilesClientGetResponse 

type ProfilesClientGetResponse struct {
	// The profile resource format.
	ProfileResourceFormat
}

ProfilesClientGetResponse contains the response from method ProfilesClient.Get.

type ProfilesClientListByHubOptions 

type ProfilesClientListByHubOptions struct {
	// Locale of profile to retrieve, default is en-us.
	LocaleCode *string
}

ProfilesClientListByHubOptions contains the optional parameters for the ProfilesClient.NewListByHubPager method.

type ProfilesClientListByHubResponse 

type ProfilesClientListByHubResponse struct {
	// The response of list profile operation.
	ProfileListResult
}

ProfilesClientListByHubResponse contains the response from method ProfilesClient.NewListByHubPager.

type PropertyDefinition 

type PropertyDefinition struct {
	// REQUIRED; Name of the property.
	FieldName *string

	// REQUIRED; Type of the property.
	FieldType *string

	// Array value separator for properties with isArray set.
	ArrayValueSeparator *string

	// Describes valid values for an enum property.
	EnumValidValues []*ProfileEnumValidValuesFormat

	// Indicates if the property is actually an array of the fieldType above on the data api.
	IsArray *bool

	// Whether property is available in graph or not.
	IsAvailableInGraph *bool

	// Indicates if the property is an enum.
	IsEnum *bool

	// Indicates if the property is an flag enum.
	IsFlagEnum *bool

	// Whether the property is an Image.
	IsImage *bool

	// Whether the property is a localized string.
	IsLocalizedString *bool

	// Whether the property is a name or a part of name.
	IsName *bool

	// Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check
	// for required field.
	IsRequired *bool

	// Max length of string. Used only if type is string.
	MaxLength *int32

	// The ID associated with the property.
	PropertyID *string

	// URL encoded schema.org item prop link for the property.
	SchemaItemPropLink *string

	// 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
}

PropertyDefinition - Property definition.

func (PropertyDefinition) MarshalJSON 

func (p PropertyDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PropertyDefinition.

func (*PropertyDefinition) UnmarshalJSON added in v1.1.0 

func (p *PropertyDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PropertyDefinition.

type ProvisioningStates 

type ProvisioningStates string

ProvisioningStates - Provisioning state. 

const (
	ProvisioningStatesDeleting          ProvisioningStates = "Deleting"
	ProvisioningStatesExpiring          ProvisioningStates = "Expiring"
	ProvisioningStatesFailed            ProvisioningStates = "Failed"
	ProvisioningStatesHumanIntervention ProvisioningStates = "HumanIntervention"
	ProvisioningStatesProvisioning      ProvisioningStates = "Provisioning"
	ProvisioningStatesSucceeded         ProvisioningStates = "Succeeded"
)

func PossibleProvisioningStatesValues 

func PossibleProvisioningStatesValues() []ProvisioningStates

PossibleProvisioningStatesValues returns the possible values for the ProvisioningStates const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

ProxyResource - Common properties of proxy resource.

func (ProxyResource) MarshalJSON added in v1.1.0 

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON added in v1.1.0 

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type RelationshipDefinition 

type RelationshipDefinition struct {
	// REQUIRED; Profile type.
	ProfileType *string

	// REQUIRED; Related profile being referenced.
	RelatedProfileType *string

	// The Relationship Cardinality.
	Cardinality *CardinalityTypes

	// Localized descriptions for the Relationship.
	Description map[string]*string

	// Localized display name for the Relationship.
	DisplayName map[string]*string

	// The expiry date time in UTC.
	ExpiryDateTimeUTC *time.Time

	// The properties of the Relationship.
	Fields []*PropertyDefinition

	// Optional property to be used to map fields in profile to their strong ids in related profile.
	LookupMappings []*RelationshipTypeMapping

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The relationship guid id.
	RelationshipGUIDID *string

	// READ-ONLY; The Relationship name.
	RelationshipName *string

	// READ-ONLY; The hub name.
	TenantID *string
}

RelationshipDefinition - The definition of Relationship.

func (RelationshipDefinition) MarshalJSON 

func (r RelationshipDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipDefinition.

func (*RelationshipDefinition) UnmarshalJSON 

func (r *RelationshipDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipDefinition.

type RelationshipLinkDefinition 

type RelationshipLinkDefinition struct {
	// REQUIRED; The InteractionType associated with the Relationship Link.
	InteractionType *string

	// REQUIRED; The property references for the Profile of the Relationship.
	ProfilePropertyReferences []*ParticipantProfilePropertyReference

	// REQUIRED; The property references for the Related Profile of the Relationship.
	RelatedProfilePropertyReferences []*ParticipantProfilePropertyReference

	// REQUIRED; The Relationship associated with the Link.
	RelationshipName *string

	// Localized descriptions for the Relationship Link.
	Description map[string]*string

	// Localized display name for the Relationship Link.
	DisplayName map[string]*string

	// The mappings between Interaction and Relationship fields.
	Mappings []*RelationshipLinkFieldMapping

	// READ-ONLY; The name of the Relationship Link.
	LinkName *string

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The relationship guid id.
	RelationshipGUIDID *string

	// READ-ONLY; The hub name.
	TenantID *string
}

RelationshipLinkDefinition - The definition of relationship link.

func (RelationshipLinkDefinition) MarshalJSON 

func (r RelationshipLinkDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipLinkDefinition.

func (*RelationshipLinkDefinition) UnmarshalJSON added in v1.1.0 

func (r *RelationshipLinkDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipLinkDefinition.

type RelationshipLinkFieldMapping 

type RelationshipLinkFieldMapping struct {
	// REQUIRED; The field name on the Interaction Type.
	InteractionFieldName *string

	// REQUIRED; The field name on the Relationship metadata.
	RelationshipFieldName *string

	// Link type.
	LinkType *LinkTypes
}

RelationshipLinkFieldMapping - The fields mapping for Relationships.

func (RelationshipLinkFieldMapping) MarshalJSON added in v1.1.0 

func (r RelationshipLinkFieldMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipLinkFieldMapping.

func (*RelationshipLinkFieldMapping) UnmarshalJSON added in v1.1.0 

func (r *RelationshipLinkFieldMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipLinkFieldMapping.

type RelationshipLinkListResult 

type RelationshipLinkListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*RelationshipLinkResourceFormat
}

RelationshipLinkListResult - The response of list relationship link operation.

func (RelationshipLinkListResult) MarshalJSON added in v1.1.0 

func (r RelationshipLinkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipLinkListResult.

func (*RelationshipLinkListResult) UnmarshalJSON added in v1.1.0 

func (r *RelationshipLinkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipLinkListResult.

type RelationshipLinkResourceFormat 

type RelationshipLinkResourceFormat struct {
	// The definition of relationship link.
	Properties *RelationshipLinkDefinition

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

RelationshipLinkResourceFormat - The relationship link resource format.

func (RelationshipLinkResourceFormat) MarshalJSON added in v1.1.0 

func (r RelationshipLinkResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipLinkResourceFormat.

func (*RelationshipLinkResourceFormat) UnmarshalJSON added in v1.1.0 

func (r *RelationshipLinkResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipLinkResourceFormat.

type RelationshipLinksClient 

type RelationshipLinksClient struct {
	// contains filtered or unexported fields
}

RelationshipLinksClient contains the methods for the RelationshipLinks group. Don't use this type directly, use NewRelationshipLinksClient() instead.

func NewRelationshipLinksClient 

func NewRelationshipLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RelationshipLinksClient, error)

NewRelationshipLinksClient creates a new instance of RelationshipLinksClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RelationshipLinksClient) BeginCreateOrUpdate 

func (client *RelationshipLinksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string, parameters RelationshipLinkResourceFormat, options *RelationshipLinksClientBeginCreateOrUpdateOptions) (*runtime.Poller[RelationshipLinksClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a relationship link or updates an existing relationship link within a hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - RelationshipLinksClientBeginCreateOrUpdateOptions contains the optional parameters for the RelationshipLinksClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipLinksCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRelationshipLinksClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "Somelink", armcustomerinsights.RelationshipLinkResourceFormat{
		Properties: &armcustomerinsights.RelationshipLinkDefinition{
			Description: map[string]*string{
				"en-us": to.Ptr("Link Description"),
			},
			DisplayName: map[string]*string{
				"en-us": to.Ptr("Link DisplayName"),
			},
			InteractionType: to.Ptr("testInteraction4332"),
			LinkName:        to.Ptr("Somelink"),
			ProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
				{
					InteractionPropertyName: to.Ptr("profile1"),
					ProfilePropertyName:     to.Ptr("ProfileId"),
				}},
			RelatedProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
				{
					InteractionPropertyName: to.Ptr("profile1"),
					ProfilePropertyName:     to.Ptr("ProfileId"),
				}},
			RelationshipName: to.Ptr("testProfile2326994"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RelationshipLinkResourceFormat = armcustomerinsights.RelationshipLinkResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/Somelink"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/relationshipLinks"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationshipLinks/Somelink"),
	// 	Properties: &armcustomerinsights.RelationshipLinkDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Link Description"),
	// 		},
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Link DisplayName"),
	// 		},
	// 		InteractionType: to.Ptr("testInteraction4332"),
	// 		LinkName: to.Ptr("Somelink"),
	// 		ProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
	// 			{
	// 				InteractionPropertyName: to.Ptr("profile1"),
	// 				ProfilePropertyName: to.Ptr("ProfileId"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		RelatedProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
	// 			{
	// 				InteractionPropertyName: to.Ptr("profile1"),
	// 				ProfilePropertyName: to.Ptr("ProfileId"),
	// 		}},
	// 		RelationshipName: to.Ptr("testProfile2326994"),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*RelationshipLinksClient) BeginDelete 

func (client *RelationshipLinksClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string, options *RelationshipLinksClientBeginDeleteOptions) (*runtime.Poller[RelationshipLinksClientDeleteResponse], error)

BeginDelete - Deletes a relationship link within a hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • relationshipLinkName - The name of the relationship.
  • options - RelationshipLinksClientBeginDeleteOptions contains the optional parameters for the RelationshipLinksClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipLinksDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRelationshipLinksClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", "Somelink", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*RelationshipLinksClient) Get 

func (client *RelationshipLinksClient) Get(ctx context.Context, resourceGroupName string, hubName string, relationshipLinkName string, options *RelationshipLinksClientGetOptions) (RelationshipLinksClientGetResponse, error)

Get - Gets information about the specified relationship Link. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • relationshipLinkName - The name of the relationship link.
  • options - RelationshipLinksClientGetOptions contains the optional parameters for the RelationshipLinksClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipLinksGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRelationshipLinksClient().Get(ctx, "TestHubRG", "sdkTestHub", "Somelink", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RelationshipLinkResourceFormat = armcustomerinsights.RelationshipLinkResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/Somelink"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/relationshipLinks"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationshipLinks/Somelink"),
	// 	Properties: &armcustomerinsights.RelationshipLinkDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Link Description"),
	// 		},
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Link DisplayName"),
	// 		},
	// 		InteractionType: to.Ptr("testInteraction4332"),
	// 		LinkName: to.Ptr("Somelink"),
	// 		ProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
	// 			{
	// 				InteractionPropertyName: to.Ptr("profile1"),
	// 				ProfilePropertyName: to.Ptr("ProfileId"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		RelatedProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
	// 			{
	// 				InteractionPropertyName: to.Ptr("profile1"),
	// 				ProfilePropertyName: to.Ptr("ProfileId"),
	// 		}},
	// 		RelationshipName: to.Ptr("testProfile2326994"),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*RelationshipLinksClient) NewListByHubPager 

func (client *RelationshipLinksClient) NewListByHubPager(resourceGroupName string, hubName string, options *RelationshipLinksClientListByHubOptions) *runtime.Pager[RelationshipLinksClientListByHubResponse]

NewListByHubPager - Gets all relationship links in the hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - RelationshipLinksClientListByHubOptions contains the optional parameters for the RelationshipLinksClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipLinksListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRelationshipLinksClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RelationshipLinkListResult = armcustomerinsights.RelationshipLinkListResult{
		// 	Value: []*armcustomerinsights.RelationshipLinkResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/Somelink"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/relationshipLinks"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationshipLinks/Somelink"),
		// 			Properties: &armcustomerinsights.RelationshipLinkDefinition{
		// 				Description: map[string]*string{
		// 					"en-us": to.Ptr("Link Description"),
		// 				},
		// 				DisplayName: map[string]*string{
		// 					"en-us": to.Ptr("Link DisplayName"),
		// 				},
		// 				InteractionType: to.Ptr("testInteraction4332"),
		// 				LinkName: to.Ptr("Somelink"),
		// 				ProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
		// 					{
		// 						InteractionPropertyName: to.Ptr("profile1"),
		// 						ProfilePropertyName: to.Ptr("ProfileId"),
		// 				}},
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				RelatedProfilePropertyReferences: []*armcustomerinsights.ParticipantProfilePropertyReference{
		// 					{
		// 						InteractionPropertyName: to.Ptr("profile1"),
		// 						ProfilePropertyName: to.Ptr("ProfileId"),
		// 				}},
		// 				RelationshipName: to.Ptr("testProfile2326994"),
		// 				TenantID: to.Ptr("sdktesthub"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type RelationshipLinksClientBeginCreateOrUpdateOptions 

type RelationshipLinksClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RelationshipLinksClientBeginCreateOrUpdateOptions contains the optional parameters for the RelationshipLinksClient.BeginCreateOrUpdate method.

type RelationshipLinksClientBeginDeleteOptions 

type RelationshipLinksClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RelationshipLinksClientBeginDeleteOptions contains the optional parameters for the RelationshipLinksClient.BeginDelete method.

type RelationshipLinksClientCreateOrUpdateResponse 

type RelationshipLinksClientCreateOrUpdateResponse struct {
	// The relationship link resource format.
	RelationshipLinkResourceFormat
}

RelationshipLinksClientCreateOrUpdateResponse contains the response from method RelationshipLinksClient.BeginCreateOrUpdate.

type RelationshipLinksClientDeleteResponse 

type RelationshipLinksClientDeleteResponse struct {
}

RelationshipLinksClientDeleteResponse contains the response from method RelationshipLinksClient.BeginDelete.

type RelationshipLinksClientGetOptions 

type RelationshipLinksClientGetOptions struct {
}

RelationshipLinksClientGetOptions contains the optional parameters for the RelationshipLinksClient.Get method.

type RelationshipLinksClientGetResponse 

type RelationshipLinksClientGetResponse struct {
	// The relationship link resource format.
	RelationshipLinkResourceFormat
}

RelationshipLinksClientGetResponse contains the response from method RelationshipLinksClient.Get.

type RelationshipLinksClientListByHubOptions 

type RelationshipLinksClientListByHubOptions struct {
}

RelationshipLinksClientListByHubOptions contains the optional parameters for the RelationshipLinksClient.NewListByHubPager method.

type RelationshipLinksClientListByHubResponse 

type RelationshipLinksClientListByHubResponse struct {
	// The response of list relationship link operation.
	RelationshipLinkListResult
}

RelationshipLinksClientListByHubResponse contains the response from method RelationshipLinksClient.NewListByHubPager.

type RelationshipListResult 

type RelationshipListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*RelationshipResourceFormat
}

RelationshipListResult - The response of list relationship operation.

func (RelationshipListResult) MarshalJSON added in v1.1.0 

func (r RelationshipListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipListResult.

func (*RelationshipListResult) UnmarshalJSON added in v1.1.0 

func (r *RelationshipListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipListResult.

type RelationshipResourceFormat 

type RelationshipResourceFormat struct {
	// The definition of Relationship.
	Properties *RelationshipDefinition

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

RelationshipResourceFormat - The relationship resource format.

func (RelationshipResourceFormat) MarshalJSON added in v1.1.0 

func (r RelationshipResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipResourceFormat.

func (*RelationshipResourceFormat) UnmarshalJSON added in v1.1.0 

func (r *RelationshipResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipResourceFormat.

type RelationshipTypeFieldMapping 

type RelationshipTypeFieldMapping struct {
	// REQUIRED; Specifies the fieldName in profile.
	ProfileFieldName *string

	// REQUIRED; Specifies the KeyProperty (from StrongId) of the related profile.
	RelatedProfileKeyProperty *string
}

RelationshipTypeFieldMapping - Map a field of profile to its corresponding StrongId in Related Profile.

func (RelationshipTypeFieldMapping) MarshalJSON added in v1.1.0 

func (r RelationshipTypeFieldMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipTypeFieldMapping.

func (*RelationshipTypeFieldMapping) UnmarshalJSON added in v1.1.0 

func (r *RelationshipTypeFieldMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipTypeFieldMapping.

type RelationshipTypeMapping 

type RelationshipTypeMapping struct {
	// REQUIRED; 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
}

RelationshipTypeMapping - Maps fields in Profile to their corresponding StrongIds in Related Profile.

func (RelationshipTypeMapping) MarshalJSON 

func (r RelationshipTypeMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipTypeMapping.

func (*RelationshipTypeMapping) UnmarshalJSON added in v1.1.0 

func (r *RelationshipTypeMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipTypeMapping.

type RelationshipsClient 

type RelationshipsClient struct {
	// contains filtered or unexported fields
}

RelationshipsClient contains the methods for the Relationships group. Don't use this type directly, use NewRelationshipsClient() instead.

func NewRelationshipsClient 

func NewRelationshipsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RelationshipsClient, error)

NewRelationshipsClient creates a new instance of RelationshipsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RelationshipsClient) BeginCreateOrUpdate 

func (client *RelationshipsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, relationshipName string, parameters RelationshipResourceFormat, options *RelationshipsClientBeginCreateOrUpdateOptions) (*runtime.Poller[RelationshipsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a relationship or updates an existing relationship within a hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - RelationshipsClientBeginCreateOrUpdateOptions contains the optional parameters for the RelationshipsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRelationshipsClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "SomeRelationship", armcustomerinsights.RelationshipResourceFormat{
		Properties: &armcustomerinsights.RelationshipDefinition{
			Description: map[string]*string{
				"en-us": to.Ptr("Relationship Description"),
			},
			Cardinality: to.Ptr(armcustomerinsights.CardinalityTypesOneToOne),
			DisplayName: map[string]*string{
				"en-us": to.Ptr("Relationship DisplayName"),
			},
			Fields:             []*armcustomerinsights.PropertyDefinition{},
			ProfileType:        to.Ptr("testProfile2326994"),
			RelatedProfileType: to.Ptr("testProfile2326994"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RelationshipResourceFormat = armcustomerinsights.RelationshipResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testProfile2326994"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/relationships"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationships/SomeRelationship"),
	// 	Properties: &armcustomerinsights.RelationshipDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Relationship Description"),
	// 		},
	// 		Cardinality: to.Ptr(armcustomerinsights.CardinalityTypesOneToOne),
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Relationship DisplayName"),
	// 		},
	// 		Fields: []*armcustomerinsights.PropertyDefinition{
	// 		},
	// 		LookupMappings: []*armcustomerinsights.RelationshipTypeMapping{
	// 		},
	// 		ProfileType: to.Ptr("testProfile2326994"),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		RelatedProfileType: to.Ptr("testProfile2326994"),
	// 		RelationshipName: to.Ptr("SomeRelationship"),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*RelationshipsClient) BeginDelete 

func (client *RelationshipsClient) BeginDelete(ctx context.Context, resourceGroupName string, hubName string, relationshipName string, options *RelationshipsClientBeginDeleteOptions) (*runtime.Poller[RelationshipsClientDeleteResponse], error)

BeginDelete - Deletes a relationship within a hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • relationshipName - The name of the relationship.
  • options - RelationshipsClientBeginDeleteOptions contains the optional parameters for the RelationshipsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRelationshipsClient().BeginDelete(ctx, "TestHubRG", "sdkTestHub", "SomeRelationship", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*RelationshipsClient) Get 

func (client *RelationshipsClient) Get(ctx context.Context, resourceGroupName string, hubName string, relationshipName string, options *RelationshipsClientGetOptions) (RelationshipsClientGetResponse, error)

Get - Gets information about the specified relationship. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • relationshipName - The name of the relationship.
  • options - RelationshipsClientGetOptions contains the optional parameters for the RelationshipsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRelationshipsClient().Get(ctx, "TestHubRG", "sdkTestHub", "SomeRelationship", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RelationshipResourceFormat = armcustomerinsights.RelationshipResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testProfile2326994"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/relationships"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationships/SomeRelationship"),
	// 	Properties: &armcustomerinsights.RelationshipDefinition{
	// 		Description: map[string]*string{
	// 			"en-us": to.Ptr("Relationship Description"),
	// 		},
	// 		Cardinality: to.Ptr(armcustomerinsights.CardinalityTypesOneToOne),
	// 		DisplayName: map[string]*string{
	// 			"en-us": to.Ptr("Relationship DisplayName"),
	// 		},
	// 		Fields: []*armcustomerinsights.PropertyDefinition{
	// 		},
	// 		LookupMappings: []*armcustomerinsights.RelationshipTypeMapping{
	// 		},
	// 		ProfileType: to.Ptr("testProfile2326994"),
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		RelatedProfileType: to.Ptr("testProfile2326994"),
	// 		RelationshipName: to.Ptr("SomeRelationship"),
	// 		TenantID: to.Ptr("sdktesthub"),
	// 	},
	// }
}

Output:

func (*RelationshipsClient) NewListByHubPager 

func (client *RelationshipsClient) NewListByHubPager(resourceGroupName string, hubName string, options *RelationshipsClientListByHubOptions) *runtime.Pager[RelationshipsClientListByHubResponse]

NewListByHubPager - Gets all relationships in the hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - RelationshipsClientListByHubOptions contains the optional parameters for the RelationshipsClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RelationshipsListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRelationshipsClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RelationshipListResult = armcustomerinsights.RelationshipListResult{
		// 	Value: []*armcustomerinsights.RelationshipResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/testProfile2326994"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/relationships"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationships/SomeRelationship"),
		// 			Properties: &armcustomerinsights.RelationshipDefinition{
		// 				Description: map[string]*string{
		// 					"en-us": to.Ptr("Relationship Description"),
		// 				},
		// 				Cardinality: to.Ptr(armcustomerinsights.CardinalityTypesOneToOne),
		// 				DisplayName: map[string]*string{
		// 					"en-us": to.Ptr("Relationship DisplayName"),
		// 				},
		// 				Fields: []*armcustomerinsights.PropertyDefinition{
		// 				},
		// 				LookupMappings: []*armcustomerinsights.RelationshipTypeMapping{
		// 				},
		// 				ProfileType: to.Ptr("testProfile2326994"),
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				RelatedProfileType: to.Ptr("testProfile2326994"),
		// 				RelationshipName: to.Ptr("SomeRelationship"),
		// 				TenantID: to.Ptr("sdktesthub"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type RelationshipsClientBeginCreateOrUpdateOptions 

type RelationshipsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RelationshipsClientBeginCreateOrUpdateOptions contains the optional parameters for the RelationshipsClient.BeginCreateOrUpdate method.

type RelationshipsClientBeginDeleteOptions 

type RelationshipsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RelationshipsClientBeginDeleteOptions contains the optional parameters for the RelationshipsClient.BeginDelete method.

type RelationshipsClientCreateOrUpdateResponse 

type RelationshipsClientCreateOrUpdateResponse struct {
	// The relationship resource format.
	RelationshipResourceFormat
}

RelationshipsClientCreateOrUpdateResponse contains the response from method RelationshipsClient.BeginCreateOrUpdate.

type RelationshipsClientDeleteResponse 

type RelationshipsClientDeleteResponse struct {
}

RelationshipsClientDeleteResponse contains the response from method RelationshipsClient.BeginDelete.

type RelationshipsClientGetOptions 

type RelationshipsClientGetOptions struct {
}

RelationshipsClientGetOptions contains the optional parameters for the RelationshipsClient.Get method.

type RelationshipsClientGetResponse 

type RelationshipsClientGetResponse struct {
	// The relationship resource format.
	RelationshipResourceFormat
}

RelationshipsClientGetResponse contains the response from method RelationshipsClient.Get.

type RelationshipsClientListByHubOptions 

type RelationshipsClientListByHubOptions struct {
}

RelationshipsClientListByHubOptions contains the optional parameters for the RelationshipsClient.NewListByHubPager method.

type RelationshipsClientListByHubResponse 

type RelationshipsClientListByHubResponse struct {
	// The response of list relationship operation.
	RelationshipListResult
}

RelationshipsClientListByHubResponse contains the response from method RelationshipsClient.NewListByHubPager.

type RelationshipsLookup 

type RelationshipsLookup struct {
	// READ-ONLY; The name of existing Relationship.
	ExistingRelationshipName *string

	// READ-ONLY; The relationship profile.
	ProfileName *string

	// READ-ONLY; The property references for the profile type.
	ProfilePropertyReferences []*ParticipantProfilePropertyReference

	// READ-ONLY; The related profile.
	RelatedProfileName *string

	// READ-ONLY; The property references for the related profile type.
	RelatedProfilePropertyReferences []*ParticipantProfilePropertyReference
}

RelationshipsLookup - The definition of suggested relationship for the type.

func (RelationshipsLookup) MarshalJSON added in v1.1.0 

func (r RelationshipsLookup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RelationshipsLookup.

func (*RelationshipsLookup) UnmarshalJSON added in v1.1.0 

func (r *RelationshipsLookup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RelationshipsLookup.

type Resource 

type Resource struct {
	// Resource location.
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

Resource - Common properties of Azure resource.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v1.1.0 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceSetDescription 

type ResourceSetDescription struct {
	// The elements included in the set.
	Elements []*string

	// The elements that are not included in the set, in case elements contains '*' indicating 'all'.
	Exceptions []*string
}

ResourceSetDescription - The resource set description.

func (ResourceSetDescription) MarshalJSON 

func (r ResourceSetDescription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSetDescription.

func (*ResourceSetDescription) UnmarshalJSON added in v1.1.0 

func (r *ResourceSetDescription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSetDescription.

type Role 

type Role struct {
	// The description of the role.
	Description *string

	// The role name.
	RoleName *string
}

Role - The Role definition.

func (Role) MarshalJSON added in v1.1.0 

func (r Role) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Role.

func (*Role) UnmarshalJSON added in v1.1.0 

func (r *Role) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Role.

type RoleAssignment 

type RoleAssignment struct {
	// REQUIRED; The principals being assigned to.
	Principals []*AssignmentPrincipal

	// REQUIRED; Type of roles.
	Role *RoleTypes

	// Widget types set for the assignment.
	ConflationPolicies *ResourceSetDescription

	// Connectors set for the assignment.
	Connectors *ResourceSetDescription

	// Localized description for the metadata.
	Description map[string]*string

	// Localized display names for the metadata.
	DisplayName map[string]*string

	// Interactions set for the assignment.
	Interactions *ResourceSetDescription

	// Kpis set for the assignment.
	Kpis *ResourceSetDescription

	// Links set for the assignment.
	Links *ResourceSetDescription

	// Profiles set for the assignment.
	Profiles *ResourceSetDescription

	// The Role assignments set for the relationship links.
	RelationshipLinks *ResourceSetDescription

	// The Role assignments set for the relationships.
	Relationships *ResourceSetDescription

	// The Role assignments set for the assignment.
	RoleAssignments *ResourceSetDescription

	// Sas Policies set for the assignment.
	SasPolicies *ResourceSetDescription

	// The Role assignments set for the assignment.
	Segments *ResourceSetDescription

	// Views set for the assignment.
	Views *ResourceSetDescription

	// Widget types set for the assignment.
	WidgetTypes *ResourceSetDescription

	// READ-ONLY; The name of the metadata object.
	AssignmentName *string

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningStates

	// READ-ONLY; The hub name.
	TenantID *string
}

RoleAssignment - The Role Assignment definition.

func (RoleAssignment) MarshalJSON 

func (r RoleAssignment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleAssignment.

func (*RoleAssignment) UnmarshalJSON added in v1.1.0 

func (r *RoleAssignment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignment.

type RoleAssignmentListResult 

type RoleAssignmentListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*RoleAssignmentResourceFormat
}

RoleAssignmentListResult - The response of list role assignment operation.

func (RoleAssignmentListResult) MarshalJSON added in v1.1.0 

func (r RoleAssignmentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentListResult.

func (*RoleAssignmentListResult) UnmarshalJSON added in v1.1.0 

func (r *RoleAssignmentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentListResult.

type RoleAssignmentResourceFormat 

type RoleAssignmentResourceFormat struct {
	// The Role Assignment definition.
	Properties *RoleAssignment

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

RoleAssignmentResourceFormat - The Role Assignment resource format.

func (RoleAssignmentResourceFormat) MarshalJSON added in v1.1.0 

func (r RoleAssignmentResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentResourceFormat.

func (*RoleAssignmentResourceFormat) UnmarshalJSON added in v1.1.0 

func (r *RoleAssignmentResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentResourceFormat.

type RoleAssignmentsClient 

type RoleAssignmentsClient struct {
	// contains filtered or unexported fields
}

RoleAssignmentsClient contains the methods for the RoleAssignments group. Don't use this type directly, use NewRoleAssignmentsClient() instead.

func NewRoleAssignmentsClient 

func NewRoleAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RoleAssignmentsClient, error)

NewRoleAssignmentsClient creates a new instance of RoleAssignmentsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RoleAssignmentsClient) BeginCreateOrUpdate 

func (client *RoleAssignmentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, assignmentName string, parameters RoleAssignmentResourceFormat, options *RoleAssignmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[RoleAssignmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a role assignment in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • 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.
  • options - RoleAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the RoleAssignmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RoleAssignmentsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRoleAssignmentsClient().BeginCreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "assignmentName8976", armcustomerinsights.RoleAssignmentResourceFormat{
		Properties: &armcustomerinsights.RoleAssignment{
			Principals: []*armcustomerinsights.AssignmentPrincipal{
				{
					PrincipalID:   to.Ptr("4c54c38ffa9b416ba5a6d6c8a20cbe7e"),
					PrincipalType: to.Ptr("User"),
				},
				{
					PrincipalID:   to.Ptr("93061d15a5054f2b9948ae25724cf9d5"),
					PrincipalType: to.Ptr("User"),
				}},
			Role: to.Ptr(armcustomerinsights.RoleTypesAdmin),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RoleAssignmentResourceFormat = armcustomerinsights.RoleAssignmentResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/assignmentName8976"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/RoleAssignments"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/RoleAssignments/assignmentName8976"),
	// 	Properties: &armcustomerinsights.RoleAssignment{
	// 		AssignmentName: to.Ptr("assignmentName8976"),
	// 		Principals: []*armcustomerinsights.AssignmentPrincipal{
	// 			{
	// 				PrincipalID: to.Ptr("4c54c38f-fa9b-416b-a5a6-d6c8a20cbe7e"),
	// 				PrincipalType: to.Ptr("User"),
	// 			},
	// 			{
	// 				PrincipalID: to.Ptr("93061d15-a505-4f2b-9948-ae25724cf9d5"),
	// 				PrincipalType: to.Ptr("User"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		Role: to.Ptr(armcustomerinsights.RoleTypesAdmin),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 	},
	// }
}

Output:

func (*RoleAssignmentsClient) Delete 

func (client *RoleAssignmentsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, assignmentName string, options *RoleAssignmentsClientDeleteOptions) (RoleAssignmentsClientDeleteResponse, error)

Delete - Deletes the role assignment in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • assignmentName - The name of the role assignment.
  • options - RoleAssignmentsClientDeleteOptions contains the optional parameters for the RoleAssignmentsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RoleAssignmentsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewRoleAssignmentsClient().Delete(ctx, "TestHubRG", "sdkTestHub", "assignmentName8976", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*RoleAssignmentsClient) Get 

func (client *RoleAssignmentsClient) Get(ctx context.Context, resourceGroupName string, hubName string, assignmentName string, options *RoleAssignmentsClientGetOptions) (RoleAssignmentsClientGetResponse, error)

Get - Gets the role assignment in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • assignmentName - The name of the role assignment.
  • options - RoleAssignmentsClientGetOptions contains the optional parameters for the RoleAssignmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RoleAssignmentsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRoleAssignmentsClient().Get(ctx, "TestHubRG", "sdkTestHub", "assignmentName8976", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RoleAssignmentResourceFormat = armcustomerinsights.RoleAssignmentResourceFormat{
	// 	Name: to.Ptr("azSdkTestHub/assignmentName8976"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/RoleAssignments"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/RoleAssignments/assignmentName8976"),
	// 	Properties: &armcustomerinsights.RoleAssignment{
	// 		AssignmentName: to.Ptr("assignmentName8976"),
	// 		Principals: []*armcustomerinsights.AssignmentPrincipal{
	// 			{
	// 				PrincipalID: to.Ptr("4c54c38f-fa9b-416b-a5a6-d6c8a20cbe7e"),
	// 				PrincipalType: to.Ptr("User"),
	// 			},
	// 			{
	// 				PrincipalID: to.Ptr("93061d15-a505-4f2b-9948-ae25724cf9d5"),
	// 				PrincipalType: to.Ptr("User"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
	// 		Role: to.Ptr(armcustomerinsights.RoleTypesAdmin),
	// 		TenantID: to.Ptr("azsdktesthub"),
	// 	},
	// }
}

Output:

func (*RoleAssignmentsClient) NewListByHubPager 

func (client *RoleAssignmentsClient) NewListByHubPager(resourceGroupName string, hubName string, options *RoleAssignmentsClientListByHubOptions) *runtime.Pager[RoleAssignmentsClientListByHubResponse]

NewListByHubPager - Gets all the role assignments for the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - RoleAssignmentsClientListByHubOptions contains the optional parameters for the RoleAssignmentsClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RoleAssignmentsListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRoleAssignmentsClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RoleAssignmentListResult = armcustomerinsights.RoleAssignmentListResult{
		// 	Value: []*armcustomerinsights.RoleAssignmentResourceFormat{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub/assignmentName8976"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/RoleAssignments"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/RoleAssignments/assignmentName8976"),
		// 			Properties: &armcustomerinsights.RoleAssignment{
		// 				AssignmentName: to.Ptr("assignmentName8976"),
		// 				Principals: []*armcustomerinsights.AssignmentPrincipal{
		// 					{
		// 						PrincipalID: to.Ptr("4c54c38f-fa9b-416b-a5a6-d6c8a20cbe7e"),
		// 						PrincipalType: to.Ptr("User"),
		// 					},
		// 					{
		// 						PrincipalID: to.Ptr("93061d15-a505-4f2b-9948-ae25724cf9d5"),
		// 						PrincipalType: to.Ptr("User"),
		// 				}},
		// 				ProvisioningState: to.Ptr(armcustomerinsights.ProvisioningStatesSucceeded),
		// 				Role: to.Ptr(armcustomerinsights.RoleTypesAdmin),
		// 				TenantID: to.Ptr("azsdktesthub"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type RoleAssignmentsClientBeginCreateOrUpdateOptions 

type RoleAssignmentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RoleAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the RoleAssignmentsClient.BeginCreateOrUpdate method.

type RoleAssignmentsClientCreateOrUpdateResponse 

type RoleAssignmentsClientCreateOrUpdateResponse struct {
	// The Role Assignment resource format.
	RoleAssignmentResourceFormat
}

RoleAssignmentsClientCreateOrUpdateResponse contains the response from method RoleAssignmentsClient.BeginCreateOrUpdate.

type RoleAssignmentsClientDeleteOptions 

type RoleAssignmentsClientDeleteOptions struct {
}

RoleAssignmentsClientDeleteOptions contains the optional parameters for the RoleAssignmentsClient.Delete method.

type RoleAssignmentsClientDeleteResponse 

type RoleAssignmentsClientDeleteResponse struct {
}

RoleAssignmentsClientDeleteResponse contains the response from method RoleAssignmentsClient.Delete.

type RoleAssignmentsClientGetOptions 

type RoleAssignmentsClientGetOptions struct {
}

RoleAssignmentsClientGetOptions contains the optional parameters for the RoleAssignmentsClient.Get method.

type RoleAssignmentsClientGetResponse 

type RoleAssignmentsClientGetResponse struct {
	// The Role Assignment resource format.
	RoleAssignmentResourceFormat
}

RoleAssignmentsClientGetResponse contains the response from method RoleAssignmentsClient.Get.

type RoleAssignmentsClientListByHubOptions 

type RoleAssignmentsClientListByHubOptions struct {
}

RoleAssignmentsClientListByHubOptions contains the optional parameters for the RoleAssignmentsClient.NewListByHubPager method.

type RoleAssignmentsClientListByHubResponse 

type RoleAssignmentsClientListByHubResponse struct {
	// The response of list role assignment operation.
	RoleAssignmentListResult
}

RoleAssignmentsClientListByHubResponse contains the response from method RoleAssignmentsClient.NewListByHubPager.

type RoleListResult 

type RoleListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*RoleResourceFormat
}

RoleListResult - The response of list role assignment operation.

func (RoleListResult) MarshalJSON added in v1.1.0 

func (r RoleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleListResult.

func (*RoleListResult) UnmarshalJSON added in v1.1.0 

func (r *RoleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleListResult.

type RoleResourceFormat 

type RoleResourceFormat struct {
	// The Role definition.
	Properties *Role

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

RoleResourceFormat - The role resource format.

func (RoleResourceFormat) MarshalJSON added in v1.1.0 

func (r RoleResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoleResourceFormat.

func (*RoleResourceFormat) UnmarshalJSON added in v1.1.0 

func (r *RoleResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleResourceFormat.

type RoleTypes 

type RoleTypes string

RoleTypes - Type of roles. 

const (
	RoleTypesAdmin        RoleTypes = "Admin"
	RoleTypesDataAdmin    RoleTypes = "DataAdmin"
	RoleTypesDataReader   RoleTypes = "DataReader"
	RoleTypesManageAdmin  RoleTypes = "ManageAdmin"
	RoleTypesManageReader RoleTypes = "ManageReader"
	RoleTypesReader       RoleTypes = "Reader"
)

func PossibleRoleTypesValues 

func PossibleRoleTypesValues() []RoleTypes

PossibleRoleTypesValues returns the possible values for the RoleTypes const type.

type RolesClient 

type RolesClient struct {
	// contains filtered or unexported fields
}

RolesClient contains the methods for the Roles group. Don't use this type directly, use NewRolesClient() instead.

func NewRolesClient 

func NewRolesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RolesClient, error)

NewRolesClient creates a new instance of RolesClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RolesClient) NewListByHubPager 

func (client *RolesClient) NewListByHubPager(resourceGroupName string, hubName string, options *RolesClientListByHubOptions) *runtime.Pager[RolesClientListByHubResponse]

NewListByHubPager - Gets all the roles for the hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - RolesClientListByHubOptions contains the optional parameters for the RolesClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/RolesListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRolesClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RoleListResult = armcustomerinsights.RoleListResult{
		// 	Value: []*armcustomerinsights.RoleResourceFormat{
		// 		{
		// 			Name: to.Ptr("azSdkTestHub/Admin"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/Roles"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/azSdkTestHub/Roles/Admin"),
		// 			Properties: &armcustomerinsights.Role{
		// 				Description: to.Ptr("When a role assignment is created for the Admin Role on certain scopes (selected profiles, interactions, Kpis etc.), it authorizes the users/groups selected in the assignment for ALL operations at the tenant endpoint on the selected scopes."),
		// 				RoleName: to.Ptr("Admin"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type RolesClientListByHubOptions 

type RolesClientListByHubOptions struct {
}

RolesClientListByHubOptions contains the optional parameters for the RolesClient.NewListByHubPager method.

type RolesClientListByHubResponse 

type RolesClientListByHubResponse struct {
	// The response of list role assignment operation.
	RoleListResult
}

RolesClientListByHubResponse contains the response from method RolesClient.NewListByHubPager.

type SalesforceConnectorProperties 

type SalesforceConnectorProperties struct {
	// REQUIRED; The Salesforce tables.
	Salesforcetables []*SalesforceTable

	// REQUIRED; The user settings.
	Usersetting *SalesforceDiscoverSetting
}

SalesforceConnectorProperties - The Salesforce connector properties.

func (SalesforceConnectorProperties) MarshalJSON added in v1.1.0 

func (s SalesforceConnectorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SalesforceConnectorProperties.

func (*SalesforceConnectorProperties) UnmarshalJSON added in v1.1.0 

func (s *SalesforceConnectorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SalesforceConnectorProperties.

type SalesforceDiscoverSetting 

type SalesforceDiscoverSetting struct {
	// REQUIRED; The salesforce connection string secret URL.
	SalesforceConnectionStringSecretURL *string
}

SalesforceDiscoverSetting - Salesforce discover setting.

func (SalesforceDiscoverSetting) MarshalJSON added in v1.1.0 

func (s SalesforceDiscoverSetting) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SalesforceDiscoverSetting.

func (*SalesforceDiscoverSetting) UnmarshalJSON added in v1.1.0 

func (s *SalesforceDiscoverSetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SalesforceDiscoverSetting.

type SalesforceTable 

type SalesforceTable struct {
	// REQUIRED; The table category.
	TableCategory *string

	// REQUIRED; The name of the table.
	TableName *string

	// REQUIRED; The table schema.
	TableSchema *string

	// Indicating whether this instance is profile.
	IsProfile *string

	// The table remarks.
	TableRemarks *string
}

SalesforceTable - Salesforce table.

func (SalesforceTable) MarshalJSON added in v1.1.0 

func (s SalesforceTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SalesforceTable.

func (*SalesforceTable) UnmarshalJSON added in v1.1.0 

func (s *SalesforceTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SalesforceTable.

type Status 

type Status string

Status - The data source status. 

const (
	StatusActive  Status = "Active"
	StatusDeleted Status = "Deleted"
	StatusNone    Status = "None"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type StrongID 

type StrongID struct {
	// REQUIRED; The properties which make up the unique ID.
	KeyPropertyNames []*string

	// REQUIRED; The Name identifying the strong ID.
	StrongIDName *string

	// Localized descriptions.
	Description map[string]*string

	// Localized display name.
	DisplayName map[string]*string
}

StrongID - Property/Properties which represent a unique ID.

func (StrongID) MarshalJSON 

func (s StrongID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StrongID.

func (*StrongID) UnmarshalJSON added in v1.1.0 

func (s *StrongID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StrongID.

type SuggestRelationshipLinksResponse 

type SuggestRelationshipLinksResponse struct {
	// READ-ONLY; The interaction name.
	InteractionName *string

	// READ-ONLY; Suggested relationships for the type.
	SuggestedRelationships []*RelationshipsLookup
}

SuggestRelationshipLinksResponse - The response of suggest relationship links operation.

func (SuggestRelationshipLinksResponse) MarshalJSON added in v1.1.0 

func (s SuggestRelationshipLinksResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SuggestRelationshipLinksResponse.

func (*SuggestRelationshipLinksResponse) UnmarshalJSON added in v1.1.0 

func (s *SuggestRelationshipLinksResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SuggestRelationshipLinksResponse.

type TypePropertiesMapping 

type TypePropertiesMapping struct {
	// REQUIRED; Property name on the source Entity Type.
	SourcePropertyName *string

	// REQUIRED; Property name on the target Entity Type.
	TargetPropertyName *string

	// Link type.
	LinkType *LinkTypes
}

TypePropertiesMapping - Metadata for a Link's property mapping.

func (TypePropertiesMapping) MarshalJSON added in v1.1.0 

func (t TypePropertiesMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TypePropertiesMapping.

func (*TypePropertiesMapping) UnmarshalJSON added in v1.1.0 

func (t *TypePropertiesMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TypePropertiesMapping.

type View 

type View struct {
	// REQUIRED; View definition.
	Definition *string

	// Localized display name for the view.
	DisplayName map[string]*string

	// the user ID.
	UserID *string

	// READ-ONLY; Date time when view was last modified.
	Changed *time.Time

	// READ-ONLY; Date time when view was created.
	Created *time.Time

	// READ-ONLY; the hub name.
	TenantID *string

	// READ-ONLY; Name of the view.
	ViewName *string
}

View - The view in Customer 360 web application.

func (View) MarshalJSON 

func (v View) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type View.

func (*View) UnmarshalJSON 

func (v *View) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type View.

type ViewListResult 

type ViewListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*ViewResourceFormat
}

ViewListResult - The response of list view operation.

func (ViewListResult) MarshalJSON added in v1.1.0 

func (v ViewListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ViewListResult.

func (*ViewListResult) UnmarshalJSON added in v1.1.0 

func (v *ViewListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ViewListResult.

type ViewResourceFormat 

type ViewResourceFormat struct {
	// The view in Customer 360 web application.
	Properties *View

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

ViewResourceFormat - The view resource format.

func (ViewResourceFormat) MarshalJSON added in v1.1.0 

func (v ViewResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ViewResourceFormat.

func (*ViewResourceFormat) UnmarshalJSON added in v1.1.0 

func (v *ViewResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ViewResourceFormat.

type ViewsClient 

type ViewsClient struct {
	// contains filtered or unexported fields
}

ViewsClient contains the methods for the Views group. Don't use this type directly, use NewViewsClient() instead.

func NewViewsClient 

func NewViewsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ViewsClient, error)

NewViewsClient creates a new instance of ViewsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ViewsClient) CreateOrUpdate 

func (client *ViewsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hubName string, viewName string, parameters ViewResourceFormat, options *ViewsClientCreateOrUpdateOptions) (ViewsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a view or updates an existing view in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • viewName - The name of the view.
  • parameters - Parameters supplied to the CreateOrUpdate View operation.
  • options - ViewsClientCreateOrUpdateOptions contains the optional parameters for the ViewsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ViewsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewViewsClient().CreateOrUpdate(ctx, "TestHubRG", "sdkTestHub", "testView", armcustomerinsights.ViewResourceFormat{
		Properties: &armcustomerinsights.View{
			Definition: to.Ptr("{\\\"isProfileType\\\":false,\\\"profileTypes\\\":[],\\\"widgets\\\":[],\\\"style\\\":[]}"),
			DisplayName: map[string]*string{
				"en": to.Ptr("some name"),
			},
			UserID: to.Ptr("testUser"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ViewResourceFormat = armcustomerinsights.ViewResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testView"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/views"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/views/testView"),
	// 	Properties: &armcustomerinsights.View{
	// 		Definition: to.Ptr("{\\\"isProfileType\\\":false,\\\"profileTypes\\\":[],\\\"widgets\\\":[],\\\"style\\\":[]}"),
	// 		DisplayName: map[string]*string{
	// 			"en": to.Ptr("some name"),
	// 		},
	// 		TenantID: to.Ptr("sdktesthub"),
	// 		UserID: to.Ptr("*"),
	// 		ViewName: to.Ptr("testView"),
	// 	},
	// }
}

Output:

func (*ViewsClient) Delete 

func (client *ViewsClient) Delete(ctx context.Context, resourceGroupName string, hubName string, viewName string, userID string, options *ViewsClientDeleteOptions) (ViewsClientDeleteResponse, error)

Delete - Deletes a view in the specified hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • viewName - The name of the view.
  • userID - The user ID. Use * to retrieve hub level view.
  • options - ViewsClientDeleteOptions contains the optional parameters for the ViewsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ViewsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewViewsClient().Delete(ctx, "TestHubRG", "sdkTestHub", "testView", "*", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ViewsClient) Get 

func (client *ViewsClient) Get(ctx context.Context, resourceGroupName string, hubName string, viewName string, userID string, options *ViewsClientGetOptions) (ViewsClientGetResponse, error)

Get - Gets a view in the hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • viewName - The name of the view.
  • userID - The user ID. Use * to retrieve hub level view.
  • options - ViewsClientGetOptions contains the optional parameters for the ViewsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ViewsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewViewsClient().Get(ctx, "TestHubRG", "sdkTestHub", "testView", "*", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ViewResourceFormat = armcustomerinsights.ViewResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/testView"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/views"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/views/testView"),
	// 	Properties: &armcustomerinsights.View{
	// 		Definition: to.Ptr("{\\\"isProfileType\\\":false,\\\"profileTypes\\\":[],\\\"widgets\\\":[],\\\"style\\\":[]}"),
	// 		DisplayName: map[string]*string{
	// 			"en": to.Ptr("some name"),
	// 		},
	// 		TenantID: to.Ptr("sdktesthub"),
	// 		UserID: to.Ptr("*"),
	// 		ViewName: to.Ptr("testView"),
	// 	},
	// }
}

Output:

func (*ViewsClient) NewListByHubPager 

func (client *ViewsClient) NewListByHubPager(resourceGroupName string, hubName string, userID string, options *ViewsClientListByHubOptions) *runtime.Pager[ViewsClientListByHubResponse]

NewListByHubPager - Gets all available views for given user in the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • userID - The user ID. Use * to retrieve hub level views.
  • options - ViewsClientListByHubOptions contains the optional parameters for the ViewsClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/ViewsListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewViewsClient().NewListByHubPager("TestHubRG", "sdkTestHub", "*", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ViewListResult = armcustomerinsights.ViewListResult{
		// 	Value: []*armcustomerinsights.ViewResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/testView"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/views"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/views/testView"),
		// 			Properties: &armcustomerinsights.View{
		// 				Definition: to.Ptr("{\\\"isProfileType\\\":false,\\\"profileTypes\\\":[],\\\"widgets\\\":[],\\\"style\\\":[]}"),
		// 				DisplayName: map[string]*string{
		// 					"en": to.Ptr("some name"),
		// 				},
		// 				TenantID: to.Ptr("sdktesthub"),
		// 				UserID: to.Ptr("*"),
		// 				ViewName: to.Ptr("testView"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type ViewsClientCreateOrUpdateOptions 

type ViewsClientCreateOrUpdateOptions struct {
}

ViewsClientCreateOrUpdateOptions contains the optional parameters for the ViewsClient.CreateOrUpdate method.

type ViewsClientCreateOrUpdateResponse 

type ViewsClientCreateOrUpdateResponse struct {
	// The view resource format.
	ViewResourceFormat
}

ViewsClientCreateOrUpdateResponse contains the response from method ViewsClient.CreateOrUpdate.

type ViewsClientDeleteOptions 

type ViewsClientDeleteOptions struct {
}

ViewsClientDeleteOptions contains the optional parameters for the ViewsClient.Delete method.

type ViewsClientDeleteResponse 

type ViewsClientDeleteResponse struct {
}

ViewsClientDeleteResponse contains the response from method ViewsClient.Delete.

type ViewsClientGetOptions 

type ViewsClientGetOptions struct {
}

ViewsClientGetOptions contains the optional parameters for the ViewsClient.Get method.

type ViewsClientGetResponse 

type ViewsClientGetResponse struct {
	// The view resource format.
	ViewResourceFormat
}

ViewsClientGetResponse contains the response from method ViewsClient.Get.

type ViewsClientListByHubOptions 

type ViewsClientListByHubOptions struct {
}

ViewsClientListByHubOptions contains the optional parameters for the ViewsClient.NewListByHubPager method.

type ViewsClientListByHubResponse 

type ViewsClientListByHubResponse struct {
	// The response of list view operation.
	ViewListResult
}

ViewsClientListByHubResponse contains the response from method ViewsClient.NewListByHubPager.

type WidgetType 

type WidgetType struct {
	// REQUIRED; Definition for widget type.
	Definition *string

	// Description for widget type.
	Description *string

	// Localized display name for the widget type.
	DisplayName map[string]*string

	// The image URL.
	ImageURL *string

	// The widget version.
	WidgetVersion *string

	// READ-ONLY; Date time when widget type was last modified.
	Changed *time.Time

	// READ-ONLY; Date time when widget type was created.
	Created *time.Time

	// READ-ONLY; The hub name.
	TenantID *string

	// READ-ONLY; Name of the widget type.
	WidgetTypeName *string
}

WidgetType - Definition of WidgetType.

func (WidgetType) MarshalJSON 

func (w WidgetType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WidgetType.

func (*WidgetType) UnmarshalJSON 

func (w *WidgetType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WidgetType.

type WidgetTypeListResult 

type WidgetTypeListResult struct {
	// Link to the next set of results.
	NextLink *string

	// Results of the list operation.
	Value []*WidgetTypeResourceFormat
}

WidgetTypeListResult - The response of list widget type operation.

func (WidgetTypeListResult) MarshalJSON added in v1.1.0 

func (w WidgetTypeListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WidgetTypeListResult.

func (*WidgetTypeListResult) UnmarshalJSON added in v1.1.0 

func (w *WidgetTypeListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WidgetTypeListResult.

type WidgetTypeResourceFormat 

type WidgetTypeResourceFormat struct {
	// Definition of WidgetType.
	Properties *WidgetType

	// READ-ONLY; Resource ID.
	ID *string

	// READ-ONLY; Resource name.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

WidgetTypeResourceFormat - The WidgetTypeResourceFormat

func (WidgetTypeResourceFormat) MarshalJSON added in v1.1.0 

func (w WidgetTypeResourceFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WidgetTypeResourceFormat.

func (*WidgetTypeResourceFormat) UnmarshalJSON added in v1.1.0 

func (w *WidgetTypeResourceFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WidgetTypeResourceFormat.

type WidgetTypesClient 

type WidgetTypesClient struct {
	// contains filtered or unexported fields
}

WidgetTypesClient contains the methods for the WidgetTypes group. Don't use this type directly, use NewWidgetTypesClient() instead.

func NewWidgetTypesClient 

func NewWidgetTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WidgetTypesClient, error)

NewWidgetTypesClient creates a new instance of WidgetTypesClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WidgetTypesClient) Get 

func (client *WidgetTypesClient) Get(ctx context.Context, resourceGroupName string, hubName string, widgetTypeName string, options *WidgetTypesClientGetOptions) (WidgetTypesClientGetResponse, error)

Get - Gets a widget type in the specified hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • widgetTypeName - The name of the widget type.
  • options - WidgetTypesClientGetOptions contains the optional parameters for the WidgetTypesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/WidgetTypesGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWidgetTypesClient().Get(ctx, "TestHubRG", "sdkTestHub", "ActivityGauge", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WidgetTypeResourceFormat = armcustomerinsights.WidgetTypeResourceFormat{
	// 	Name: to.Ptr("sdkTestHub/ActivityGauge"),
	// 	Type: to.Ptr("Microsoft.CustomerInsights/hubs/widgetTypes"),
	// 	ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/widgetTypes/ActivityGauge"),
	// 	Properties: &armcustomerinsights.WidgetType{
	// 		Description: to.Ptr(""),
	// 		Definition: to.Ptr(""),
	// 		ImageURL: to.Ptr(""),
	// 		TenantID: to.Ptr("*"),
	// 		WidgetTypeName: to.Ptr("ActivityGauge"),
	// 		WidgetVersion: to.Ptr("2016-01-01"),
	// 	},
	// }
}

Output:

func (*WidgetTypesClient) NewListByHubPager 

func (client *WidgetTypesClient) NewListByHubPager(resourceGroupName string, hubName string, options *WidgetTypesClientListByHubOptions) *runtime.Pager[WidgetTypesClientListByHubResponse]

NewListByHubPager - Gets all available widget types in the specified hub.

Generated from API version 2017-04-26

  • resourceGroupName - The name of the resource group.
  • hubName - The name of the hub.
  • options - WidgetTypesClientListByHubOptions contains the optional parameters for the WidgetTypesClient.NewListByHubPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/examples/WidgetTypesListByHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customerinsights/armcustomerinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomerinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWidgetTypesClient().NewListByHubPager("TestHubRG", "sdkTestHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WidgetTypeListResult = armcustomerinsights.WidgetTypeListResult{
		// 	Value: []*armcustomerinsights.WidgetTypeResourceFormat{
		// 		{
		// 			Name: to.Ptr("sdkTestHub/ActivityGauge"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/widgetTypes"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/widgetTypes/ActivityGauge"),
		// 			Properties: &armcustomerinsights.WidgetType{
		// 				Description: to.Ptr(""),
		// 				Definition: to.Ptr(""),
		// 				ImageURL: to.Ptr(""),
		// 				TenantID: to.Ptr("*"),
		// 				WidgetTypeName: to.Ptr("ActivityGauge"),
		// 				WidgetVersion: to.Ptr("2016-01-01"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sdkTestHub/AsterChart"),
		// 			Type: to.Ptr("Microsoft.CustomerInsights/hubs/widgetTypes"),
		// 			ID: to.Ptr("/subscriptions/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/widgetTypes/AsterChart"),
		// 			Properties: &armcustomerinsights.WidgetType{
		// 				Description: to.Ptr(""),
		// 				Definition: to.Ptr(""),
		// 				ImageURL: to.Ptr(""),
		// 				TenantID: to.Ptr("*"),
		// 				WidgetTypeName: to.Ptr("AsterChart"),
		// 				WidgetVersion: to.Ptr("2016-01-01"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WidgetTypesClientGetOptions 

type WidgetTypesClientGetOptions struct {
}

WidgetTypesClientGetOptions contains the optional parameters for the WidgetTypesClient.Get method.

type WidgetTypesClientGetResponse 

type WidgetTypesClientGetResponse struct {
	// The WidgetTypeResourceFormat
	WidgetTypeResourceFormat
}

WidgetTypesClientGetResponse contains the response from method WidgetTypesClient.Get.

type WidgetTypesClientListByHubOptions 

type WidgetTypesClientListByHubOptions struct {
}

WidgetTypesClientListByHubOptions contains the optional parameters for the WidgetTypesClient.NewListByHubPager method.

type WidgetTypesClientListByHubResponse 

type WidgetTypesClientListByHubResponse struct {
	// The response of list widget type operation.
	WidgetTypeListResult
}

WidgetTypesClientListByHubResponse contains the response from method WidgetTypesClient.NewListByHubPager.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.