All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.apimanagement.kotlin.ApiRelease.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 [ApiRelease].
 */
@PulumiTagMarker
public class ApiReleaseResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ApiReleaseArgs = ApiReleaseArgs()

    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 ApiReleaseArgsBuilder.() -> Unit) {
        val builder = ApiReleaseArgsBuilder()
        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(): ApiRelease {
        val builtJavaResource = com.pulumi.azure.apimanagement.ApiRelease(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return ApiRelease(builtJavaResource)
    }
}

/**
 * Manages a API Management API Release.
 * ## 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: "My Company",
 *     publisherEmail: "[email protected]",
 *     skuName: "Developer_1",
 * });
 * const exampleApi = new azure.apimanagement.Api("example", {
 *     name: "example-api",
 *     resourceGroupName: example.name,
 *     apiManagementName: exampleService.name,
 *     revision: "1",
 *     displayName: "Example API",
 *     path: "example",
 *     protocols: ["https"],
 *     "import": {
 *         contentFormat: "swagger-link-json",
 *         contentValue: "http://conferenceapi.azurewebsites.net/?format=json",
 *     },
 * });
 * const exampleApiRelease = new azure.apimanagement.ApiRelease("example", {
 *     name: "example-Api-Release",
 *     apiId: exampleApi.id,
 * });
 * ```
 * ```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="My Company",
 *     publisher_email="[email protected]",
 *     sku_name="Developer_1")
 * example_api = azure.apimanagement.Api("example",
 *     name="example-api",
 *     resource_group_name=example.name,
 *     api_management_name=example_service.name,
 *     revision="1",
 *     display_name="Example API",
 *     path="example",
 *     protocols=["https"],
 *     import_={
 *         "content_format": "swagger-link-json",
 *         "content_value": "http://conferenceapi.azurewebsites.net/?format=json",
 *     })
 * example_api_release = azure.apimanagement.ApiRelease("example",
 *     name="example-Api-Release",
 *     api_id=example_api.id)
 * ```
 * ```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 = "My Company",
 *         PublisherEmail = "[email protected]",
 *         SkuName = "Developer_1",
 *     });
 *     var exampleApi = new Azure.ApiManagement.Api("example", new()
 *     {
 *         Name = "example-api",
 *         ResourceGroupName = example.Name,
 *         ApiManagementName = exampleService.Name,
 *         Revision = "1",
 *         DisplayName = "Example API",
 *         Path = "example",
 *         Protocols = new[]
 *         {
 *             "https",
 *         },
 *         Import = new Azure.ApiManagement.Inputs.ApiImportArgs
 *         {
 *             ContentFormat = "swagger-link-json",
 *             ContentValue = "http://conferenceapi.azurewebsites.net/?format=json",
 *         },
 *     });
 *     var exampleApiRelease = new Azure.ApiManagement.ApiRelease("example", new()
 *     {
 *         Name = "example-Api-Release",
 *         ApiId = exampleApi.Id,
 *     });
 * });
 * ```
 * ```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("My Company"),
 * 			PublisherEmail:    pulumi.String("[email protected]"),
 * 			SkuName:           pulumi.String("Developer_1"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleApi, err := apimanagement.NewApi(ctx, "example", &apimanagement.ApiArgs{
 * 			Name:              pulumi.String("example-api"),
 * 			ResourceGroupName: example.Name,
 * 			ApiManagementName: exampleService.Name,
 * 			Revision:          pulumi.String("1"),
 * 			DisplayName:       pulumi.String("Example API"),
 * 			Path:              pulumi.String("example"),
 * 			Protocols: pulumi.StringArray{
 * 				pulumi.String("https"),
 * 			},
 * 			Import: &apimanagement.ApiImportArgs{
 * 				ContentFormat: pulumi.String("swagger-link-json"),
 * 				ContentValue:  pulumi.String("http://conferenceapi.azurewebsites.net/?format=json"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = apimanagement.NewApiRelease(ctx, "example", &apimanagement.ApiReleaseArgs{
 * 			Name:  pulumi.String("example-Api-Release"),
 * 			ApiId: exampleApi.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.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.Api;
 * import com.pulumi.azure.apimanagement.ApiArgs;
 * import com.pulumi.azure.apimanagement.inputs.ApiImportArgs;
 * import com.pulumi.azure.apimanagement.ApiRelease;
 * import com.pulumi.azure.apimanagement.ApiReleaseArgs;
 * 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("My Company")
 *             .publisherEmail("[email protected]")
 *             .skuName("Developer_1")
 *             .build());
 *         var exampleApi = new Api("exampleApi", ApiArgs.builder()
 *             .name("example-api")
 *             .resourceGroupName(example.name())
 *             .apiManagementName(exampleService.name())
 *             .revision("1")
 *             .displayName("Example API")
 *             .path("example")
 *             .protocols("https")
 *             .import_(ApiImportArgs.builder()
 *                 .contentFormat("swagger-link-json")
 *                 .contentValue("http://conferenceapi.azurewebsites.net/?format=json")
 *                 .build())
 *             .build());
 *         var exampleApiRelease = new ApiRelease("exampleApiRelease", ApiReleaseArgs.builder()
 *             .name("example-Api-Release")
 *             .apiId(exampleApi.id())
 *             .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: My Company
 *       publisherEmail: [email protected]
 *       skuName: Developer_1
 *   exampleApi:
 *     type: azure:apimanagement:Api
 *     name: example
 *     properties:
 *       name: example-api
 *       resourceGroupName: ${example.name}
 *       apiManagementName: ${exampleService.name}
 *       revision: '1'
 *       displayName: Example API
 *       path: example
 *       protocols:
 *         - https
 *       import:
 *         contentFormat: swagger-link-json
 *         contentValue: http://conferenceapi.azurewebsites.net/?format=json
 *   exampleApiRelease:
 *     type: azure:apimanagement:ApiRelease
 *     name: example
 *     properties:
 *       name: example-Api-Release
 *       apiId: ${exampleApi.id}
 * ```
 * 
 * ## Import
 * API Management API Releases can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:apimanagement/apiRelease:ApiRelease example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/apis/api1/releases/release1
 * ```
 */
public class ApiRelease internal constructor(
    override val javaResource: com.pulumi.azure.apimanagement.ApiRelease,
) : KotlinCustomResource(javaResource, ApiReleaseMapper) {
    /**
     * The ID of the API Management API. Changing this forces a new API Management API Release to be created.
     */
    public val apiId: Output
        get() = javaResource.apiId().applyValue({ args0 -> args0 })

    /**
     * The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The Release Notes.
     */
    public val notes: Output?
        get() = javaResource.notes().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}

public object ApiReleaseMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.apimanagement.ApiRelease::class == javaResource::class

    override fun map(javaResource: Resource): ApiRelease = ApiRelease(
        javaResource as
            com.pulumi.azure.apimanagement.ApiRelease,
    )
}

/**
 * @see [ApiRelease].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [ApiRelease].
 */
public suspend fun apiRelease(name: String, block: suspend ApiReleaseResourceBuilder.() -> Unit): ApiRelease {
    val builder = ApiReleaseResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [ApiRelease].
 * @param name The _unique_ name of the resulting resource.
 */
public fun apiRelease(name: String): ApiRelease {
    val builder = ApiReleaseResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy