1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ApiGatewayConfigConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

azure-native.apimanagement.ApiGatewayConfigConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

    A single API Management gateway resource in List or Get response. Azure REST API version: 2023-09-01-preview.

    Example Usage

    ApiManagementCreateGatewayConfigConnection

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var apiGatewayConfigConnection = new AzureNative.ApiManagement.ApiGatewayConfigConnection("apiGatewayConfigConnection", new()
        {
            ConfigConnectionName = "gcc-01",
            GatewayName = "standard-gw-01",
            ResourceGroupName = "rg1",
            SourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
        });
    
    });
    
    package main
    
    import (
    	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apimanagement.NewApiGatewayConfigConnection(ctx, "apiGatewayConfigConnection", &apimanagement.ApiGatewayConfigConnectionArgs{
    			ConfigConnectionName: pulumi.String("gcc-01"),
    			GatewayName:          pulumi.String("standard-gw-01"),
    			ResourceGroupName:    pulumi.String("rg1"),
    			SourceId:             pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.apimanagement.ApiGatewayConfigConnection;
    import com.pulumi.azurenative.apimanagement.ApiGatewayConfigConnectionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var apiGatewayConfigConnection = new ApiGatewayConfigConnection("apiGatewayConfigConnection", ApiGatewayConfigConnectionArgs.builder()
                .configConnectionName("gcc-01")
                .gatewayName("standard-gw-01")
                .resourceGroupName("rg1")
                .sourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    api_gateway_config_connection = azure_native.apimanagement.ApiGatewayConfigConnection("apiGatewayConfigConnection",
        config_connection_name="gcc-01",
        gateway_name="standard-gw-01",
        resource_group_name="rg1",
        source_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const apiGatewayConfigConnection = new azure_native.apimanagement.ApiGatewayConfigConnection("apiGatewayConfigConnection", {
        configConnectionName: "gcc-01",
        gatewayName: "standard-gw-01",
        resourceGroupName: "rg1",
        sourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
    });
    
    resources:
      apiGatewayConfigConnection:
        type: azure-native:apimanagement:ApiGatewayConfigConnection
        properties:
          configConnectionName: gcc-01
          gatewayName: standard-gw-01
          resourceGroupName: rg1
          sourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001
    

    Create ApiGatewayConfigConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiGatewayConfigConnection(name: string, args: ApiGatewayConfigConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def ApiGatewayConfigConnection(resource_name: str,
                                   args: ApiGatewayConfigConnectionArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApiGatewayConfigConnection(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   gateway_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   config_connection_name: Optional[str] = None,
                                   hostnames: Optional[Sequence[str]] = None,
                                   source_id: Optional[str] = None)
    func NewApiGatewayConfigConnection(ctx *Context, name string, args ApiGatewayConfigConnectionArgs, opts ...ResourceOption) (*ApiGatewayConfigConnection, error)
    public ApiGatewayConfigConnection(string name, ApiGatewayConfigConnectionArgs args, CustomResourceOptions? opts = null)
    public ApiGatewayConfigConnection(String name, ApiGatewayConfigConnectionArgs args)
    public ApiGatewayConfigConnection(String name, ApiGatewayConfigConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:ApiGatewayConfigConnection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApiGatewayConfigConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiGatewayConfigConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiGatewayConfigConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayConfigConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayConfigConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiGatewayConfigConnectionResource = new AzureNative.ApiManagement.ApiGatewayConfigConnection("apiGatewayConfigConnectionResource", new()
    {
        GatewayName = "string",
        ResourceGroupName = "string",
        ConfigConnectionName = "string",
        Hostnames = new[]
        {
            "string",
        },
        SourceId = "string",
    });
    
    example, err := apimanagement.NewApiGatewayConfigConnection(ctx, "apiGatewayConfigConnectionResource", &apimanagement.ApiGatewayConfigConnectionArgs{
    	GatewayName:          pulumi.String("string"),
    	ResourceGroupName:    pulumi.String("string"),
    	ConfigConnectionName: pulumi.String("string"),
    	Hostnames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SourceId: pulumi.String("string"),
    })
    
    var apiGatewayConfigConnectionResource = new ApiGatewayConfigConnection("apiGatewayConfigConnectionResource", ApiGatewayConfigConnectionArgs.builder()
        .gatewayName("string")
        .resourceGroupName("string")
        .configConnectionName("string")
        .hostnames("string")
        .sourceId("string")
        .build());
    
    api_gateway_config_connection_resource = azure_native.apimanagement.ApiGatewayConfigConnection("apiGatewayConfigConnectionResource",
        gateway_name="string",
        resource_group_name="string",
        config_connection_name="string",
        hostnames=["string"],
        source_id="string")
    
    const apiGatewayConfigConnectionResource = new azure_native.apimanagement.ApiGatewayConfigConnection("apiGatewayConfigConnectionResource", {
        gatewayName: "string",
        resourceGroupName: "string",
        configConnectionName: "string",
        hostnames: ["string"],
        sourceId: "string",
    });
    
    type: azure-native:apimanagement:ApiGatewayConfigConnection
    properties:
        configConnectionName: string
        gatewayName: string
        hostnames:
            - string
        resourceGroupName: string
        sourceId: string
    

    ApiGatewayConfigConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApiGatewayConfigConnection resource accepts the following input properties:

    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    config_connection_name str
    The name of the API Management gateway config connection.
    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.
    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.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiGatewayConfigConnection resource produces the following output properties:

    DefaultHostname string
    The default hostname of the data-plane gateway.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    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"
    DefaultHostname string
    The default hostname of the data-plane gateway.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    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"
    defaultHostname String
    The default hostname of the data-plane gateway.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    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"
    defaultHostname string
    The default hostname of the data-plane gateway.
    etag string
    ETag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    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"
    default_hostname str
    The default hostname of the data-plane gateway.
    etag str
    ETag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    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"
    defaultHostname String
    The default hostname of the data-plane gateway.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    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"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:ApiGatewayConfigConnection gcc-1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi