azure-native.dnsresolver.OutboundEndpoint
Explore with Pulumi AI
Describes an outbound endpoint for a DNS resolver.
Uses Azure REST API version 2023-07-01-preview.
Other available API versions: 2020-04-01-preview, 2022-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dnsresolver [ApiVersion]
. See the version guide for details.
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:dnsresolver:OutboundEndpoint
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. OutboundEndpointArgs - 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. 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
This property is required. string - The unique name of the resource.
- args
This property is required. OutboundEndpointArgs - 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. OutboundEndpointArgs - 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. 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.DnsResolver.OutboundEndpoint("outboundEndpointResource", new()
{
DnsResolverName = "string",
ResourceGroupName = "string",
Subnet = new AzureNative.DnsResolver.Inputs.SubResourceArgs
{
Id = "string",
},
Location = "string",
OutboundEndpointName = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := dnsresolver.NewOutboundEndpoint(ctx, "outboundEndpointResource", &dnsresolver.OutboundEndpointArgs{
DnsResolverName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Subnet: &dnsresolver.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.dnsresolver.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.dnsresolver.OutboundEndpoint("outboundEndpointResource", {
dnsResolverName: "string",
resourceGroupName: "string",
subnet: {
id: "string",
},
location: "string",
outboundEndpointName: "string",
tags: {
string: "string",
},
});
type: azure-native:dnsresolver: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:
- Dns
Resolver Name This property is required. Changes to this property will trigger replacement.
- The name of the DNS resolver.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Subnet
This property is required. Changes to this property will trigger replacement.
Azure Native. Dns Resolver. Inputs. Sub Resource - The reference to the subnet used for the outbound endpoint.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Outbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the outbound endpoint for the DNS resolver.
- Dictionary<string, string>
- Resource tags.
- Dns
Resolver Name This property is required. Changes to this property will trigger replacement.
- The name of the DNS resolver.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Subnet
This property is required. Changes to this property will trigger replacement.
Resource Args - The reference to the subnet used for the outbound endpoint.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Outbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the outbound endpoint for the DNS resolver.
- map[string]string
- Resource tags.
- dns
Resolver Name This property is required. Changes to this property will trigger replacement.
- The name of the DNS resolver.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- subnet
This property is required. Changes to this property will trigger replacement.
Resource - The reference to the subnet used for the outbound endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- outbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the outbound endpoint for the DNS resolver.
- Map<String,String>
- Resource tags.
- dns
Resolver Name This property is required. Changes to this property will trigger replacement.
- The name of the DNS resolver.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- subnet
This property is required. Changes to this property will trigger replacement.
Resource - The reference to the subnet used for the outbound endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- outbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the outbound endpoint for the DNS resolver.
- {[key: string]: string}
- Resource tags.
- dns_
resolver_ name This property is required. Changes to this property will trigger replacement.
- The name of the DNS resolver.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- subnet
This property is required. Changes to this property will trigger replacement.
Resource Args - The reference to the subnet used for the outbound endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- outbound_
endpoint_ name Changes to this property will trigger replacement.
- The name of the outbound endpoint for the DNS resolver.
- Mapping[str, str]
- Resource tags.
- dns
Resolver Name This property is required. Changes to this property will trigger replacement.
- The name of the DNS resolver.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- subnet
This property is required. Changes to this property will trigger replacement.
- The reference to the subnet used for the outbound endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- outbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the outbound endpoint for the DNS resolver.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the OutboundEndpoint resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
- Provisioning
State 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.
- Resource
Guid string - The resourceGuid property of the outbound endpoint resource.
- System
Data Pulumi.Azure Native. Dns Resolver. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
- Provisioning
State 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.
- Resource
Guid string - The resourceGuid property of the outbound endpoint resource.
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- 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
- provisioning
State 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.
- resource
Guid String - The resourceGuid property of the outbound endpoint resource.
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- 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
- provisioning
State 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.
- resource
Guid string - The resourceGuid property of the outbound endpoint resource.
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- 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 SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- 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
- provisioning
State 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.
- resource
Guid String - The resourceGuid property of the outbound endpoint resource.
- system
Data 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
SubResource, SubResourceArgs
- Id
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. 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
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, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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:dnsresolver: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