← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

Source code

getGateway

Gateway details. API Version: 2020-12-01.

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_id: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_id: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                service_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:apimanagement:getGateway
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GatewayId string: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.

GatewayId string: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.

gatewayId String: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.

gatewayId string: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.

gateway_id str: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.

gatewayId String: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.

getGateway Result

The following output properties are available:

Id string: Resource ID.
Name string: Resource name.
Type string: Resource type for API Management resource.
Description string: Gateway description
LocationData Pulumi.AzureNative.ApiManagement.Outputs.ResourceLocationDataContractResponse: Gateway location.

Id string: Resource ID.
Name string: Resource name.
Type string: Resource type for API Management resource.
Description string: Gateway description
LocationData ResourceLocationDataContractResponse: Gateway location.

id String: Resource ID.
name String: Resource name.
type String: Resource type for API Management resource.
description String: Gateway description
locationData ResourceLocationDataContractResponse: Gateway location.

id string: Resource ID.
name string: Resource name.
type string: Resource type for API Management resource.
description string: Gateway description
locationData ResourceLocationDataContractResponse: Gateway location.

id str: Resource ID.
name str: Resource name.
type str: Resource type for API Management resource.
description str: Gateway description
location_data ResourceLocationDataContractResponse: Gateway location.

id String: Resource ID.
name String: Resource name.
type String: Resource type for API Management resource.
description String: Gateway description
locationData Property Map: Gateway location.

Supporting Types

ResourceLocationDataContractResponse

Name string: A canonical name for the geographic or physical location.
City string: The city or locality where the resource is located.
CountryOrRegion string: The country or region where the resource is located.
District string: The district, state, or province where the resource is located.

Name string: A canonical name for the geographic or physical location.
City string: The city or locality where the resource is located.
CountryOrRegion string: The country or region where the resource is located.
District string: The district, state, or province where the resource is located.

name String: A canonical name for the geographic or physical location.
city String: The city or locality where the resource is located.
countryOrRegion String: The country or region where the resource is located.
district String: The district, state, or province where the resource is located.

name string: A canonical name for the geographic or physical location.
city string: The city or locality where the resource is located.
countryOrRegion string: The country or region where the resource is located.
district string: The district, state, or province where the resource is located.

name str: A canonical name for the geographic or physical location.
city str: The city or locality where the resource is located.
country_or_region str: The country or region where the resource is located.
district str: The district, state, or province where the resource is located.

name String: A canonical name for the geographic or physical location.
city String: The city or locality where the resource is located.
countryOrRegion String: The country or region where the resource is located.
district String: The district, state, or province where the resource is located.

Package Details

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