1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getApiGatewayConfigConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.apimanagement.getApiGatewayConfigConnection

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets an API Management gateway config connection resource description.

    Uses Azure REST API version 2024-05-01.

    Other available API versions: 2023-09-01-preview, 2024-06-01-preview, 2024-10-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

    Using getApiGatewayConfigConnection

    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 getApiGatewayConfigConnection(args: GetApiGatewayConfigConnectionArgs, opts?: InvokeOptions): Promise<GetApiGatewayConfigConnectionResult>
function getApiGatewayConfigConnectionOutput(args: GetApiGatewayConfigConnectionOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayConfigConnectionResult>
    def get_api_gateway_config_connection(config_connection_name: Optional[str] = None,
                                      gateway_name: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetApiGatewayConfigConnectionResult
def get_api_gateway_config_connection_output(config_connection_name: Optional[pulumi.Input[str]] = None,
                                      gateway_name: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayConfigConnectionResult]
    func LookupApiGatewayConfigConnection(ctx *Context, args *LookupApiGatewayConfigConnectionArgs, opts ...InvokeOption) (*LookupApiGatewayConfigConnectionResult, error)
func LookupApiGatewayConfigConnectionOutput(ctx *Context, args *LookupApiGatewayConfigConnectionOutputArgs, opts ...InvokeOption) LookupApiGatewayConfigConnectionResultOutput

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

    public static class GetApiGatewayConfigConnection 
{
    public static Task<GetApiGatewayConfigConnectionResult> InvokeAsync(GetApiGatewayConfigConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayConfigConnectionResult> Invoke(GetApiGatewayConfigConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiGatewayConfigConnectionResult> getApiGatewayConfigConnection(GetApiGatewayConfigConnectionArgs args, InvokeOptions options)
public static Output<GetApiGatewayConfigConnectionResult> getApiGatewayConfigConnection(GetApiGatewayConfigConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:apimanagement:getApiGatewayConfigConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConfigConnectionName string
    The name of the API Management gateway config connection.
    GatewayName string
    The name of the API Management gateway.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ConfigConnectionName string
    The name of the API Management gateway config connection.
    GatewayName string
    The name of the API Management gateway.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    configConnectionName String
    The name of the API Management gateway config connection.
    gatewayName String
    The name of the API Management gateway.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    configConnectionName string
    The name of the API Management gateway config connection.
    gatewayName string
    The name of the API Management gateway.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    config_connection_name str
    The name of the API Management gateway config connection.
    gateway_name str
    The name of the API Management gateway.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    configConnectionName String
    The name of the API Management gateway config connection.
    gatewayName String
    The name of the API Management gateway.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getApiGatewayConfigConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    DefaultHostname string
    The default hostname of the data-plane gateway.
    Etag string
    ETag of the resource.
    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 API Management gateway config connection
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Hostnames List<string>
    The hostnames of the data-plane gateway to which requests can be sent.
    SourceId string
    The link to the API Management service workspace.
    AzureApiVersion string
    The Azure API version of the resource.
    DefaultHostname string
    The default hostname of the data-plane gateway.
    Etag string
    ETag of the resource.
    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 API Management gateway config connection
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Hostnames []string
    The hostnames of the data-plane gateway to which requests can be sent.
    SourceId string
    The link to the API Management service workspace.
    azureApiVersion String
    The Azure API version of the resource.
    defaultHostname String
    The default hostname of the data-plane gateway.
    etag String
    ETag of the resource.
    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 API Management gateway config connection
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hostnames List<String>
    The hostnames of the data-plane gateway to which requests can be sent.
    sourceId String
    The link to the API Management service workspace.
    azureApiVersion string
    The Azure API version of the resource.
    defaultHostname string
    The default hostname of the data-plane gateway.
    etag string
    ETag of the resource.
    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 API Management gateway config connection
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hostnames string[]
    The hostnames of the data-plane gateway to which requests can be sent.
    sourceId string
    The link to the API Management service workspace.
    azure_api_version str
    The Azure API version of the resource.
    default_hostname str
    The default hostname of the data-plane gateway.
    etag str
    ETag of the resource.
    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 API Management gateway config connection
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hostnames Sequence[str]
    The hostnames of the data-plane gateway to which requests can be sent.
    source_id str
    The link to the API Management service workspace.
    azureApiVersion String
    The Azure API version of the resource.
    defaultHostname String
    The default hostname of the data-plane gateway.
    etag String
    ETag of the resource.
    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 API Management gateway config connection
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hostnames List<String>
    The hostnames of the data-plane gateway to which requests can be sent.
    sourceId String
    The link to the API Management service workspace.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.