com.pulumi.azure.apimanagement.kotlin.Gateway.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.apimanagement.kotlin
import com.pulumi.azure.apimanagement.kotlin.outputs.GatewayLocationData
import com.pulumi.azure.apimanagement.kotlin.outputs.GatewayLocationData.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [Gateway].
*/
@PulumiTagMarker
public class GatewayResourceBuilder internal constructor() {
public var name: String? = null
public var args: GatewayArgs = GatewayArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend GatewayArgsBuilder.() -> Unit) {
val builder = GatewayArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Gateway {
val builtJavaResource = com.pulumi.azure.apimanagement.Gateway(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Gateway(builtJavaResource)
}
}
/**
* Manages an API Management Gateway.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleService = new azure.apimanagement.Service("example", {
* name: "example-apim",
* location: example.location,
* resourceGroupName: example.name,
* publisherName: "pub1",
* publisherEmail: "[email protected]",
* skuName: "Consumption_0",
* });
* const exampleGateway = new azure.apimanagement.Gateway("example", {
* name: "example-gateway",
* apiManagementId: exampleService.id,
* description: "Example API Management gateway",
* locationData: {
* name: "example name",
* city: "example city",
* district: "example district",
* region: "example region",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_service = azure.apimanagement.Service("example",
* name="example-apim",
* location=example.location,
* resource_group_name=example.name,
* publisher_name="pub1",
* publisher_email="[email protected]",
* sku_name="Consumption_0")
* example_gateway = azure.apimanagement.Gateway("example",
* name="example-gateway",
* api_management_id=example_service.id,
* description="Example API Management gateway",
* location_data=azure.apimanagement.GatewayLocationDataArgs(
* name="example name",
* city="example city",
* district="example district",
* region="example region",
* ))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleService = new Azure.ApiManagement.Service("example", new()
* {
* Name = "example-apim",
* Location = example.Location,
* ResourceGroupName = example.Name,
* PublisherName = "pub1",
* PublisherEmail = "[email protected]",
* SkuName = "Consumption_0",
* });
* var exampleGateway = new Azure.ApiManagement.Gateway("example", new()
* {
* Name = "example-gateway",
* ApiManagementId = exampleService.Id,
* Description = "Example API Management gateway",
* LocationData = new Azure.ApiManagement.Inputs.GatewayLocationDataArgs
* {
* Name = "example name",
* City = "example city",
* District = "example district",
* Region = "example region",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
* Name: pulumi.String("example-apim"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* PublisherName: pulumi.String("pub1"),
* PublisherEmail: pulumi.String("[email protected]"),
* SkuName: pulumi.String("Consumption_0"),
* })
* if err != nil {
* return err
* }
* _, err = apimanagement.NewGateway(ctx, "example", &apimanagement.GatewayArgs{
* Name: pulumi.String("example-gateway"),
* ApiManagementId: exampleService.ID(),
* Description: pulumi.String("Example API Management gateway"),
* LocationData: &apimanagement.GatewayLocationDataArgs{
* Name: pulumi.String("example name"),
* City: pulumi.String("example city"),
* District: pulumi.String("example district"),
* Region: pulumi.String("example region"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.apimanagement.Service;
* import com.pulumi.azure.apimanagement.ServiceArgs;
* import com.pulumi.azure.apimanagement.Gateway;
* import com.pulumi.azure.apimanagement.GatewayArgs;
* import com.pulumi.azure.apimanagement.inputs.GatewayLocationDataArgs;
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleService = new Service("exampleService", ServiceArgs.builder()
* .name("example-apim")
* .location(example.location())
* .resourceGroupName(example.name())
* .publisherName("pub1")
* .publisherEmail("[email protected]")
* .skuName("Consumption_0")
* .build());
* var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()
* .name("example-gateway")
* .apiManagementId(exampleService.id())
* .description("Example API Management gateway")
* .locationData(GatewayLocationDataArgs.builder()
* .name("example name")
* .city("example city")
* .district("example district")
* .region("example region")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleService:
* type: azure:apimanagement:Service
* name: example
* properties:
* name: example-apim
* location: ${example.location}
* resourceGroupName: ${example.name}
* publisherName: pub1
* publisherEmail: [email protected]
* skuName: Consumption_0
* exampleGateway:
* type: azure:apimanagement:Gateway
* name: example
* properties:
* name: example-gateway
* apiManagementId: ${exampleService.id}
* description: Example API Management gateway
* locationData:
* name: example name
* city: example city
* district: example district
* region: example region
* ```
*
* ## Import
* API Management Gateways can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/gateway:Gateway example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1
* ```
*/
public class Gateway internal constructor(
override val javaResource: com.pulumi.azure.apimanagement.Gateway,
) : KotlinCustomResource(javaResource, GatewayMapper) {
/**
* The ID of the API Management Resource in which the gateway will be created. Changing this forces a new API Management Gateway resource to be created.
*/
public val apiManagementId: Output
get() = javaResource.apiManagementId().applyValue({ args0 -> args0 })
/**
* The description of the API Management Gateway.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A `location_data` block as documented below.
*/
public val locationData: Output
get() = javaResource.locationData().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
/**
* The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
}
public object GatewayMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.apimanagement.Gateway::class == javaResource::class
override fun map(javaResource: Resource): Gateway = Gateway(
javaResource as
com.pulumi.azure.apimanagement.Gateway,
)
}
/**
* @see [Gateway].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Gateway].
*/
public suspend fun gateway(name: String, block: suspend GatewayResourceBuilder.() -> Unit):
Gateway {
val builder = GatewayResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Gateway].
* @param name The _unique_ name of the resulting resource.
*/
public fun gateway(name: String): Gateway {
val builder = GatewayResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy