Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.azure.apimanagement.kotlin.Product.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.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [Product].
*/
@PulumiTagMarker
public class ProductResourceBuilder internal constructor() {
public var name: String? = null
public var args: ProductArgs = ProductArgs()
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 ProductArgsBuilder.() -> Unit) {
val builder = ProductArgsBuilder()
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(): Product {
val builtJavaResource = com.pulumi.azure.apimanagement.Product(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Product(builtJavaResource)
}
}
/**
* Manages an API Management Product.
* ## 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 exampleProduct = new azure.apimanagement.Product("example", {
* productId: "test-product",
* apiManagementName: exampleService.name,
* resourceGroupName: example.name,
* displayName: "Test Product",
* subscriptionRequired: true,
* approvalRequired: true,
* published: true,
* });
* ```
* ```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_product = azure.apimanagement.Product("example",
* product_id="test-product",
* api_management_name=example_service.name,
* resource_group_name=example.name,
* display_name="Test Product",
* subscription_required=True,
* approval_required=True,
* published=True)
* ```
* ```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 exampleProduct = new Azure.ApiManagement.Product("example", new()
* {
* ProductId = "test-product",
* ApiManagementName = exampleService.Name,
* ResourceGroupName = example.Name,
* DisplayName = "Test Product",
* SubscriptionRequired = true,
* ApprovalRequired = true,
* Published = true,
* });
* });
* ```
* ```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
* }
* _, err = apimanagement.NewProduct(ctx, "example", &apimanagement.ProductArgs{
* ProductId: pulumi.String("test-product"),
* ApiManagementName: exampleService.Name,
* ResourceGroupName: example.Name,
* DisplayName: pulumi.String("Test Product"),
* SubscriptionRequired: pulumi.Bool(true),
* ApprovalRequired: pulumi.Bool(true),
* Published: pulumi.Bool(true),
* })
* 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.Product;
* import com.pulumi.azure.apimanagement.ProductArgs;
* 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 exampleProduct = new Product("exampleProduct", ProductArgs.builder()
* .productId("test-product")
* .apiManagementName(exampleService.name())
* .resourceGroupName(example.name())
* .displayName("Test Product")
* .subscriptionRequired(true)
* .approvalRequired(true)
* .published(true)
* .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
* exampleProduct:
* type: azure:apimanagement:Product
* name: example
* properties:
* productId: test-product
* apiManagementName: ${exampleService.name}
* resourceGroupName: ${example.name}
* displayName: Test Product
* subscriptionRequired: true
* approvalRequired: true
* published: true
* ```
*
* ## Import
* API Management Products can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/product:Product example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/products/myproduct
* ```
*/
public class Product internal constructor(
override val javaResource: com.pulumi.azure.apimanagement.Product,
) : KotlinCustomResource(javaResource, ProductMapper) {
/**
* The name of the API Management Service. Changing this forces a new resource to be created.
*/
public val apiManagementName: Output
get() = javaResource.apiManagementName().applyValue({ args0 -> args0 })
/**
* Do subscribers need to be approved prior to being able to use the Product?
* > **NOTE:** `approval_required` can only be set when `subscription_required` is set to `true`.
*/
public val approvalRequired: Output?
get() = javaResource.approvalRequired().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A description of this Product, which may include HTML formatting tags.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Display Name for this API Management Product.
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
*/
public val productId: Output
get() = javaResource.productId().applyValue({ args0 -> args0 })
/**
* Is this Product Published?
*/
public val published: Output
get() = javaResource.published().applyValue({ args0 -> args0 })
/**
* The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* Is a Subscription required to access API's included in this Product? Defaults to `true`.
*/
public val subscriptionRequired: Output?
get() = javaResource.subscriptionRequired().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The number of subscriptions a user can have to this Product at the same time.
* > **NOTE:** `subscriptions_limit` can only be set when `subscription_required` is set to `true`.
*/
public val subscriptionsLimit: Output?
get() = javaResource.subscriptionsLimit().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
*/
public val terms: Output?
get() = javaResource.terms().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object ProductMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.apimanagement.Product::class == javaResource::class
override fun map(javaResource: Resource): Product = Product(
javaResource as
com.pulumi.azure.apimanagement.Product,
)
}
/**
* @see [Product].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Product].
*/
public suspend fun product(name: String, block: suspend ProductResourceBuilder.() -> Unit): Product {
val builder = ProductResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Product].
* @param name The _unique_ name of the resulting resource.
*/
public fun product(name: String): Product {
val builder = ProductResourceBuilder()
builder.name(name)
return builder.build()
}
