Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getApiGateway
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.getApiGateway

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets an API Management gateway resource description. Azure REST API version: 2023-09-01-preview.

Other available API versions: 2024-05-01, 2024-06-01-preview.

Using getApiGateway

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 getApiGateway(args: GetApiGatewayArgs, opts?: InvokeOptions): Promise<GetApiGatewayResult>
function getApiGatewayOutput(args: GetApiGatewayOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayResult>
Copy
def get_api_gateway(gateway_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiGatewayResult
def get_api_gateway_output(gateway_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayResult]
Copy
func LookupApiGateway(ctx *Context, args *LookupApiGatewayArgs, opts ...InvokeOption) (*LookupApiGatewayResult, error)
func LookupApiGatewayOutput(ctx *Context, args *LookupApiGatewayOutputArgs, opts ...InvokeOption) LookupApiGatewayResultOutput
Copy

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

public static class GetApiGateway 
{
    public static Task<GetApiGatewayResult> InvokeAsync(GetApiGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayResult> Invoke(GetApiGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiGatewayResult> getApiGateway(GetApiGatewayArgs args, InvokeOptions options)
public static Output<GetApiGatewayResult> getApiGateway(GetApiGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getApiGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getApiGateway Result

The following output properties are available:

CreatedAtUtc string
Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
Etag string
ETag of the resource.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
Sku Pulumi.AzureNative.ApiManagement.Outputs.ApiManagementGatewaySkuPropertiesResponse
SKU properties of the API Management gateway.
SystemData Pulumi.AzureNative.ApiManagement.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TargetProvisioningState string
The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
Type string
Resource type for API Management resource is set to Microsoft.ApiManagement.
Backend Pulumi.AzureNative.ApiManagement.Outputs.BackendConfigurationResponse
Information regarding how the gateway should integrate with backend systems.
ConfigurationApi Pulumi.AzureNative.ApiManagement.Outputs.GatewayConfigurationApiResponse
Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
Frontend Pulumi.AzureNative.ApiManagement.Outputs.FrontendConfigurationResponse
Information regarding how the gateway should be exposed.
Tags Dictionary<string, string>
Resource tags.
VirtualNetworkType string
The type of VPN in which API Management gateway needs to be configured in.
CreatedAtUtc string
Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
Etag string
ETag of the resource.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
Sku ApiManagementGatewaySkuPropertiesResponse
SKU properties of the API Management gateway.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TargetProvisioningState string
The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
Type string
Resource type for API Management resource is set to Microsoft.ApiManagement.
Backend BackendConfigurationResponse
Information regarding how the gateway should integrate with backend systems.
ConfigurationApi GatewayConfigurationApiResponse
Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
Frontend FrontendConfigurationResponse
Information regarding how the gateway should be exposed.
Tags map[string]string
Resource tags.
VirtualNetworkType string
The type of VPN in which API Management gateway needs to be configured in.
createdAtUtc String
Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag String
ETag of the resource.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku ApiManagementGatewaySkuPropertiesResponse
SKU properties of the API Management gateway.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
targetProvisioningState String
The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type String
Resource type for API Management resource is set to Microsoft.ApiManagement.
backend BackendConfigurationResponse
Information regarding how the gateway should integrate with backend systems.
configurationApi GatewayConfigurationApiResponse
Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
frontend FrontendConfigurationResponse
Information regarding how the gateway should be exposed.
tags Map<String,String>
Resource tags.
virtualNetworkType String
The type of VPN in which API Management gateway needs to be configured in.
createdAtUtc string
Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag string
ETag of the resource.
id string
Resource ID.
location string
Resource location.
name string
Resource name.
provisioningState string
The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku ApiManagementGatewaySkuPropertiesResponse
SKU properties of the API Management gateway.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
targetProvisioningState string
The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type string
Resource type for API Management resource is set to Microsoft.ApiManagement.
backend BackendConfigurationResponse
Information regarding how the gateway should integrate with backend systems.
configurationApi GatewayConfigurationApiResponse
Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
frontend FrontendConfigurationResponse
Information regarding how the gateway should be exposed.
tags {[key: string]: string}
Resource tags.
virtualNetworkType string
The type of VPN in which API Management gateway needs to be configured in.
created_at_utc str
Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag str
ETag of the resource.
id str
Resource ID.
location str
Resource location.
name str
Resource name.
provisioning_state str
The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku ApiManagementGatewaySkuPropertiesResponse
SKU properties of the API Management gateway.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
target_provisioning_state str
The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type str
Resource type for API Management resource is set to Microsoft.ApiManagement.
backend BackendConfigurationResponse
Information regarding how the gateway should integrate with backend systems.
configuration_api GatewayConfigurationApiResponse
Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
frontend FrontendConfigurationResponse
Information regarding how the gateway should be exposed.
tags Mapping[str, str]
Resource tags.
virtual_network_type str
The type of VPN in which API Management gateway needs to be configured in.
createdAtUtc String
Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag String
ETag of the resource.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
provisioningState String
The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku Property Map
SKU properties of the API Management gateway.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
targetProvisioningState String
The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type String
Resource type for API Management resource is set to Microsoft.ApiManagement.
backend Property Map
Information regarding how the gateway should integrate with backend systems.
configurationApi Property Map
Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
frontend Property Map
Information regarding how the gateway should be exposed.
tags Map<String>
Resource tags.
virtualNetworkType String
The type of VPN in which API Management gateway needs to be configured in.

Supporting Types

ApiManagementGatewaySkuPropertiesResponse

Name This property is required. string
Name of the Sku.
Capacity int
Capacity of the SKU (number of deployed units of the SKU)
Name This property is required. string
Name of the Sku.
Capacity int
Capacity of the SKU (number of deployed units of the SKU)
name This property is required. String
Name of the Sku.
capacity Integer
Capacity of the SKU (number of deployed units of the SKU)
name This property is required. string
Name of the Sku.
capacity number
Capacity of the SKU (number of deployed units of the SKU)
name This property is required. str
Name of the Sku.
capacity int
Capacity of the SKU (number of deployed units of the SKU)
name This property is required. String
Name of the Sku.
capacity Number
Capacity of the SKU (number of deployed units of the SKU)

BackendConfigurationResponse

Subnet Pulumi.AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationResponse
The default hostname of the data-plane gateway to which requests can be sent.
Subnet BackendSubnetConfigurationResponse
The default hostname of the data-plane gateway to which requests can be sent.
subnet BackendSubnetConfigurationResponse
The default hostname of the data-plane gateway to which requests can be sent.
subnet BackendSubnetConfigurationResponse
The default hostname of the data-plane gateway to which requests can be sent.
subnet BackendSubnetConfigurationResponse
The default hostname of the data-plane gateway to which requests can be sent.
subnet Property Map
The default hostname of the data-plane gateway to which requests can be sent.

BackendSubnetConfigurationResponse

Id string
The ARM ID of the subnet in which the backend systems are hosted.
Id string
The ARM ID of the subnet in which the backend systems are hosted.
id String
The ARM ID of the subnet in which the backend systems are hosted.
id string
The ARM ID of the subnet in which the backend systems are hosted.
id str
The ARM ID of the subnet in which the backend systems are hosted.
id String
The ARM ID of the subnet in which the backend systems are hosted.

FrontendConfigurationResponse

DefaultHostname This property is required. string
The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
DefaultHostname This property is required. string
The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
defaultHostname This property is required. String
The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
defaultHostname This property is required. string
The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
default_hostname This property is required. str
The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
defaultHostname This property is required. String
The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.

GatewayConfigurationApiResponse

Hostname This property is required. string
Hostname to which the agent connects to propagate configuration to the cloud.
Hostname This property is required. string
Hostname to which the agent connects to propagate configuration to the cloud.
hostname This property is required. String
Hostname to which the agent connects to propagate configuration to the cloud.
hostname This property is required. string
Hostname to which the agent connects to propagate configuration to the cloud.
hostname This property is required. str
Hostname to which the agent connects to propagate configuration to the cloud.
hostname This property is required. String
Hostname to which the agent connects to propagate configuration to the cloud.

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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native