pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/ApiVersionSetArgs

ApiVersionSetArgs

data class ApiVersionSetArgs(val apiManagementName: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val versionHeaderName: Output<String>? = null, val versionQueryName: Output<String>? = null, val versioningScheme: Output<String>? = null) : ConvertibleToJava<ApiVersionSetArgs>

Manages an API Version Set within an API Management Service.

Example Usage

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.ApiVersionSet;
import com.pulumi.azure.apimanagement.ApiVersionSetArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Developer_1")
            .build());
        var exampleApiVersionSet = new ApiVersionSet("exampleApiVersionSet", ApiVersionSetArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .apiManagementName(exampleService.name())
            .displayName("ExampleAPIVersionSet")
            .versioningScheme("Segment")
            .build());
    }
}
Content copied to clipboard

Import

API Version Set can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/apiVersionSet:ApiVersionSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/apiVersionSets/set1
Content copied to clipboard

Constructors

Link copied to clipboard
fun ApiVersionSetArgs(apiManagementName: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, name: Output<String>? = null, resourceGroupName: Output<String>? = null, versionHeaderName: Output<String>? = null, versionQueryName: Output<String>? = null, versioningScheme: Output<String>? = null)

Functions

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

Properties

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

The name of the API Management Service in which the API Version Set should exist. May only contain alphanumeric characters and dashes up to 50 characters in length. Changing this forces a new resource to be created.

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

The description of API Version Set.

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

The display name of this API Version Set.

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

The name of the API Version Set. May only contain alphanumeric characters and dashes up to 80 characters in length. Changing this forces a new resource to be created.

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

The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.

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

The name of the Header which should be read from Inbound Requests which defines the API Version.

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

Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.

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

The name of the Query String which should be read from Inbound Requests which defines the API Version.