Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. OutboundEndpoint
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.OutboundEndpoint

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Describes an outbound endpoint for a DNS resolver. Azure REST API version: 2022-07-01. Prior API version in Azure Native 1.x: 2020-04-01-preview.

    Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

    Example Usage

    Upsert outbound endpoint for DNS resolver

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

return await Deployment.RunAsync(() => 
{
    var outboundEndpoint = new AzureNative.Network.OutboundEndpoint("outboundEndpoint", new()
    {
        DnsResolverName = "sampleDnsResolver",
        Location = "westus2",
        OutboundEndpointName = "sampleOutboundEndpoint",
        ResourceGroupName = "sampleResourceGroup",
        Subnet = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet",
        },
        Tags = 
        {
            { "key1", "value1" },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewOutboundEndpoint(ctx, "outboundEndpoint", &network.OutboundEndpointArgs{
			DnsResolverName:      pulumi.String("sampleDnsResolver"),
			Location:             pulumi.String("westus2"),
			OutboundEndpointName: pulumi.String("sampleOutboundEndpoint"),
			ResourceGroupName:    pulumi.String("sampleResourceGroup"),
			Subnet: &network.SubResourceArgs{
				Id: pulumi.String("/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet"),
			},
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
			},
		})
		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.network.OutboundEndpoint;
import com.pulumi.azurenative.network.OutboundEndpointArgs;
import com.pulumi.azurenative.network.inputs.SubResourceArgs;
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 outboundEndpoint = new OutboundEndpoint("outboundEndpoint", OutboundEndpointArgs.builder()
            .dnsResolverName("sampleDnsResolver")
            .location("westus2")
            .outboundEndpointName("sampleOutboundEndpoint")
            .resourceGroupName("sampleResourceGroup")
            .subnet(SubResourceArgs.builder()
                .id("/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet")
                .build())
            .tags(Map.of("key1", "value1"))
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

outbound_endpoint = azure_native.network.OutboundEndpoint("outboundEndpoint",
    dns_resolver_name="sampleDnsResolver",
    location="westus2",
    outbound_endpoint_name="sampleOutboundEndpoint",
    resource_group_name="sampleResourceGroup",
    subnet={
        "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet",
    },
    tags={
        "key1": "value1",
    })

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

const outboundEndpoint = new azure_native.network.OutboundEndpoint("outboundEndpoint", {
    dnsResolverName: "sampleDnsResolver",
    location: "westus2",
    outboundEndpointName: "sampleOutboundEndpoint",
    resourceGroupName: "sampleResourceGroup",
    subnet: {
        id: "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet",
    },
    tags: {
        key1: "value1",
    },
});

    resources:
  outboundEndpoint:
    type: azure-native:network:OutboundEndpoint
    properties:
      dnsResolverName: sampleDnsResolver
      location: westus2
      outboundEndpointName: sampleOutboundEndpoint
      resourceGroupName: sampleResourceGroup
      subnet:
        id: /subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet
      tags:
        key1: value1

    Create OutboundEndpoint Resource

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

    Constructor syntax

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

@overload
def OutboundEndpoint(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dns_resolver_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     subnet: Optional[SubResourceArgs] = None,
                     location: Optional[str] = None,
                     outbound_endpoint_name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewOutboundEndpoint(ctx *Context, name string, args OutboundEndpointArgs, opts ...ResourceOption) (*OutboundEndpoint, error)
    public OutboundEndpoint(string name, OutboundEndpointArgs args, CustomResourceOptions? opts = null)
    public OutboundEndpoint(String name, OutboundEndpointArgs args)
public OutboundEndpoint(String name, OutboundEndpointArgs args, CustomResourceOptions options)

    type: azure-native:network:OutboundEndpoint
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 OutboundEndpointArgs
    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 OutboundEndpointArgs
    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 OutboundEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutboundEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutboundEndpointArgs
    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 outboundEndpointResource = new AzureNative.Network.OutboundEndpoint("outboundEndpointResource", new()
{
    DnsResolverName = "string",
    ResourceGroupName = "string",
    Subnet = new AzureNative.Network.Inputs.SubResourceArgs
    {
        Id = "string",
    },
    Location = "string",
    OutboundEndpointName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := network.NewOutboundEndpoint(ctx, "outboundEndpointResource", &network.OutboundEndpointArgs{
	DnsResolverName:   pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Subnet: &network.SubResourceArgs{
		Id: pulumi.String("string"),
	},
	Location:             pulumi.String("string"),
	OutboundEndpointName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var outboundEndpointResource = new OutboundEndpoint("outboundEndpointResource", OutboundEndpointArgs.builder()
    .dnsResolverName("string")
    .resourceGroupName("string")
    .subnet(SubResourceArgs.builder()
        .id("string")
        .build())
    .location("string")
    .outboundEndpointName("string")
    .tags(Map.of("string", "string"))
    .build());

    outbound_endpoint_resource = azure_native.network.OutboundEndpoint("outboundEndpointResource",
    dns_resolver_name="string",
    resource_group_name="string",
    subnet={
        "id": "string",
    },
    location="string",
    outbound_endpoint_name="string",
    tags={
        "string": "string",
    })

    const outboundEndpointResource = new azure_native.network.OutboundEndpoint("outboundEndpointResource", {
    dnsResolverName: "string",
    resourceGroupName: "string",
    subnet: {
        id: "string",
    },
    location: "string",
    outboundEndpointName: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:network:OutboundEndpoint
properties:
    dnsResolverName: string
    location: string
    outboundEndpointName: string
    resourceGroupName: string
    subnet:
        id: string
    tags:
        string: string

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

    DnsResolverName string
    The name of the DNS resolver.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Subnet Pulumi.AzureNative.Network.Inputs.SubResource
    The reference to the subnet used for the outbound endpoint.
    Location string
    The geo-location where the resource lives
    OutboundEndpointName string
    The name of the outbound endpoint for the DNS resolver.
    Tags Dictionary<string, string>
    Resource tags.
    DnsResolverName string
    The name of the DNS resolver.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Subnet SubResourceArgs
    The reference to the subnet used for the outbound endpoint.
    Location string
    The geo-location where the resource lives
    OutboundEndpointName string
    The name of the outbound endpoint for the DNS resolver.
    Tags map[string]string
    Resource tags.
    dnsResolverName String
    The name of the DNS resolver.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    subnet SubResource
    The reference to the subnet used for the outbound endpoint.
    location String
    The geo-location where the resource lives
    outboundEndpointName String
    The name of the outbound endpoint for the DNS resolver.
    tags Map<String,String>
    Resource tags.
    dnsResolverName string
    The name of the DNS resolver.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    subnet SubResource
    The reference to the subnet used for the outbound endpoint.
    location string
    The geo-location where the resource lives
    outboundEndpointName string
    The name of the outbound endpoint for the DNS resolver.
    tags {[key: string]: string}
    Resource tags.
    dns_resolver_name str
    The name of the DNS resolver.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    subnet SubResourceArgs
    The reference to the subnet used for the outbound endpoint.
    location str
    The geo-location where the resource lives
    outbound_endpoint_name str
    The name of the outbound endpoint for the DNS resolver.
    tags Mapping[str, str]
    Resource tags.
    dnsResolverName String
    The name of the DNS resolver.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    subnet Property Map
    The reference to the subnet used for the outbound endpoint.
    location String
    The geo-location where the resource lives
    outboundEndpointName String
    The name of the outbound endpoint for the DNS resolver.
    tags Map<String>
    Resource tags.

    Outputs

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

    Etag string
    ETag of the outbound endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
    ResourceGuid string
    The resourceGuid property of the outbound endpoint resource.
    SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    ETag of the outbound endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
    ResourceGuid string
    The resourceGuid property of the outbound endpoint resource.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    ETag of the outbound endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
    resourceGuid String
    The resourceGuid property of the outbound endpoint resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag string
    ETag of the outbound endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
    resourceGuid string
    The resourceGuid property of the outbound endpoint resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag str
    ETag of the outbound endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
    resource_guid str
    The resourceGuid property of the outbound endpoint resource.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    ETag of the outbound endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.
    resourceGuid String
    The resourceGuid property of the outbound endpoint resource.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SubResource, SubResourceArgs

    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id str
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.

    SubResourceResponse, SubResourceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:network:OutboundEndpoint sampleOutboundEndpoint /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native