Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. hybridconnectivity
  5. Endpoint
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.hybridconnectivity.Endpoint

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

The endpoint for the target resource.

Uses Azure REST API version 2024-12-01. In version 2.x of the Azure Native provider, it used API version 2023-03-15.

Other available API versions: 2023-03-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hybridconnectivity [ApiVersion]. See the version guide for details.

Example Usage

HybridConnectivityEndpointsPutCustom

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

return await Deployment.RunAsync(() => 
{
    var endpoint = new AzureNative.HybridConnectivity.Endpoint("endpoint", new()
    {
        EndpointName = "custom",
        ResourceId = "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace",
        ResourceUri = "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine",
        Type = AzureNative.HybridConnectivity.Type.Custom,
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hybridconnectivity.NewEndpoint(ctx, "endpoint", &hybridconnectivity.EndpointArgs{
			EndpointName: pulumi.String("custom"),
			ResourceId:   pulumi.String("/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace"),
			ResourceUri:  pulumi.String("subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine"),
			Type:         pulumi.String(hybridconnectivity.TypeCustom),
		})
		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.hybridconnectivity.Endpoint;
import com.pulumi.azurenative.hybridconnectivity.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .endpointName("custom")
            .resourceId("/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace")
            .resourceUri("subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine")
            .type("custom")
            .build());

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

const endpoint = new azure_native.hybridconnectivity.Endpoint("endpoint", {
    endpointName: "custom",
    resourceId: "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace",
    resourceUri: "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine",
    type: azure_native.hybridconnectivity.Type.Custom,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

endpoint = azure_native.hybridconnectivity.Endpoint("endpoint",
    endpoint_name="custom",
    resource_id="/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace",
    resource_uri="subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine",
    type=azure_native.hybridconnectivity.Type.CUSTOM)
Copy
resources:
  endpoint:
    type: azure-native:hybridconnectivity:Endpoint
    properties:
      endpointName: custom
      resourceId: /subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace
      resourceUri: subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine
      type: custom
Copy

HybridConnectivityEndpointsPutDefault

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

return await Deployment.RunAsync(() => 
{
    var endpoint = new AzureNative.HybridConnectivity.Endpoint("endpoint", new()
    {
        EndpointName = "default",
        ResourceUri = "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine",
        Type = AzureNative.HybridConnectivity.Type.@Default,
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hybridconnectivity.NewEndpoint(ctx, "endpoint", &hybridconnectivity.EndpointArgs{
			EndpointName: pulumi.String("default"),
			ResourceUri:  pulumi.String("subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine"),
			Type:         pulumi.String(hybridconnectivity.TypeDefault),
		})
		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.hybridconnectivity.Endpoint;
import com.pulumi.azurenative.hybridconnectivity.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .endpointName("default")
            .resourceUri("subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine")
            .type("default")
            .build());

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

const endpoint = new azure_native.hybridconnectivity.Endpoint("endpoint", {
    endpointName: "default",
    resourceUri: "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine",
    type: azure_native.hybridconnectivity.Type.Default,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

endpoint = azure_native.hybridconnectivity.Endpoint("endpoint",
    endpoint_name="default",
    resource_uri="subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine",
    type=azure_native.hybridconnectivity.Type.DEFAULT)
Copy
resources:
  endpoint:
    type: azure-native:hybridconnectivity:Endpoint
    properties:
      endpointName: default
      resourceUri: subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine
      type: default
Copy

Create Endpoint Resource

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

Constructor syntax

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             resource_uri: Optional[str] = None,
             type: Optional[Union[str, Type]] = None,
             endpoint_name: Optional[str] = None,
             resource_id: Optional[str] = None)
func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

type: azure-native:hybridconnectivity:Endpoint
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. EndpointArgs
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. EndpointArgs
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. EndpointArgs
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. EndpointArgs
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. EndpointArgs
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 azure_nativeEndpointResource = new AzureNative.HybridConnectivity.Endpoint("azure-nativeEndpointResource", new()
{
    ResourceUri = "string",
    Type = "string",
    EndpointName = "string",
    ResourceId = "string",
});
Copy
example, err := hybridconnectivity.NewEndpoint(ctx, "azure-nativeEndpointResource", &hybridconnectivity.EndpointArgs{
	ResourceUri:  pulumi.String("string"),
	Type:         pulumi.String("string"),
	EndpointName: pulumi.String("string"),
	ResourceId:   pulumi.String("string"),
})
Copy
var azure_nativeEndpointResource = new com.pulumi.azurenative.hybridconnectivity.Endpoint("azure-nativeEndpointResource", com.pulumi.azurenative.hybridconnectivity.EndpointArgs.builder()
    .resourceUri("string")
    .type("string")
    .endpointName("string")
    .resourceId("string")
    .build());
Copy
azure_native_endpoint_resource = azure_native.hybridconnectivity.Endpoint("azure-nativeEndpointResource",
    resource_uri="string",
    type="string",
    endpoint_name="string",
    resource_id="string")
Copy
const azure_nativeEndpointResource = new azure_native.hybridconnectivity.Endpoint("azure-nativeEndpointResource", {
    resourceUri: "string",
    type: "string",
    endpointName: "string",
    resourceId: "string",
});
Copy
type: azure-native:hybridconnectivity:Endpoint
properties:
    endpointName: string
    resourceId: string
    resourceUri: string
    type: string
Copy

Endpoint 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 Endpoint resource accepts the following input properties:

ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
Type This property is required. string | Pulumi.AzureNative.HybridConnectivity.Type
The type of endpoint.
EndpointName Changes to this property will trigger replacement. string
The endpoint name.
ResourceId string
The resource Id of the connectivity endpoint (optional).
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
Type This property is required. string | Type
The type of endpoint.
EndpointName Changes to this property will trigger replacement. string
The endpoint name.
ResourceId string
The resource Id of the connectivity endpoint (optional).
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the resource.
type This property is required. String | Type
The type of endpoint.
endpointName Changes to this property will trigger replacement. String
The endpoint name.
resourceId String
The resource Id of the connectivity endpoint (optional).
resourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
type This property is required. string | Type
The type of endpoint.
endpointName Changes to this property will trigger replacement. string
The endpoint name.
resourceId string
The resource Id of the connectivity endpoint (optional).
resource_uri
This property is required.
Changes to this property will trigger replacement.
str
The fully qualified Azure Resource manager identifier of the resource.
type This property is required. str | Type
The type of endpoint.
endpoint_name Changes to this property will trigger replacement. str
The endpoint name.
resource_id str
The resource Id of the connectivity endpoint (optional).
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the resource.
type This property is required. String | "default" | "custom"
The type of endpoint.
endpointName Changes to this property will trigger replacement. String
The endpoint name.
resourceId String
The resource Id of the connectivity endpoint (optional).

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The resource provisioning state.
SystemData Pulumi.AzureNative.HybridConnectivity.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The resource provisioning state.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The resource provisioning state.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
The resource provisioning state.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
The resource provisioning state.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The resource provisioning state.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.

Supporting Types

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.

Type
, TypeArgs

@Default
default
Custom
custom
TypeDefault
default
TypeCustom
custom
Default_
default
Custom
custom
Default
default
Custom
custom
DEFAULT
default
CUSTOM
custom
"default"
default
"custom"
custom

Import

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

$ pulumi import azure-native:hybridconnectivity:Endpoint default /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native