Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getOutboundEndpoint
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.network.getOutboundEndpoint

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

Gets properties of an outbound endpoint for a DNS resolver. Azure REST API version: 2022-07-01.

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

Using getOutboundEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOutboundEndpoint(args: GetOutboundEndpointArgs, opts?: InvokeOptions): Promise<GetOutboundEndpointResult>
function getOutboundEndpointOutput(args: GetOutboundEndpointOutputArgs, opts?: InvokeOptions): Output<GetOutboundEndpointResult>
Copy
def get_outbound_endpoint(dns_resolver_name: Optional[str] = None,
                          outbound_endpoint_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOutboundEndpointResult
def get_outbound_endpoint_output(dns_resolver_name: Optional[pulumi.Input[str]] = None,
                          outbound_endpoint_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOutboundEndpointResult]
Copy
func LookupOutboundEndpoint(ctx *Context, args *LookupOutboundEndpointArgs, opts ...InvokeOption) (*LookupOutboundEndpointResult, error)
func LookupOutboundEndpointOutput(ctx *Context, args *LookupOutboundEndpointOutputArgs, opts ...InvokeOption) LookupOutboundEndpointResultOutput
Copy

> Note: This function is named LookupOutboundEndpoint in the Go SDK.

public static class GetOutboundEndpoint 
{
    public static Task<GetOutboundEndpointResult> InvokeAsync(GetOutboundEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetOutboundEndpointResult> Invoke(GetOutboundEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOutboundEndpointResult> getOutboundEndpoint(GetOutboundEndpointArgs args, InvokeOptions options)
public static Output<GetOutboundEndpointResult> getOutboundEndpoint(GetOutboundEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getOutboundEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DnsResolverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DNS resolver.
OutboundEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the outbound endpoint for the DNS resolver.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
DnsResolverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DNS resolver.
OutboundEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the outbound endpoint for the DNS resolver.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
dnsResolverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DNS resolver.
outboundEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the outbound endpoint for the DNS resolver.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
dnsResolverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DNS resolver.
outboundEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the outbound endpoint for the DNS resolver.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
dns_resolver_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the DNS resolver.
outbound_endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the outbound endpoint for the DNS resolver.
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.
dnsResolverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DNS resolver.
outboundEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the outbound endpoint for the DNS resolver.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getOutboundEndpoint Result

The following output properties are available:

Etag string
ETag of the outbound endpoint.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
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.
Subnet Pulumi.AzureNative.Network.Outputs.SubResourceResponse
The reference to the subnet used for the outbound endpoint.
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"
Tags Dictionary<string, string>
Resource tags.
Etag string
ETag of the outbound endpoint.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
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.
Subnet SubResourceResponse
The reference to the subnet used for the outbound endpoint.
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"
Tags map[string]string
Resource tags.
etag String
ETag of the outbound endpoint.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
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.
subnet SubResourceResponse
The reference to the subnet used for the outbound endpoint.
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"
tags Map<String,String>
Resource tags.
etag string
ETag of the outbound endpoint.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
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.
subnet SubResourceResponse
The reference to the subnet used for the outbound endpoint.
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"
tags {[key: string]: string}
Resource tags.
etag str
ETag of the outbound endpoint.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
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.
subnet SubResourceResponse
The reference to the subnet used for the outbound endpoint.
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"
tags Mapping[str, str]
Resource tags.
etag String
ETag of the outbound endpoint.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
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.
subnet Property Map
The reference to the subnet used for the outbound endpoint.
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"
tags Map<String>
Resource tags.

Supporting Types

SubResourceResponse

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

SystemDataResponse

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.

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