com.pulumi.azure.apimanagement.kotlin.GatewayApi.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.apimanagement.kotlin
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 [GatewayApi].
*/
@PulumiTagMarker
public class GatewayApiResourceBuilder internal constructor() {
public var name: String? = null
public var args: GatewayApiArgs = GatewayApiArgs()
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 GatewayApiArgsBuilder.() -> Unit) {
val builder = GatewayApiArgsBuilder()
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(): GatewayApi {
val builtJavaResource = com.pulumi.azure.apimanagement.GatewayApi(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return GatewayApi(builtJavaResource)
}
}
/**
* Manages a API Management Gateway API.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = azure.apimanagement.getService({
* name: "example-api",
* resourceGroupName: "example-resources",
* });
* const exampleGetApi = Promise.all([example, example]).then(([example, example1]) => azure.apimanagement.getApi({
* name: "search-api",
* apiManagementName: example.name,
* resourceGroupName: example1.resourceGroupName,
* revision: "2",
* }));
* const exampleGetGateway = example.then(example => azure.apimanagement.getGateway({
* name: "example-gateway",
* apiManagementId: example.id,
* }));
* const exampleGatewayApi = new azure.apimanagement.GatewayApi("example", {
* gatewayId: exampleGetGateway.then(exampleGetGateway => exampleGetGateway.id),
* apiId: exampleGetApi.then(exampleGetApi => exampleGetApi.id),
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.apimanagement.get_service(name="example-api",
* resource_group_name="example-resources")
* example_get_api = azure.apimanagement.get_api(name="search-api",
* api_management_name=example.name,
* resource_group_name=example.resource_group_name,
* revision="2")
* example_get_gateway = azure.apimanagement.get_gateway(name="example-gateway",
* api_management_id=example.id)
* example_gateway_api = azure.apimanagement.GatewayApi("example",
* gateway_id=example_get_gateway.id,
* api_id=example_get_api.id)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = Azure.ApiManagement.GetService.Invoke(new()
* {
* Name = "example-api",
* ResourceGroupName = "example-resources",
* });
* var exampleGetApi = Azure.ApiManagement.GetApi.Invoke(new()
* {
* Name = "search-api",
* ApiManagementName = example.Apply(getServiceResult => getServiceResult.Name),
* ResourceGroupName = example.Apply(getServiceResult => getServiceResult.ResourceGroupName),
* Revision = "2",
* });
* var exampleGetGateway = Azure.ApiManagement.GetGateway.Invoke(new()
* {
* Name = "example-gateway",
* ApiManagementId = example.Apply(getServiceResult => getServiceResult.Id),
* });
* var exampleGatewayApi = new Azure.ApiManagement.GatewayApi("example", new()
* {
* GatewayId = exampleGetGateway.Apply(getGatewayResult => getGatewayResult.Id),
* ApiId = exampleGetApi.Apply(getApiResult => getApiResult.Id),
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := apimanagement.LookupService(ctx, &apimanagement.LookupServiceArgs{
* Name: "example-api",
* ResourceGroupName: "example-resources",
* }, nil)
* if err != nil {
* return err
* }
* exampleGetApi, err := apimanagement.LookupApi(ctx, &apimanagement.LookupApiArgs{
* Name: "search-api",
* ApiManagementName: example.Name,
* ResourceGroupName: example.ResourceGroupName,
* Revision: "2",
* }, nil)
* if err != nil {
* return err
* }
* exampleGetGateway, err := apimanagement.LookupGateway(ctx, &apimanagement.LookupGatewayArgs{
* Name: "example-gateway",
* ApiManagementId: example.Id,
* }, nil)
* if err != nil {
* return err
* }
* _, err = apimanagement.NewGatewayApi(ctx, "example", &apimanagement.GatewayApiArgs{
* GatewayId: pulumi.String(exampleGetGateway.Id),
* ApiId: pulumi.String(exampleGetApi.Id),
* })
* 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.apimanagement.ApimanagementFunctions;
* import com.pulumi.azure.apimanagement.inputs.GetServiceArgs;
* import com.pulumi.azure.apimanagement.inputs.GetApiArgs;
* import com.pulumi.azure.apimanagement.inputs.GetGatewayArgs;
* import com.pulumi.azure.apimanagement.GatewayApi;
* import com.pulumi.azure.apimanagement.GatewayApiArgs;
* 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) {
* final var example = ApimanagementFunctions.getService(GetServiceArgs.builder()
* .name("example-api")
* .resourceGroupName("example-resources")
* .build());
* final var exampleGetApi = ApimanagementFunctions.getApi(GetApiArgs.builder()
* .name("search-api")
* .apiManagementName(example.applyValue(getServiceResult -> getServiceResult.name()))
* .resourceGroupName(example.applyValue(getServiceResult -> getServiceResult.resourceGroupName()))
* .revision("2")
* .build());
* final var exampleGetGateway = ApimanagementFunctions.getGateway(GetGatewayArgs.builder()
* .name("example-gateway")
* .apiManagementId(example.applyValue(getServiceResult -> getServiceResult.id()))
* .build());
* var exampleGatewayApi = new GatewayApi("exampleGatewayApi", GatewayApiArgs.builder()
* .gatewayId(exampleGetGateway.applyValue(getGatewayResult -> getGatewayResult.id()))
* .apiId(exampleGetApi.applyValue(getApiResult -> getApiResult.id()))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* exampleGatewayApi:
* type: azure:apimanagement:GatewayApi
* name: example
* properties:
* gatewayId: ${exampleGetGateway.id}
* apiId: ${exampleGetApi.id}
* variables:
* example:
* fn::invoke:
* Function: azure:apimanagement:getService
* Arguments:
* name: example-api
* resourceGroupName: example-resources
* exampleGetApi:
* fn::invoke:
* Function: azure:apimanagement:getApi
* Arguments:
* name: search-api
* apiManagementName: ${example.name}
* resourceGroupName: ${example.resourceGroupName}
* revision: '2'
* exampleGetGateway:
* fn::invoke:
* Function: azure:apimanagement:getGateway
* Arguments:
* name: example-gateway
* apiManagementId: ${example.id}
* ```
*
* ## Import
* API Management Gateway APIs can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/gatewayApi:GatewayApi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1/apis/api1
* ```
*/
public class GatewayApi internal constructor(
override val javaResource: com.pulumi.azure.apimanagement.GatewayApi,
) : KotlinCustomResource(javaResource, GatewayApiMapper) {
/**
* The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.
*/
public val apiId: Output
get() = javaResource.apiId().applyValue({ args0 -> args0 })
/**
* The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.
*/
public val gatewayId: Output
get() = javaResource.gatewayId().applyValue({ args0 -> args0 })
}
public object GatewayApiMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.apimanagement.GatewayApi::class == javaResource::class
override fun map(javaResource: Resource): GatewayApi = GatewayApi(
javaResource as
com.pulumi.azure.apimanagement.GatewayApi,
)
}
/**
* @see [GatewayApi].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [GatewayApi].
*/
public suspend fun gatewayApi(name: String, block: suspend GatewayApiResourceBuilder.() -> Unit):
GatewayApi {
val builder = GatewayApiResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [GatewayApi].
* @param name The _unique_ name of the resulting resource.
*/
public fun gatewayApi(name: String): GatewayApi {
val builder = GatewayApiResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy