com.pulumi.azurenative.apimanagement.kotlin.ApiGateway.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-native-kotlin Show documentation
Show all versions of pulumi-azure-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azurenative.apimanagement.kotlin
import com.pulumi.azurenative.apimanagement.kotlin.outputs.ApiManagementGatewaySkuPropertiesResponse
import com.pulumi.azurenative.apimanagement.kotlin.outputs.BackendConfigurationResponse
import com.pulumi.azurenative.apimanagement.kotlin.outputs.FrontendConfigurationResponse
import com.pulumi.azurenative.apimanagement.kotlin.outputs.GatewayConfigurationApiResponse
import com.pulumi.azurenative.apimanagement.kotlin.outputs.SystemDataResponse
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
import kotlin.collections.Map
import com.pulumi.azurenative.apimanagement.kotlin.outputs.ApiManagementGatewaySkuPropertiesResponse.Companion.toKotlin as apiManagementGatewaySkuPropertiesResponseToKotlin
import com.pulumi.azurenative.apimanagement.kotlin.outputs.BackendConfigurationResponse.Companion.toKotlin as backendConfigurationResponseToKotlin
import com.pulumi.azurenative.apimanagement.kotlin.outputs.FrontendConfigurationResponse.Companion.toKotlin as frontendConfigurationResponseToKotlin
import com.pulumi.azurenative.apimanagement.kotlin.outputs.GatewayConfigurationApiResponse.Companion.toKotlin as gatewayConfigurationApiResponseToKotlin
import com.pulumi.azurenative.apimanagement.kotlin.outputs.SystemDataResponse.Companion.toKotlin as systemDataResponseToKotlin
/**
* Builder for [ApiGateway].
*/
@PulumiTagMarker
public class ApiGatewayResourceBuilder internal constructor() {
public var name: String? = null
public var args: ApiGatewayArgs = ApiGatewayArgs()
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 ApiGatewayArgsBuilder.() -> Unit) {
val builder = ApiGatewayArgsBuilder()
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(): ApiGateway {
val builtJavaResource = com.pulumi.azurenative.apimanagement.ApiGateway(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ApiGateway(builtJavaResource)
}
}
/**
* A single API Management gateway resource in List or Get response.
* Azure REST API version: 2023-09-01-preview.
* Other available API versions: 2024-05-01.
* ## Example Usage
* ### ApiManagementCreateStandardGateway
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var apiGateway = new AzureNative.ApiManagement.ApiGateway("apiGateway", new()
* {
* Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
* {
* Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
* {
* Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
* },
* },
* GatewayName = "apimGateway1",
* Location = "South Central US",
* ResourceGroupName = "rg1",
* Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
* {
* Capacity = 1,
* Name = AzureNative.ApiManagement.SkuType.Standard,
* },
* Tags =
* {
* { "Name", "Contoso" },
* { "Test", "User" },
* },
* });
* });
* ```
* ```go
* 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.NewApiGateway(ctx, "apiGateway", &apimanagement.ApiGatewayArgs{
* Backend: &apimanagement.BackendConfigurationArgs{
* Subnet: &apimanagement.BackendSubnetConfigurationArgs{
* Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"),
* },
* },
* GatewayName: pulumi.String("apimGateway1"),
* Location: pulumi.String("South Central US"),
* ResourceGroupName: pulumi.String("rg1"),
* Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
* Capacity: pulumi.Int(1),
* Name: pulumi.String(apimanagement.SkuTypeStandard),
* },
* Tags: pulumi.StringMap{
* "Name": pulumi.String("Contoso"),
* "Test": pulumi.String("User"),
* },
* })
* 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.azurenative.apimanagement.ApiGateway;
* import com.pulumi.azurenative.apimanagement.ApiGatewayArgs;
* import com.pulumi.azurenative.apimanagement.inputs.BackendConfigurationArgs;
* import com.pulumi.azurenative.apimanagement.inputs.BackendSubnetConfigurationArgs;
* import com.pulumi.azurenative.apimanagement.inputs.ApiManagementGatewaySkuPropertiesArgs;
* 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 apiGateway = new ApiGateway("apiGateway", ApiGatewayArgs.builder()
* .backend(BackendConfigurationArgs.builder()
* .subnet(BackendSubnetConfigurationArgs.builder()
* .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1")
* .build())
* .build())
* .gatewayName("apimGateway1")
* .location("South Central US")
* .resourceGroupName("rg1")
* .sku(ApiManagementGatewaySkuPropertiesArgs.builder()
* .capacity(1)
* .name("Standard")
* .build())
* .tags(Map.ofEntries(
* Map.entry("Name", "Contoso"),
* Map.entry("Test", "User")
* ))
* .build());
* }
* }
* ```
* ### ApiManagementCreateWorkspacePremiumGateway
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var apiGateway = new AzureNative.ApiManagement.ApiGateway("apiGateway", new()
* {
* Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
* {
* Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
* {
* Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
* },
* },
* GatewayName = "apimGateway1",
* Location = "South Central US",
* ResourceGroupName = "rg1",
* Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
* {
* Capacity = 1,
* Name = "WorkspaceGatewayPremium",
* },
* Tags =
* {
* { "Name", "Contoso" },
* { "Test", "User" },
* },
* VirtualNetworkType = AzureNative.ApiManagement.VirtualNetworkType.External,
* });
* });
* ```
* ```go
* 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.NewApiGateway(ctx, "apiGateway", &apimanagement.ApiGatewayArgs{
* Backend: &apimanagement.BackendConfigurationArgs{
* Subnet: &apimanagement.BackendSubnetConfigurationArgs{
* Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"),
* },
* },
* GatewayName: pulumi.String("apimGateway1"),
* Location: pulumi.String("South Central US"),
* ResourceGroupName: pulumi.String("rg1"),
* Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
* Capacity: pulumi.Int(1),
* Name: pulumi.String("WorkspaceGatewayPremium"),
* },
* Tags: pulumi.StringMap{
* "Name": pulumi.String("Contoso"),
* "Test": pulumi.String("User"),
* },
* VirtualNetworkType: pulumi.String(apimanagement.VirtualNetworkTypeExternal),
* })
* 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.azurenative.apimanagement.ApiGateway;
* import com.pulumi.azurenative.apimanagement.ApiGatewayArgs;
* import com.pulumi.azurenative.apimanagement.inputs.BackendConfigurationArgs;
* import com.pulumi.azurenative.apimanagement.inputs.BackendSubnetConfigurationArgs;
* import com.pulumi.azurenative.apimanagement.inputs.ApiManagementGatewaySkuPropertiesArgs;
* 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 apiGateway = new ApiGateway("apiGateway", ApiGatewayArgs.builder()
* .backend(BackendConfigurationArgs.builder()
* .subnet(BackendSubnetConfigurationArgs.builder()
* .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1")
* .build())
* .build())
* .gatewayName("apimGateway1")
* .location("South Central US")
* .resourceGroupName("rg1")
* .sku(ApiManagementGatewaySkuPropertiesArgs.builder()
* .capacity(1)
* .name("WorkspaceGatewayPremium")
* .build())
* .tags(Map.ofEntries(
* Map.entry("Name", "Contoso"),
* Map.entry("Test", "User")
* ))
* .virtualNetworkType("External")
* .build());
* }
* }
* ```
* ## Import
* An existing resource can be imported using its type token, name, and identifier, e.g.
* ```sh
* $ pulumi import azure-native:apimanagement:ApiGateway apimGateway1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
* ```
*/
public class ApiGateway internal constructor(
override val javaResource: com.pulumi.azurenative.apimanagement.ApiGateway,
) : KotlinCustomResource(javaResource, ApiGatewayMapper) {
/**
* Information regarding how the gateway should integrate with backend systems.
*/
public val backend: Output?
get() = javaResource.backend().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
backendConfigurationResponseToKotlin(args0)
})
}).orElse(null)
})
/**
* Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
*/
public val configurationApi: Output?
get() = javaResource.configurationApi().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> gatewayConfigurationApiResponseToKotlin(args0) })
}).orElse(null)
})
/**
* 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.
*/
public val createdAtUtc: Output
get() = javaResource.createdAtUtc().applyValue({ args0 -> args0 })
/**
* ETag of the resource.
*/
public val etag: Output
get() = javaResource.etag().applyValue({ args0 -> args0 })
/**
* Information regarding how the gateway should be exposed.
*/
public val frontend: Output?
get() = javaResource.frontend().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
frontendConfigurationResponseToKotlin(args0)
})
}).orElse(null)
})
/**
* Resource location.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Resource name.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val provisioningState: Output
get() = javaResource.provisioningState().applyValue({ args0 -> args0 })
/**
* SKU properties of the API Management gateway.
*/
public val sku: Output
get() = javaResource.sku().applyValue({ args0 ->
args0.let({ args0 ->
apiManagementGatewaySkuPropertiesResponseToKotlin(args0)
})
})
/**
* Metadata pertaining to creation and last modification of the resource.
*/
public val systemData: Output
get() = javaResource.systemData().applyValue({ args0 ->
args0.let({ args0 ->
systemDataResponseToKotlin(args0)
})
})
/**
* Resource tags.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
*/
public val targetProvisioningState: Output
get() = javaResource.targetProvisioningState().applyValue({ args0 -> args0 })
/**
* Resource type for API Management resource is set to Microsoft.ApiManagement.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* The type of VPN in which API Management gateway needs to be configured in.
*/
public val virtualNetworkType: Output?
get() = javaResource.virtualNetworkType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object ApiGatewayMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azurenative.apimanagement.ApiGateway::class == javaResource::class
override fun map(javaResource: Resource): ApiGateway = ApiGateway(
javaResource as
com.pulumi.azurenative.apimanagement.ApiGateway,
)
}
/**
* @see [ApiGateway].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ApiGateway].
*/
public suspend fun apiGateway(name: String, block: suspend ApiGatewayResourceBuilder.() -> Unit): ApiGateway {
val builder = ApiGatewayResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ApiGateway].
* @param name The _unique_ name of the resulting resource.
*/
public fun apiGateway(name: String): ApiGateway {
val builder = ApiGatewayResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy