Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. workloads
  5. Connector
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.workloads.Connector

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Define the connector resource. Azure REST API version: 2023-10-01-preview.

Example Usage

Create a connector resource.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var connector = new AzureNative.Workloads.Connector("connector", new()
    {
        ConnectorName = "C1",
        Location = "westcentralus",
        ResourceGroupName = "test-rg",
        SourceResourceId = "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00",
        Tags = null,
    });

});
Copy
package main

import (
	workloads "github.com/pulumi/pulumi-azure-native-sdk/workloads/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := workloads.NewConnector(ctx, "connector", &workloads.ConnectorArgs{
			ConnectorName:     pulumi.String("C1"),
			Location:          pulumi.String("westcentralus"),
			ResourceGroupName: pulumi.String("test-rg"),
			SourceResourceId:  pulumi.String("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00"),
			Tags:              pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.workloads.Connector;
import com.pulumi.azurenative.workloads.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("C1")
            .location("westcentralus")
            .resourceGroupName("test-rg")
            .sourceResourceId("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00")
            .tags()
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const connector = new azure_native.workloads.Connector("connector", {
    connectorName: "C1",
    location: "westcentralus",
    resourceGroupName: "test-rg",
    sourceResourceId: "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00",
    tags: {},
});
Copy
import pulumi
import pulumi_azure_native as azure_native

connector = azure_native.workloads.Connector("connector",
    connector_name="C1",
    location="westcentralus",
    resource_group_name="test-rg",
    source_resource_id="/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00",
    tags={})
Copy
resources:
  connector:
    type: azure-native:workloads:Connector
    properties:
      connectorName: C1
      location: westcentralus
      resourceGroupName: test-rg
      sourceResourceId: /subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00
      tags: {}
Copy

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,
              resource_group_name: Optional[str] = None,
              source_resource_id: Optional[str] = None,
              connector_name: Optional[str] = None,
              identity: Optional[UserAssignedServiceIdentityArgs] = None,
              location: Optional[str] = None,
              managed_resource_group_configuration: Optional[ManagedRGConfigurationArgs] = None,
              tags: Optional[Mapping[str, str]] = 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:workloads:Connector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConnectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var exampleconnectorResourceResourceFromWorkloads = new AzureNative.Workloads.Connector("exampleconnectorResourceResourceFromWorkloads", new()
{
    ResourceGroupName = "string",
    SourceResourceId = "string",
    ConnectorName = "string",
    Identity = 
    {
        { "type", "string" },
        { "userAssignedIdentities", new[]
        {
            "string",
        } },
    },
    Location = "string",
    ManagedResourceGroupConfiguration = 
    {
        { "name", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := workloads.NewConnector(ctx, "exampleconnectorResourceResourceFromWorkloads", &workloads.ConnectorArgs{
	ResourceGroupName: "string",
	SourceResourceId:  "string",
	ConnectorName:     "string",
	Identity: map[string]interface{}{
		"type": "string",
		"userAssignedIdentities": []string{
			"string",
		},
	},
	Location: "string",
	ManagedResourceGroupConfiguration: map[string]interface{}{
		"name": "string",
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var exampleconnectorResourceResourceFromWorkloads = new Connector("exampleconnectorResourceResourceFromWorkloads", ConnectorArgs.builder()
    .resourceGroupName("string")
    .sourceResourceId("string")
    .connectorName("string")
    .identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .location("string")
    .managedResourceGroupConfiguration(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
exampleconnector_resource_resource_from_workloads = azure_native.workloads.Connector("exampleconnectorResourceResourceFromWorkloads",
    resource_group_name=string,
    source_resource_id=string,
    connector_name=string,
    identity={
        type: string,
        userAssignedIdentities: [string],
    },
    location=string,
    managed_resource_group_configuration={
        name: string,
    },
    tags={
        string: string,
    })
Copy
const exampleconnectorResourceResourceFromWorkloads = new azure_native.workloads.Connector("exampleconnectorResourceResourceFromWorkloads", {
    resourceGroupName: "string",
    sourceResourceId: "string",
    connectorName: "string",
    identity: {
        type: "string",
        userAssignedIdentities: ["string"],
    },
    location: "string",
    managedResourceGroupConfiguration: {
        name: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:workloads:Connector
properties:
    connectorName: string
    identity:
        type: string
        userAssignedIdentities:
            - string
    location: string
    managedResourceGroupConfiguration:
        name: string
    resourceGroupName: string
    sourceResourceId: string
    tags:
        string: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Connector resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SourceResourceId
This property is required.
Changes to this property will trigger replacement.
string
Defines the ID of the connector's source resource.
ConnectorName Changes to this property will trigger replacement. string
The name of the connector resource
Identity Pulumi.AzureNative.Workloads.Inputs.UserAssignedServiceIdentity
Managed service identity (user assigned identities)
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ManagedResourceGroupConfiguration Pulumi.AzureNative.Workloads.Inputs.ManagedRGConfiguration
Managed resource group configuration
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SourceResourceId
This property is required.
Changes to this property will trigger replacement.
string
Defines the ID of the connector's source resource.
ConnectorName Changes to this property will trigger replacement. string
The name of the connector resource
Identity UserAssignedServiceIdentityArgs
Managed service identity (user assigned identities)
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ManagedResourceGroupConfiguration ManagedRGConfigurationArgs
Managed resource group configuration
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sourceResourceId
This property is required.
Changes to this property will trigger replacement.
String
Defines the ID of the connector's source resource.
connectorName Changes to this property will trigger replacement. String
The name of the connector resource
identity UserAssignedServiceIdentity
Managed service identity (user assigned identities)
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
managedResourceGroupConfiguration ManagedRGConfiguration
Managed resource group configuration
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
sourceResourceId
This property is required.
Changes to this property will trigger replacement.
string
Defines the ID of the connector's source resource.
connectorName Changes to this property will trigger replacement. string
The name of the connector resource
identity UserAssignedServiceIdentity
Managed service identity (user assigned identities)
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
managedResourceGroupConfiguration ManagedRGConfiguration
Managed resource group configuration
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
source_resource_id
This property is required.
Changes to this property will trigger replacement.
str
Defines the ID of the connector's source resource.
connector_name Changes to this property will trigger replacement. str
The name of the connector resource
identity UserAssignedServiceIdentityArgs
Managed service identity (user assigned identities)
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
managed_resource_group_configuration ManagedRGConfigurationArgs
Managed resource group configuration
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sourceResourceId
This property is required.
Changes to this property will trigger replacement.
String
Defines the ID of the connector's source resource.
connectorName Changes to this property will trigger replacement. String
The name of the connector resource
identity Property Map
Managed service identity (user assigned identities)
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
managedResourceGroupConfiguration Property Map
Managed resource group configuration
tags Map<String>
Resource tags.

Outputs

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

Errors Pulumi.AzureNative.Workloads.Outputs.ConnectorErrorDefinitionResponse
Indicates any errors on the connector resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Defines the provisioning states.
SystemData Pulumi.AzureNative.Workloads.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Errors ConnectorErrorDefinitionResponse
Indicates any errors on the connector resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Defines the provisioning states.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
errors ConnectorErrorDefinitionResponse
Indicates any errors on the connector resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Defines the provisioning states.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
errors ConnectorErrorDefinitionResponse
Indicates any errors on the connector resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Defines the provisioning states.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
errors ConnectorErrorDefinitionResponse
Indicates any errors on the connector resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Defines the provisioning states.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
errors Property Map
Indicates any errors on the connector resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Defines the provisioning states.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ConnectorErrorDefinitionResponse
, ConnectorErrorDefinitionResponseArgs

Code This property is required. string
Service specific error code which serves as the substatus for the HTTP error code.
Details This property is required. List<Pulumi.AzureNative.Workloads.Inputs.ConnectorErrorDefinitionResponse>
Internal error details.
Message This property is required. string
Description of the error.
Code This property is required. string
Service specific error code which serves as the substatus for the HTTP error code.
Details This property is required. []ConnectorErrorDefinitionResponse
Internal error details.
Message This property is required. string
Description of the error.
code This property is required. String
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. List<ConnectorErrorDefinitionResponse>
Internal error details.
message This property is required. String
Description of the error.
code This property is required. string
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. ConnectorErrorDefinitionResponse[]
Internal error details.
message This property is required. string
Description of the error.
code This property is required. str
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. Sequence[ConnectorErrorDefinitionResponse]
Internal error details.
message This property is required. str
Description of the error.
code This property is required. String
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. List<Property Map>
Internal error details.
message This property is required. String
Description of the error.

ManagedRGConfiguration
, ManagedRGConfigurationArgs

Name string
Managed resource group name
Name string
Managed resource group name
name String
Managed resource group name
name string
Managed resource group name
name str
Managed resource group name
name String
Managed resource group name

ManagedRGConfigurationResponse
, ManagedRGConfigurationResponseArgs

Name string
Managed resource group name
Name string
Managed resource group name
name String
Managed resource group name
name string
Managed resource group name
name str
Managed resource group name
name String
Managed resource group name

ManagedServiceIdentityType
, ManagedServiceIdentityTypeArgs

None
None
UserAssigned
UserAssigned
ManagedServiceIdentityTypeNone
None
ManagedServiceIdentityTypeUserAssigned
UserAssigned
None
None
UserAssigned
UserAssigned
None
None
UserAssigned
UserAssigned
NONE
None
USER_ASSIGNED
UserAssigned
"None"
None
"UserAssigned"
UserAssigned

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserAssignedIdentityResponse
, UserAssignedIdentityResponseArgs

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

UserAssignedServiceIdentity
, UserAssignedServiceIdentityArgs

Type This property is required. string | Pulumi.AzureNative.Workloads.ManagedServiceIdentityType
Type of manage identity
UserAssignedIdentities List<string>
User assigned identities dictionary
Type This property is required. string | ManagedServiceIdentityType
Type of manage identity
UserAssignedIdentities []string
User assigned identities dictionary
type This property is required. String | ManagedServiceIdentityType
Type of manage identity
userAssignedIdentities List<String>
User assigned identities dictionary
type This property is required. string | ManagedServiceIdentityType
Type of manage identity
userAssignedIdentities string[]
User assigned identities dictionary
type This property is required. str | ManagedServiceIdentityType
Type of manage identity
user_assigned_identities Sequence[str]
User assigned identities dictionary
type This property is required. String | "None" | "UserAssigned"
Type of manage identity
userAssignedIdentities List<String>
User assigned identities dictionary

UserAssignedServiceIdentityResponse
, UserAssignedServiceIdentityResponseArgs

Type This property is required. string
Type of manage identity
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Workloads.Inputs.UserAssignedIdentityResponse>
User assigned identities dictionary
Type This property is required. string
Type of manage identity
UserAssignedIdentities map[string]UserAssignedIdentityResponse
User assigned identities dictionary
type This property is required. String
Type of manage identity
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
User assigned identities dictionary
type This property is required. string
Type of manage identity
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
User assigned identities dictionary
type This property is required. str
Type of manage identity
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
User assigned identities dictionary
type This property is required. String
Type of manage identity
userAssignedIdentities Map<Property Map>
User assigned identities dictionary

Import

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

$ pulumi import azure-native:workloads:Connector C1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/connectors/{connectorName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native