Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getGateway

This type describes a gateway resource. API Version: 2018-09-01-preview.

Using getGateway

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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
def get_gateway(gateway_resource_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_resource_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput

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

public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:servicefabricmesh:getGateway
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GatewayResourceName string

The identity of the gateway.

ResourceGroupName string

Azure resource group name

GatewayResourceName string

The identity of the gateway.

ResourceGroupName string

Azure resource group name

gatewayResourceName String

The identity of the gateway.

resourceGroupName String

Azure resource group name

gatewayResourceName string

The identity of the gateway.

resourceGroupName string

Azure resource group name

gateway_resource_name str

The identity of the gateway.

resource_group_name str

Azure resource group name

gatewayResourceName String

The identity of the gateway.

resourceGroupName String

Azure resource group name

getGateway Result

The following output properties are available:

DestinationNetwork Pulumi.AzureNative.ServiceFabricMesh.Outputs.NetworkRefResponse

Network that the Application is using.

Id string

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IpAddress string

IP address of the gateway. This is populated in the response and is ignored for incoming requests.

Location string

The geo-location where the resource lives

Name string

The name of the resource

ProvisioningState string

State of the resource.

SourceNetwork Pulumi.AzureNative.ServiceFabricMesh.Outputs.NetworkRefResponse

Network the gateway should listen on for requests.

Status string

Status of the resource.

StatusDetails string

Gives additional information about the current status of the gateway.

Type string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Description string

User readable description of the gateway.

Http List<Pulumi.AzureNative.ServiceFabricMesh.Outputs.HttpConfigResponse>

Configuration for http connectivity for this gateway.

Tags Dictionary<string, string>

Resource tags.

Tcp List<Pulumi.AzureNative.ServiceFabricMesh.Outputs.TcpConfigResponse>

Configuration for tcp connectivity for this gateway.

DestinationNetwork NetworkRefResponse

Network that the Application is using.

Id string

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IpAddress string

IP address of the gateway. This is populated in the response and is ignored for incoming requests.

Location string

The geo-location where the resource lives

Name string

The name of the resource

ProvisioningState string

State of the resource.

SourceNetwork NetworkRefResponse

Network the gateway should listen on for requests.

Status string

Status of the resource.

StatusDetails string

Gives additional information about the current status of the gateway.

Type string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Description string

User readable description of the gateway.

Http []HttpConfigResponse

Configuration for http connectivity for this gateway.

Tags map[string]string

Resource tags.

Tcp []TcpConfigResponse

Configuration for tcp connectivity for this gateway.

destinationNetwork NetworkRefResponse

Network that the Application is using.

id String

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

ipAddress String

IP address of the gateway. This is populated in the response and is ignored for incoming requests.

location String

The geo-location where the resource lives

name String

The name of the resource

provisioningState String

State of the resource.

sourceNetwork NetworkRefResponse

Network the gateway should listen on for requests.

status String

Status of the resource.

statusDetails String

Gives additional information about the current status of the gateway.

type String

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

description String

User readable description of the gateway.

http List<HttpConfigResponse>

Configuration for http connectivity for this gateway.

tags Map<String,String>

Resource tags.

tcp List<TcpConfigResponse>

Configuration for tcp connectivity for this gateway.

destinationNetwork NetworkRefResponse

Network that the Application is using.

id string

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

ipAddress string

IP address of the gateway. This is populated in the response and is ignored for incoming requests.

location string

The geo-location where the resource lives

name string

The name of the resource

provisioningState string

State of the resource.

sourceNetwork NetworkRefResponse

Network the gateway should listen on for requests.

status string

Status of the resource.

statusDetails string

Gives additional information about the current status of the gateway.

type string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

description string

User readable description of the gateway.

http HttpConfigResponse[]

Configuration for http connectivity for this gateway.

tags {[key: string]: string}

Resource tags.

tcp TcpConfigResponse[]

Configuration for tcp connectivity for this gateway.

destination_network NetworkRefResponse

Network that the Application is using.

id str

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

ip_address str

IP address of the gateway. This is populated in the response and is ignored for incoming requests.

location str

The geo-location where the resource lives

name str

The name of the resource

provisioning_state str

State of the resource.

source_network NetworkRefResponse

Network the gateway should listen on for requests.

status str

Status of the resource.

status_details str

Gives additional information about the current status of the gateway.

type str

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

description str

User readable description of the gateway.

http Sequence[HttpConfigResponse]

Configuration for http connectivity for this gateway.

tags Mapping[str, str]

Resource tags.

tcp Sequence[TcpConfigResponse]

Configuration for tcp connectivity for this gateway.

destinationNetwork Property Map

Network that the Application is using.

id String

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

ipAddress String

IP address of the gateway. This is populated in the response and is ignored for incoming requests.

location String

The geo-location where the resource lives

name String

The name of the resource

provisioningState String

State of the resource.

sourceNetwork Property Map

Network the gateway should listen on for requests.

status String

Status of the resource.

statusDetails String

Gives additional information about the current status of the gateway.

type String

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

description String

User readable description of the gateway.

http List<Property Map>

Configuration for http connectivity for this gateway.

tags Map<String>

Resource tags.

tcp List<Property Map>

Configuration for tcp connectivity for this gateway.

Supporting Types

EndpointRefResponse

Name string

Name of the endpoint.

Name string

Name of the endpoint.

name String

Name of the endpoint.

name string

Name of the endpoint.

name str

Name of the endpoint.

name String

Name of the endpoint.

GatewayDestinationResponse

ApplicationName string

Name of the service fabric Mesh application.

EndpointName string

name of the endpoint in the service.

ServiceName string

service that contains the endpoint.

ApplicationName string

Name of the service fabric Mesh application.

EndpointName string

name of the endpoint in the service.

ServiceName string

service that contains the endpoint.

applicationName String

Name of the service fabric Mesh application.

endpointName String

name of the endpoint in the service.

serviceName String

service that contains the endpoint.

applicationName string

Name of the service fabric Mesh application.

endpointName string

name of the endpoint in the service.

serviceName string

service that contains the endpoint.

application_name str

Name of the service fabric Mesh application.

endpoint_name str

name of the endpoint in the service.

service_name str

service that contains the endpoint.

applicationName String

Name of the service fabric Mesh application.

endpointName String

name of the endpoint in the service.

serviceName String

service that contains the endpoint.

HttpConfigResponse

Hosts List<Pulumi.AzureNative.ServiceFabricMesh.Inputs.HttpHostConfigResponse>

description for routing.

Name string

http gateway config name.

Port int

Specifies the port at which the service endpoint below needs to be exposed.

Hosts []HttpHostConfigResponse

description for routing.

Name string

http gateway config name.

Port int

Specifies the port at which the service endpoint below needs to be exposed.

hosts List<HttpHostConfigResponse>

description for routing.

name String

http gateway config name.

port Integer

Specifies the port at which the service endpoint below needs to be exposed.

hosts HttpHostConfigResponse[]

description for routing.

name string

http gateway config name.

port number

Specifies the port at which the service endpoint below needs to be exposed.

hosts Sequence[HttpHostConfigResponse]

description for routing.

name str

http gateway config name.

port int

Specifies the port at which the service endpoint below needs to be exposed.

hosts List<Property Map>

description for routing.

name String

http gateway config name.

port Number

Specifies the port at which the service endpoint below needs to be exposed.

HttpHostConfigResponse

Name string

http hostname config name.

Routes List<Pulumi.AzureNative.ServiceFabricMesh.Inputs.HttpRouteConfigResponse>

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

Name string

http hostname config name.

Routes []HttpRouteConfigResponse

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

name String

http hostname config name.

routes List<HttpRouteConfigResponse>

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

name string

http hostname config name.

routes HttpRouteConfigResponse[]

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

name str

http hostname config name.

routes Sequence[HttpRouteConfigResponse]

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

name String

http hostname config name.

routes List<Property Map>

Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.

HttpRouteConfigResponse

Destination Pulumi.AzureNative.ServiceFabricMesh.Inputs.GatewayDestinationResponse

Describes destination endpoint for routing traffic.

Match Pulumi.AzureNative.ServiceFabricMesh.Inputs.HttpRouteMatchRuleResponse

Describes a rule for http route matching.

Name string

http route name.

Destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

Match HttpRouteMatchRuleResponse

Describes a rule for http route matching.

Name string

http route name.

destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

match HttpRouteMatchRuleResponse

Describes a rule for http route matching.

name String

http route name.

destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

match HttpRouteMatchRuleResponse

Describes a rule for http route matching.

name string

http route name.

destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

match HttpRouteMatchRuleResponse

Describes a rule for http route matching.

name str

http route name.

destination Property Map

Describes destination endpoint for routing traffic.

match Property Map

Describes a rule for http route matching.

name String

http route name.

HttpRouteMatchHeaderResponse

Name string

Name of header to match in request.

Type string

how to match header value

Value string

Value of header to match in request.

Name string

Name of header to match in request.

Type string

how to match header value

Value string

Value of header to match in request.

name String

Name of header to match in request.

type String

how to match header value

value String

Value of header to match in request.

name string

Name of header to match in request.

type string

how to match header value

value string

Value of header to match in request.

name str

Name of header to match in request.

type str

how to match header value

value str

Value of header to match in request.

name String

Name of header to match in request.

type String

how to match header value

value String

Value of header to match in request.

HttpRouteMatchPathResponse

Type string

how to match value in the Uri

Value string

Uri path to match for request.

Rewrite string

replacement string for matched part of the Uri.

Type string

how to match value in the Uri

Value string

Uri path to match for request.

Rewrite string

replacement string for matched part of the Uri.

type String

how to match value in the Uri

value String

Uri path to match for request.

rewrite String

replacement string for matched part of the Uri.

type string

how to match value in the Uri

value string

Uri path to match for request.

rewrite string

replacement string for matched part of the Uri.

type str

how to match value in the Uri

value str

Uri path to match for request.

rewrite str

replacement string for matched part of the Uri.

type String

how to match value in the Uri

value String

Uri path to match for request.

rewrite String

replacement string for matched part of the Uri.

HttpRouteMatchRuleResponse

Path HttpRouteMatchPathResponse

Path to match for routing.

Headers []HttpRouteMatchHeaderResponse

headers and their values to match in request.

path HttpRouteMatchPathResponse

Path to match for routing.

headers List<HttpRouteMatchHeaderResponse>

headers and their values to match in request.

path HttpRouteMatchPathResponse

Path to match for routing.

headers HttpRouteMatchHeaderResponse[]

headers and their values to match in request.

path HttpRouteMatchPathResponse

Path to match for routing.

headers Sequence[HttpRouteMatchHeaderResponse]

headers and their values to match in request.

path Property Map

Path to match for routing.

headers List<Property Map>

headers and their values to match in request.

NetworkRefResponse

EndpointRefs List<Pulumi.AzureNative.ServiceFabricMesh.Inputs.EndpointRefResponse>

A list of endpoints that are exposed on this network.

Name string

Name of the network

EndpointRefs []EndpointRefResponse

A list of endpoints that are exposed on this network.

Name string

Name of the network

endpointRefs List<EndpointRefResponse>

A list of endpoints that are exposed on this network.

name String

Name of the network

endpointRefs EndpointRefResponse[]

A list of endpoints that are exposed on this network.

name string

Name of the network

endpoint_refs Sequence[EndpointRefResponse]

A list of endpoints that are exposed on this network.

name str

Name of the network

endpointRefs List<Property Map>

A list of endpoints that are exposed on this network.

name String

Name of the network

TcpConfigResponse

Destination Pulumi.AzureNative.ServiceFabricMesh.Inputs.GatewayDestinationResponse

Describes destination endpoint for routing traffic.

Name string

tcp gateway config name.

Port int

Specifies the port at which the service endpoint below needs to be exposed.

Destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

Name string

tcp gateway config name.

Port int

Specifies the port at which the service endpoint below needs to be exposed.

destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

name String

tcp gateway config name.

port Integer

Specifies the port at which the service endpoint below needs to be exposed.

destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

name string

tcp gateway config name.

port number

Specifies the port at which the service endpoint below needs to be exposed.

destination GatewayDestinationResponse

Describes destination endpoint for routing traffic.

name str

tcp gateway config name.

port int

Specifies the port at which the service endpoint below needs to be exposed.

destination Property Map

Describes destination endpoint for routing traffic.

name String

tcp gateway config name.

port Number

Specifies the port at which the service endpoint below needs to be exposed.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0