1. Packages
  2. Azure Native
  3. API Docs
  4. customerinsights
  5. Connector
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.customerinsights.Connector

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.46.0 published on Friday, Jun 21, 2024 by Pulumi

    The connector resource format. Azure REST API version: 2017-04-26. Prior API version in Azure Native 1.x: 2017-04-26.

    Example Usage

    Connectors_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var connector = new AzureNative.CustomerInsights.Connector("connector", new()
        {
            ConnectorName = "testConnector",
            ConnectorProperties = 
            {
                { "connectionKeyVaultUrl", new Dictionary<string, object?>
                {
                    ["organizationId"] = "XXX",
                    ["organizationUrl"] = "https://XXX.crmlivetie.com/",
                } },
            },
            ConnectorType = AzureNative.CustomerInsights.ConnectorTypes.AzureBlob,
            Description = "Test connector",
            DisplayName = "testConnector",
            HubName = "sdkTestHub",
            ResourceGroupName = "TestHubRG",
        });
    
    });
    
    package main
    
    import (
    	customerinsights "github.com/pulumi/pulumi-azure-native-sdk/customerinsights/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := customerinsights.NewConnector(ctx, "connector", &customerinsights.ConnectorArgs{
    			ConnectorName: pulumi.String("testConnector"),
    			ConnectorProperties: pulumi.Map{
    				"connectionKeyVaultUrl": pulumi.Any(map[string]interface{}{
    					"organizationId":  "XXX",
    					"organizationUrl": "https://XXX.crmlivetie.com/",
    				}),
    			},
    			ConnectorType:     pulumi.String(customerinsights.ConnectorTypesAzureBlob),
    			Description:       pulumi.String("Test connector"),
    			DisplayName:       pulumi.String("testConnector"),
    			HubName:           pulumi.String("sdkTestHub"),
    			ResourceGroupName: pulumi.String("TestHubRG"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.customerinsights.Connector;
    import com.pulumi.azurenative.customerinsights.ConnectorArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var connector = new Connector("connector", ConnectorArgs.builder()
                .connectorName("testConnector")
                .connectorProperties(Map.of("connectionKeyVaultUrl", Map.ofEntries(
                    Map.entry("organizationId", "XXX"),
                    Map.entry("organizationUrl", "https://XXX.crmlivetie.com/")
                )))
                .connectorType("AzureBlob")
                .description("Test connector")
                .displayName("testConnector")
                .hubName("sdkTestHub")
                .resourceGroupName("TestHubRG")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    connector = azure_native.customerinsights.Connector("connector",
        connector_name="testConnector",
        connector_properties={
            "connectionKeyVaultUrl": {
                "organizationId": "XXX",
                "organizationUrl": "https://XXX.crmlivetie.com/",
            },
        },
        connector_type=azure_native.customerinsights.ConnectorTypes.AZURE_BLOB,
        description="Test connector",
        display_name="testConnector",
        hub_name="sdkTestHub",
        resource_group_name="TestHubRG")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const connector = new azure_native.customerinsights.Connector("connector", {
        connectorName: "testConnector",
        connectorProperties: {
            connectionKeyVaultUrl: {
                organizationId: "XXX",
                organizationUrl: "https://XXX.crmlivetie.com/",
            },
        },
        connectorType: azure_native.customerinsights.ConnectorTypes.AzureBlob,
        description: "Test connector",
        displayName: "testConnector",
        hubName: "sdkTestHub",
        resourceGroupName: "TestHubRG",
    });
    
    resources:
      connector:
        type: azure-native:customerinsights:Connector
        properties:
          connectorName: testConnector
          connectorProperties:
            connectionKeyVaultUrl:
              organizationId: XXX
              organizationUrl: https://XXX.crmlivetie.com/
          connectorType: AzureBlob
          description: Test connector
          displayName: testConnector
          hubName: sdkTestHub
          resourceGroupName: TestHubRG
    

    Create Connector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def Connector(resource_name: str,
                  args: ConnectorArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connector(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  connector_properties: Optional[Mapping[str, Any]] = None,
                  connector_type: Optional[Union[str, ConnectorTypes]] = None,
                  hub_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  connector_name: Optional[str] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  is_internal: Optional[bool] = None)
    func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
    public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
    public Connector(String name, ConnectorArgs args)
    public Connector(String name, ConnectorArgs args, CustomResourceOptions options)
    
    type: azure-native:customerinsights:Connector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var azure_nativeConnectorResource = new AzureNative.CustomerInsights.Connector("azure-nativeConnectorResource", new()
    {
        ConnectorProperties = 
        {
            { "string", "any" },
        },
        ConnectorType = "string",
        HubName = "string",
        ResourceGroupName = "string",
        ConnectorName = "string",
        Description = "string",
        DisplayName = "string",
        IsInternal = false,
    });
    
    example, err := customerinsights.NewConnector(ctx, "azure-nativeConnectorResource", &customerinsights.ConnectorArgs{
    ConnectorProperties: pulumi.Map{
    "string": pulumi.Any("any"),
    },
    ConnectorType: pulumi.String("string"),
    HubName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ConnectorName: pulumi.String("string"),
    Description: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    IsInternal: pulumi.Bool(false),
    })
    
    var azure_nativeConnectorResource = new Connector("azure-nativeConnectorResource", ConnectorArgs.builder()
        .connectorProperties(Map.of("string", "any"))
        .connectorType("string")
        .hubName("string")
        .resourceGroupName("string")
        .connectorName("string")
        .description("string")
        .displayName("string")
        .isInternal(false)
        .build());
    
    azure_native_connector_resource = azure_native.customerinsights.Connector("azure-nativeConnectorResource",
        connector_properties={
            "string": "any",
        },
        connector_type="string",
        hub_name="string",
        resource_group_name="string",
        connector_name="string",
        description="string",
        display_name="string",
        is_internal=False)
    
    const azure_nativeConnectorResource = new azure_native.customerinsights.Connector("azure-nativeConnectorResource", {
        connectorProperties: {
            string: "any",
        },
        connectorType: "string",
        hubName: "string",
        resourceGroupName: "string",
        connectorName: "string",
        description: "string",
        displayName: "string",
        isInternal: false,
    });
    
    type: azure-native:customerinsights:Connector
    properties:
        connectorName: string
        connectorProperties:
            string: any
        connectorType: string
        description: string
        displayName: string
        hubName: string
        isInternal: false
        resourceGroupName: string
    

    Connector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Connector resource accepts the following input properties:

    ConnectorProperties Dictionary<string, object>
    The connector properties.
    ConnectorType string | Pulumi.AzureNative.CustomerInsights.ConnectorTypes
    Type of connector.
    HubName string
    The name of the hub.
    ResourceGroupName string
    The name of the resource group.
    ConnectorName string
    Name of the connector.
    Description string
    Description of the connector.
    DisplayName string
    Display name of the connector.
    IsInternal bool
    If this is an internal connector.
    ConnectorProperties map[string]interface{}
    The connector properties.
    ConnectorType string | ConnectorTypes
    Type of connector.
    HubName string
    The name of the hub.
    ResourceGroupName string
    The name of the resource group.
    ConnectorName string
    Name of the connector.
    Description string
    Description of the connector.
    DisplayName string
    Display name of the connector.
    IsInternal bool
    If this is an internal connector.
    connectorProperties Map<String,Object>
    The connector properties.
    connectorType String | ConnectorTypes
    Type of connector.
    hubName String
    The name of the hub.
    resourceGroupName String
    The name of the resource group.
    connectorName String
    Name of the connector.
    description String
    Description of the connector.
    displayName String
    Display name of the connector.
    isInternal Boolean
    If this is an internal connector.
    connectorProperties {[key: string]: any}
    The connector properties.
    connectorType string | ConnectorTypes
    Type of connector.
    hubName string
    The name of the hub.
    resourceGroupName string
    The name of the resource group.
    connectorName string
    Name of the connector.
    description string
    Description of the connector.
    displayName string
    Display name of the connector.
    isInternal boolean
    If this is an internal connector.
    connector_properties Mapping[str, Any]
    The connector properties.
    connector_type str | ConnectorTypes
    Type of connector.
    hub_name str
    The name of the hub.
    resource_group_name str
    The name of the resource group.
    connector_name str
    Name of the connector.
    description str
    Description of the connector.
    display_name str
    Display name of the connector.
    is_internal bool
    If this is an internal connector.
    connectorProperties Map<Any>
    The connector properties.
    connectorType String | "None" | "CRM" | "AzureBlob" | "Salesforce" | "ExchangeOnline" | "Outbound"
    Type of connector.
    hubName String
    The name of the hub.
    resourceGroupName String
    The name of the resource group.
    connectorName String
    Name of the connector.
    description String
    Description of the connector.
    displayName String
    Display name of the connector.
    isInternal Boolean
    If this is an internal connector.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connector resource produces the following output properties:

    ConnectorId int
    ID of the connector.
    Created string
    The created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    The last modified time.
    Name string
    Resource name.
    State string
    State of connector.
    TenantId string
    The hub name.
    Type string
    Resource type.
    ConnectorId int
    ID of the connector.
    Created string
    The created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    The last modified time.
    Name string
    Resource name.
    State string
    State of connector.
    TenantId string
    The hub name.
    Type string
    Resource type.
    connectorId Integer
    ID of the connector.
    created String
    The created time.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    The last modified time.
    name String
    Resource name.
    state String
    State of connector.
    tenantId String
    The hub name.
    type String
    Resource type.
    connectorId number
    ID of the connector.
    created string
    The created time.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModified string
    The last modified time.
    name string
    Resource name.
    state string
    State of connector.
    tenantId string
    The hub name.
    type string
    Resource type.
    connector_id int
    ID of the connector.
    created str
    The created time.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified str
    The last modified time.
    name str
    Resource name.
    state str
    State of connector.
    tenant_id str
    The hub name.
    type str
    Resource type.
    connectorId Number
    ID of the connector.
    created String
    The created time.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    The last modified time.
    name String
    Resource name.
    state String
    State of connector.
    tenantId String
    The hub name.
    type String
    Resource type.

    Supporting Types

    ConnectorTypes, ConnectorTypesArgs

    None
    None
    CRM
    CRM
    AzureBlob
    AzureBlob
    Salesforce
    Salesforce
    ExchangeOnline
    ExchangeOnline
    Outbound
    Outbound
    ConnectorTypesNone
    None
    ConnectorTypesCRM
    CRM
    ConnectorTypesAzureBlob
    AzureBlob
    ConnectorTypesSalesforce
    Salesforce
    ConnectorTypesExchangeOnline
    ExchangeOnline
    ConnectorTypesOutbound
    Outbound
    None
    None
    CRM
    CRM
    AzureBlob
    AzureBlob
    Salesforce
    Salesforce
    ExchangeOnline
    ExchangeOnline
    Outbound
    Outbound
    None
    None
    CRM
    CRM
    AzureBlob
    AzureBlob
    Salesforce
    Salesforce
    ExchangeOnline
    ExchangeOnline
    Outbound
    Outbound
    NONE
    None
    CRM
    CRM
    AZURE_BLOB
    AzureBlob
    SALESFORCE
    Salesforce
    EXCHANGE_ONLINE
    ExchangeOnline
    OUTBOUND
    Outbound
    "None"
    None
    "CRM"
    CRM
    "AzureBlob"
    AzureBlob
    "Salesforce"
    Salesforce
    "ExchangeOnline"
    ExchangeOnline
    "Outbound"
    Outbound

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:customerinsights:Connector sdkTestHub/testConnector /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.46.0 published on Friday, Jun 21, 2024 by Pulumi