WorkspaceProductArgs

data class WorkspaceProductArgs(val approvalRequired: Output<Boolean>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val productId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val state: Output<ProductState>? = null, val subscriptionRequired: Output<Boolean>? = null, val subscriptionsLimit: Output<Int>? = null, val terms: Output<String>? = null, val workspaceId: Output<String>? = null) : ConvertibleToJava<WorkspaceProductArgs>

Product details. Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview. Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

ApiManagementCreateWorkspaceProduct

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workspaceProduct = new AzureNative.ApiManagement.WorkspaceProduct("workspaceProduct", new()
{
DisplayName = "Test Template ProductName 4",
ProductId = "testproduct",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
WorkspaceId = "wks1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewWorkspaceProduct(ctx, "workspaceProduct", &apimanagement.WorkspaceProductArgs{
DisplayName: pulumi.String("Test Template ProductName 4"),
ProductId: pulumi.String("testproduct"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
WorkspaceId: pulumi.String("wks1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceProduct;
import com.pulumi.azurenative.apimanagement.WorkspaceProductArgs;
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 workspaceProduct = new WorkspaceProduct("workspaceProduct", WorkspaceProductArgs.builder()
.displayName("Test Template ProductName 4")
.productId("testproduct")
.resourceGroupName("rg1")
.serviceName("apimService1")
.workspaceId("wks1")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:WorkspaceProduct testproduct /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}

Constructors

Link copied to clipboard
constructor(approvalRequired: Output<Boolean>? = null, description: Output<String>? = null, displayName: Output<String>? = null, productId: Output<String>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, state: Output<ProductState>? = null, subscriptionRequired: Output<Boolean>? = null, subscriptionsLimit: Output<Int>? = null, terms: Output<String>? = null, workspaceId: Output<String>? = null)

Properties

Link copied to clipboard
val approvalRequired: Output<Boolean>? = null

whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Link copied to clipboard
val description: Output<String>? = null

Product description. May include HTML formatting tags.

Link copied to clipboard
val displayName: Output<String>? = null

Product name.

Link copied to clipboard
val productId: Output<String>? = null

Product identifier. Must be unique in the current API Management service instance.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the API Management service.

Link copied to clipboard
val state: Output<ProductState>? = null

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.

Link copied to clipboard
val subscriptionRequired: Output<Boolean>? = null

Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.

Link copied to clipboard
val subscriptionsLimit: Output<Int>? = null

Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Link copied to clipboard
val terms: Output<String>? = null

Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

Link copied to clipboard
val workspaceId: Output<String>? = null

Workspace identifier. Must be unique in the current API Management service instance.

Functions

Link copied to clipboard
open override fun toJava(): WorkspaceProductArgs