WorkspaceApiVersionSetArgs

data class WorkspaceApiVersionSetArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val versionHeaderName: Output<String>? = null, val versionQueryName: Output<String>? = null, val versionSetId: Output<String>? = null, val versioningScheme: Output<Either<String, VersioningScheme>>? = null, val workspaceId: Output<String>? = null) : ConvertibleToJava<WorkspaceApiVersionSetArgs>

API Version Set Contract 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

ApiManagementCreateWorkspaceApiVersionSet

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workspaceApiVersionSet = new AzureNative.ApiManagement.WorkspaceApiVersionSet("workspaceApiVersionSet", new()
{
Description = "Version configuration",
DisplayName = "api set 1",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
VersionSetId = "api1",
VersioningScheme = AzureNative.ApiManagement.VersioningScheme.Segment,
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.NewWorkspaceApiVersionSet(ctx, "workspaceApiVersionSet", &apimanagement.WorkspaceApiVersionSetArgs{
Description: pulumi.String("Version configuration"),
DisplayName: pulumi.String("api set 1"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
VersionSetId: pulumi.String("api1"),
VersioningScheme: pulumi.String(apimanagement.VersioningSchemeSegment),
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.WorkspaceApiVersionSet;
import com.pulumi.azurenative.apimanagement.WorkspaceApiVersionSetArgs;
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 workspaceApiVersionSet = new WorkspaceApiVersionSet("workspaceApiVersionSet", WorkspaceApiVersionSetArgs.builder()
.description("Version configuration")
.displayName("api set 1")
.resourceGroupName("rg1")
.serviceName("apimService1")
.versionSetId("api1")
.versioningScheme("Segment")
.workspaceId("wks1")
.build());
}
}

Import

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

$ pulumi import azure-native:apimanagement:WorkspaceApiVersionSet api1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, displayName: Output<String>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, versionHeaderName: Output<String>? = null, versionQueryName: Output<String>? = null, versionSetId: Output<String>? = null, versioningScheme: Output<Either<String, VersioningScheme>>? = null, workspaceId: Output<String>? = null)

Properties

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

Description of API Version Set.

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

Name of API Version Set

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

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Link copied to clipboard
val versioningScheme: Output<Either<String, VersioningScheme>>? = null

An value that determines where the API Version identifier will be located in a HTTP request.

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

Name of query parameter that indicates the API Version if versioningScheme is set to query.

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

Api Version Set identifier. Must be unique in the current API Management service instance.

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(): WorkspaceApiVersionSetArgs