pulumi-azure-native-kotlin/com.pulumi.azurenative.apimanagement.kotlin/WorkspaceSubscriptionArgs

WorkspaceSubscriptionArgs

data class WorkspaceSubscriptionArgs(val allowTracing: Output<Boolean>? = null, val appType: Output<String>? = null, val displayName: Output<String>? = null, val notify: Output<Boolean>? = null, val ownerId: Output<String>? = null, val primaryKey: Output<String>? = null, val resourceGroupName: Output<String>? = null, val scope: Output<String>? = null, val secondaryKey: Output<String>? = null, val serviceName: Output<String>? = null, val sid: Output<String>? = null, val state: Output<SubscriptionState>? = null, val workspaceId: Output<String>? = null) : ConvertibleToJava<WorkspaceSubscriptionArgs>

Subscription details. Azure REST API version: 2022-09-01-preview. Other available API versions: 2023-03-01-preview.

Example Usage

ApiManagementCreateWorkspaceSubscription

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var workspaceSubscription = new AzureNative.ApiManagement.WorkspaceSubscription("workspaceSubscription", new()
    {
        DisplayName = "testsub",
        OwnerId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
        ResourceGroupName = "rg1",
        Scope = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
        ServiceName = "apimService1",
        Sid = "testsub",
        WorkspaceId = "wks1",
    });
});
Content copied to clipboard
package main
import (
	"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.NewWorkspaceSubscription(ctx, "workspaceSubscription", &apimanagement.WorkspaceSubscriptionArgs{
			DisplayName:       pulumi.String("testsub"),
			OwnerId:           pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7"),
			ResourceGroupName: pulumi.String("rg1"),
			Scope:             pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002"),
			ServiceName:       pulumi.String("apimService1"),
			Sid:               pulumi.String("testsub"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceSubscription;
import com.pulumi.azurenative.apimanagement.WorkspaceSubscriptionArgs;
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 workspaceSubscription = new WorkspaceSubscription("workspaceSubscription", WorkspaceSubscriptionArgs.builder()
            .displayName("testsub")
            .ownerId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7")
            .resourceGroupName("rg1")
            .scope("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002")
            .serviceName("apimService1")
            .sid("testsub")
            .workspaceId("wks1")
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:apimanagement:WorkspaceSubscription testsub /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}
Content copied to clipboard

Constructors

Link copied to clipboard
fun WorkspaceSubscriptionArgs(allowTracing: Output<Boolean>? = null, appType: Output<String>? = null, displayName: Output<String>? = null, notify: Output<Boolean>? = null, ownerId: Output<String>? = null, primaryKey: Output<String>? = null, resourceGroupName: Output<String>? = null, scope: Output<String>? = null, secondaryKey: Output<String>? = null, serviceName: Output<String>? = null, sid: Output<String>? = null, state: Output<SubscriptionState>? = null, workspaceId: Output<String>? = null)

Functions

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

Properties

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

Determines whether tracing can be enabled

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

Determines the type of application which send the create user request. Default is legacy publisher portal.

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

Subscription name.

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

Notify change in Subscription State.

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

User (user id path) for whom subscription is being created in form /users/{userId}

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

Primary subscription key. If not specified during request key will be generated automatically.

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 scope: Output<String>? = null

Scope like /products/{productId} or /apis or /apis/{apiId}.

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

Secondary subscription key. If not specified during request key will be generated automatically.

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

The name of the API Management service.

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

Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

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

Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

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

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