Azure Native v1.97.0, Mar 13 23

azure-native.network.getForwardingRule

Gets properties of a forwarding rule in a DNS forwarding ruleset. API Version: 2020-04-01-preview.

Using getForwardingRule

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 getForwardingRule(args: GetForwardingRuleArgs, opts?: InvokeOptions): Promise<GetForwardingRuleResult>
function getForwardingRuleOutput(args: GetForwardingRuleOutputArgs, opts?: InvokeOptions): Output<GetForwardingRuleResult>

def get_forwarding_rule(dns_forwarding_ruleset_name: Optional[str] = None,
                        forwarding_rule_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetForwardingRuleResult
def get_forwarding_rule_output(dns_forwarding_ruleset_name: Optional[pulumi.Input[str]] = None,
                        forwarding_rule_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetForwardingRuleResult]

func LookupForwardingRule(ctx *Context, args *LookupForwardingRuleArgs, opts ...InvokeOption) (*LookupForwardingRuleResult, error)
func LookupForwardingRuleOutput(ctx *Context, args *LookupForwardingRuleOutputArgs, opts ...InvokeOption) LookupForwardingRuleResultOutput

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

public static class GetForwardingRule 
{
    public static Task<GetForwardingRuleResult> InvokeAsync(GetForwardingRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetForwardingRuleResult> Invoke(GetForwardingRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetForwardingRuleResult> getForwardingRule(GetForwardingRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getForwardingRule
  arguments:
    # arguments dictionary

The following arguments are supported:

DnsForwardingRulesetName string: The name of the DNS forwarding ruleset.
ForwardingRuleName string: The name of the forwarding rule.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

DnsForwardingRulesetName string: The name of the DNS forwarding ruleset.
ForwardingRuleName string: The name of the forwarding rule.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName String: The name of the DNS forwarding ruleset.
forwardingRuleName String: The name of the forwarding rule.
resourceGroupName String: The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName string: The name of the DNS forwarding ruleset.
forwardingRuleName string: The name of the forwarding rule.
resourceGroupName string: The name of the resource group. The name is case insensitive.

dns_forwarding_ruleset_name str: The name of the DNS forwarding ruleset.
forwarding_rule_name str: The name of the forwarding rule.
resource_group_name str: The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName String: The name of the DNS forwarding ruleset.
forwardingRuleName String: The name of the forwarding rule.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getForwardingRule Result

The following output properties are available:

DomainName string: The domain name for the forwarding rule.
Etag string: ETag of the forwarding rule.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
TargetDnsServers List<Pulumi.AzureNative.Network.Outputs.TargetDnsServerResponse>: DNS servers to forward the DNS query to.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ForwardingRuleState string: The state of forwarding rule.
Metadata Dictionary<string, string>: Metadata attached to the forwarding rule.

DomainName string: The domain name for the forwarding rule.
Etag string: ETag of the forwarding rule.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
TargetDnsServers []TargetDnsServerResponse: DNS servers to forward the DNS query to.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ForwardingRuleState string: The state of forwarding rule.
Metadata map[string]string: Metadata attached to the forwarding rule.

domainName String: The domain name for the forwarding rule.
etag String: ETag of the forwarding rule.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
targetDnsServers List<TargetDnsServerResponse>: DNS servers to forward the DNS query to.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
forwardingRuleState String: The state of forwarding rule.
metadata Map<String,String>: Metadata attached to the forwarding rule.

domainName string: The domain name for the forwarding rule.
etag string: ETag of the forwarding rule.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
provisioningState string: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
targetDnsServers TargetDnsServerResponse[]: DNS servers to forward the DNS query to.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
forwardingRuleState string: The state of forwarding rule.
metadata {[key: string]: string}: Metadata attached to the forwarding rule.

domain_name str: The domain name for the forwarding rule.
etag str: ETag of the forwarding rule.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
provisioning_state str: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
target_dns_servers Sequence[TargetDnsServerResponse]: DNS servers to forward the DNS query to.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
forwarding_rule_state str: The state of forwarding rule.
metadata Mapping[str, str]: Metadata attached to the forwarding rule.

domainName String: The domain name for the forwarding rule.
etag String: ETag of the forwarding rule.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
systemData Property Map: Metadata pertaining to creation and last modification of the resource.
targetDnsServers List<Property Map>: DNS servers to forward the DNS query to.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
forwardingRuleState String: The state of forwarding rule.
metadata Map<String>: Metadata attached to the forwarding rule.

Supporting Types

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.

TargetDnsServerResponse

IpAddress string: DNS server IP address.
Port int: DNS server port.

IpAddress string: DNS server IP address.
Port int: DNS server port.

ipAddress String: DNS server IP address.
port Integer: DNS server port.

ipAddress string: DNS server IP address.
port number: DNS server port.

ip_address str: DNS server IP address.
port int: DNS server port.

ipAddress String: DNS server IP address.
port Number: DNS server port.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0