azure-native-v2.network.InboundEndpoint
Explore with Pulumi AI
Describes an inbound 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.
Create InboundEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new InboundEndpoint(name: string, args: InboundEndpointArgs, opts?: CustomResourceOptions);
@overload
def InboundEndpoint(resource_name: str,
args: InboundEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def InboundEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
dns_resolver_name: Optional[str] = None,
ip_configurations: Optional[Sequence[InboundEndpointIPConfigurationArgs]] = None,
resource_group_name: Optional[str] = None,
inbound_endpoint_name: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewInboundEndpoint(ctx *Context, name string, args InboundEndpointArgs, opts ...ResourceOption) (*InboundEndpoint, error)
public InboundEndpoint(string name, InboundEndpointArgs args, CustomResourceOptions? opts = null)
public InboundEndpoint(String name, InboundEndpointArgs args)
public InboundEndpoint(String name, InboundEndpointArgs args, CustomResourceOptions options)
type: azure-native:network:InboundEndpoint
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. InboundEndpointArgs - 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. InboundEndpointArgs - 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. InboundEndpointArgs - 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. InboundEndpointArgs - 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. InboundEndpointArgs - 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 inboundEndpointResource = new AzureNative.Network.InboundEndpoint("inboundEndpointResource", new()
{
DnsResolverName = "string",
IpConfigurations = new[]
{
{
{ "subnet",
{
{ "id", "string" },
} },
{ "privateIpAddress", "string" },
{ "privateIpAllocationMethod", "string" },
},
},
ResourceGroupName = "string",
InboundEndpointName = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := network.NewInboundEndpoint(ctx, "inboundEndpointResource", &network.InboundEndpointArgs{
DnsResolverName: "string",
IpConfigurations: []map[string]interface{}{
map[string]interface{}{
"subnet": map[string]interface{}{
"id": "string",
},
"privateIpAddress": "string",
"privateIpAllocationMethod": "string",
},
},
ResourceGroupName: "string",
InboundEndpointName: "string",
Location: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var inboundEndpointResource = new InboundEndpoint("inboundEndpointResource", InboundEndpointArgs.builder()
.dnsResolverName("string")
.ipConfigurations(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.resourceGroupName("string")
.inboundEndpointName("string")
.location("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
inbound_endpoint_resource = azure_native.network.InboundEndpoint("inboundEndpointResource",
dns_resolver_name=string,
ip_configurations=[{
subnet: {
id: string,
},
privateIpAddress: string,
privateIpAllocationMethod: string,
}],
resource_group_name=string,
inbound_endpoint_name=string,
location=string,
tags={
string: string,
})
const inboundEndpointResource = new azure_native.network.InboundEndpoint("inboundEndpointResource", {
dnsResolverName: "string",
ipConfigurations: [{
subnet: {
id: "string",
},
privateIpAddress: "string",
privateIpAllocationMethod: "string",
}],
resourceGroupName: "string",
inboundEndpointName: "string",
location: "string",
tags: {
string: "string",
},
});
type: azure-native:network:InboundEndpoint
properties:
dnsResolverName: string
inboundEndpointName: string
ipConfigurations:
- privateIpAddress: string
privateIpAllocationMethod: string
subnet:
id: string
location: string
resourceGroupName: string
tags:
string: string
InboundEndpoint 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 InboundEndpoint 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.
- Ip
Configurations This property is required. List<Pulumi.Azure Native. Network. Inputs. Inbound Endpoint IPConfiguration> - IP configurations for the inbound endpoint.
- 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.
- Inbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the inbound endpoint for the DNS resolver.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- 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.
- Ip
Configurations This property is required. []InboundEndpoint IPConfiguration Args - IP configurations for the inbound endpoint.
- 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.
- Inbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the inbound endpoint for the DNS resolver.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- 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.
- ip
Configurations This property is required. List<InboundEndpoint IPConfiguration> - IP configurations for the inbound endpoint.
- 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.
- inbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the inbound endpoint for the DNS resolver.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- 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.
- ip
Configurations This property is required. InboundEndpoint IPConfiguration[] - IP configurations for the inbound endpoint.
- 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.
- inbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the inbound endpoint for the DNS resolver.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- {[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.
- ip_
configurations This property is required. Sequence[InboundEndpoint IPConfiguration Args] - IP configurations for the inbound endpoint.
- 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.
- inbound_
endpoint_ name Changes to this property will trigger replacement.
- The name of the inbound endpoint for the DNS resolver.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- 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.
- ip
Configurations This property is required. List<Property Map> - IP configurations for the inbound endpoint.
- 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.
- inbound
Endpoint Name Changes to this property will trigger replacement.
- The name of the inbound endpoint for the DNS resolver.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the InboundEndpoint resource produces the following output properties:
- Etag string
- ETag of the inbound 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 inbound 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 inbound endpoint resource.
- System
Data Pulumi.Azure Native. Network. Outputs. System Data Response - 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 inbound 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 inbound 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 inbound endpoint resource.
- System
Data SystemData Response - 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 inbound 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 inbound 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 inbound endpoint resource.
- system
Data SystemData Response - 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 inbound 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 inbound 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 inbound endpoint resource.
- system
Data SystemData Response - 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 inbound 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 inbound 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 inbound endpoint resource.
- system_
data SystemData Response - 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 inbound 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 inbound 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 inbound endpoint resource.
- system
Data 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
InboundEndpointIPConfiguration, InboundEndpointIPConfigurationArgs
- Subnet
This property is required. Pulumi.Azure Native. Network. Inputs. Sub Resource - The reference to the subnet bound to the IP configuration.
- Private
Ip stringAddress - Private IP address of the IP configuration.
- Private
Ip string | Pulumi.Allocation Method Azure Native. Network. Ip Allocation Method - Private IP address allocation method.
- Subnet
This property is required. SubResource - The reference to the subnet bound to the IP configuration.
- Private
Ip stringAddress - Private IP address of the IP configuration.
- Private
Ip string | IpAllocation Method Allocation Method - Private IP address allocation method.
- subnet
This property is required. SubResource - The reference to the subnet bound to the IP configuration.
- private
Ip StringAddress - Private IP address of the IP configuration.
- private
Ip String | IpAllocation Method Allocation Method - Private IP address allocation method.
- subnet
This property is required. SubResource - The reference to the subnet bound to the IP configuration.
- private
Ip stringAddress - Private IP address of the IP configuration.
- private
Ip string | IpAllocation Method Allocation Method - Private IP address allocation method.
- subnet
This property is required. SubResource - The reference to the subnet bound to the IP configuration.
- private_
ip_ straddress - Private IP address of the IP configuration.
- private_
ip_ str | Ipallocation_ method Allocation Method - Private IP address allocation method.
- subnet
This property is required. Property Map - The reference to the subnet bound to the IP configuration.
- private
Ip StringAddress - Private IP address of the IP configuration.
- private
Ip String | "Static" | "Dynamic"Allocation Method - Private IP address allocation method.
InboundEndpointIPConfigurationResponse, InboundEndpointIPConfigurationResponseArgs
- Subnet
This property is required. Pulumi.Azure Native. Network. Inputs. Sub Resource Response - The reference to the subnet bound to the IP configuration.
- Private
Ip stringAddress - Private IP address of the IP configuration.
- Private
Ip stringAllocation Method - Private IP address allocation method.
- Subnet
This property is required. SubResource Response - The reference to the subnet bound to the IP configuration.
- Private
Ip stringAddress - Private IP address of the IP configuration.
- Private
Ip stringAllocation Method - Private IP address allocation method.
- subnet
This property is required. SubResource Response - The reference to the subnet bound to the IP configuration.
- private
Ip StringAddress - Private IP address of the IP configuration.
- private
Ip StringAllocation Method - Private IP address allocation method.
- subnet
This property is required. SubResource Response - The reference to the subnet bound to the IP configuration.
- private
Ip stringAddress - Private IP address of the IP configuration.
- private
Ip stringAllocation Method - Private IP address allocation method.
- subnet
This property is required. SubResource Response - The reference to the subnet bound to the IP configuration.
- private_
ip_ straddress - Private IP address of the IP configuration.
- private_
ip_ strallocation_ method - Private IP address allocation method.
- subnet
This property is required. Property Map - The reference to the subnet bound to the IP configuration.
- private
Ip StringAddress - Private IP address of the IP configuration.
- private
Ip StringAllocation Method - Private IP address allocation method.
IpAllocationMethod, IpAllocationMethodArgs
- Static
- Static
- Dynamic
- Dynamic
- Ip
Allocation Method Static - Static
- Ip
Allocation Method Dynamic - Dynamic
- Static
- Static
- Dynamic
- Dynamic
- Static
- Static
- Dynamic
- Dynamic
- STATIC
- Static
- DYNAMIC
- Dynamic
- "Static"
- Static
- "Dynamic"
- Dynamic
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
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 type of identity that last modified the resource.
- 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 type of identity that last modified the resource.
- 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 type of identity that last modified the resource.
- 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 type of identity that last modified the resource.
- 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 type of identity that last modified the resource.
- 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 type of identity that last modified the resource.
- 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:network:InboundEndpoint sampleInboundEndpoint /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}
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