Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. ApiVersionSet

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.ApiVersionSet

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an API Version Set within an API Management Service.

Example Usage

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: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleApiVersionSet = new azure.apimanagement.ApiVersionSet("example", {
    name: "example-apimapi-1_0_0",
    resourceGroupName: example.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleAPIVersionSet",
    versioningScheme: "Segment",
});
Copy
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="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_api_version_set = azure.apimanagement.ApiVersionSet("example",
    name="example-apimapi-1_0_0",
    resource_group_name=example.name,
    api_management_name=example_service.name,
    display_name="ExampleAPIVersionSet",
    versioning_scheme="Segment")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/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("pub1"),
			PublisherEmail:    pulumi.String("pub1@email.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewApiVersionSet(ctx, "example", &apimanagement.ApiVersionSetArgs{
			Name:              pulumi.String("example-apimapi-1_0_0"),
			ResourceGroupName: example.Name,
			ApiManagementName: exampleService.Name,
			DisplayName:       pulumi.String("ExampleAPIVersionSet"),
			VersioningScheme:  pulumi.String("Segment"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "pub1",
        PublisherEmail = "pub1@email.com",
        SkuName = "Developer_1",
    });

    var exampleApiVersionSet = new Azure.ApiManagement.ApiVersionSet("example", new()
    {
        Name = "example-apimapi-1_0_0",
        ResourceGroupName = example.Name,
        ApiManagementName = exampleService.Name,
        DisplayName = "ExampleAPIVersionSet",
        VersioningScheme = "Segment",
    });

});
Copy
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 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("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Developer_1")
            .build());

        var exampleApiVersionSet = new ApiVersionSet("exampleApiVersionSet", ApiVersionSetArgs.builder()
            .name("example-apimapi-1_0_0")
            .resourceGroupName(example.name())
            .apiManagementName(exampleService.name())
            .displayName("ExampleAPIVersionSet")
            .versioningScheme("Segment")
            .build());

    }
}
Copy
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: pub1
      publisherEmail: pub1@email.com
      skuName: Developer_1
  exampleApiVersionSet:
    type: azure:apimanagement:ApiVersionSet
    name: example
    properties:
      name: example-apimapi-1_0_0
      resourceGroupName: ${example.name}
      apiManagementName: ${exampleService.name}
      displayName: ExampleAPIVersionSet
      versioningScheme: Segment
Copy

Create ApiVersionSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiVersionSet(name: string, args: ApiVersionSetArgs, opts?: CustomResourceOptions);
@overload
def ApiVersionSet(resource_name: str,
                  args: ApiVersionSetArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ApiVersionSet(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  api_management_name: Optional[str] = None,
                  display_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  versioning_scheme: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  version_header_name: Optional[str] = None,
                  version_query_name: Optional[str] = None)
func NewApiVersionSet(ctx *Context, name string, args ApiVersionSetArgs, opts ...ResourceOption) (*ApiVersionSet, error)
public ApiVersionSet(string name, ApiVersionSetArgs args, CustomResourceOptions? opts = null)
public ApiVersionSet(String name, ApiVersionSetArgs args)
public ApiVersionSet(String name, ApiVersionSetArgs args, CustomResourceOptions options)

type: azure:apimanagement:ApiVersionSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiVersionSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiVersionSetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiVersionSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiVersionSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiVersionSetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiVersionSetResource = new Azure.ApiManagement.ApiVersionSet("apiVersionSetResource", new()
{
    ApiManagementName = "string",
    DisplayName = "string",
    ResourceGroupName = "string",
    VersioningScheme = "string",
    Description = "string",
    Name = "string",
    VersionHeaderName = "string",
    VersionQueryName = "string",
});
Copy
example, err := apimanagement.NewApiVersionSet(ctx, "apiVersionSetResource", &apimanagement.ApiVersionSetArgs{
	ApiManagementName: pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	VersioningScheme:  pulumi.String("string"),
	Description:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	VersionHeaderName: pulumi.String("string"),
	VersionQueryName:  pulumi.String("string"),
})
Copy
var apiVersionSetResource = new ApiVersionSet("apiVersionSetResource", ApiVersionSetArgs.builder()
    .apiManagementName("string")
    .displayName("string")
    .resourceGroupName("string")
    .versioningScheme("string")
    .description("string")
    .name("string")
    .versionHeaderName("string")
    .versionQueryName("string")
    .build());
Copy
api_version_set_resource = azure.apimanagement.ApiVersionSet("apiVersionSetResource",
    api_management_name="string",
    display_name="string",
    resource_group_name="string",
    versioning_scheme="string",
    description="string",
    name="string",
    version_header_name="string",
    version_query_name="string")
Copy
const apiVersionSetResource = new azure.apimanagement.ApiVersionSet("apiVersionSetResource", {
    apiManagementName: "string",
    displayName: "string",
    resourceGroupName: "string",
    versioningScheme: "string",
    description: "string",
    name: "string",
    versionHeaderName: "string",
    versionQueryName: "string",
});
Copy
type: azure:apimanagement:ApiVersionSet
properties:
    apiManagementName: string
    description: string
    displayName: string
    name: string
    resourceGroupName: string
    versionHeaderName: string
    versionQueryName: string
    versioningScheme: string
Copy

ApiVersionSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiVersionSet resource accepts the following input properties:

ApiManagementName
This property is required.
Changes to this property will trigger replacement.
string
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.
DisplayName This property is required. string
The display name of this API Version Set.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
VersioningScheme This property is required. string
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
Description string
The description of API Version Set.
Name Changes to this property will trigger replacement. string
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.
VersionHeaderName string

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

NOTE: This must be specified when versioning_scheme is set to Header.

VersionQueryName string

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

NOTE: This must be specified when versioning_scheme is set to Query.

ApiManagementName
This property is required.
Changes to this property will trigger replacement.
string
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.
DisplayName This property is required. string
The display name of this API Version Set.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
VersioningScheme This property is required. string
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
Description string
The description of API Version Set.
Name Changes to this property will trigger replacement. string
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.
VersionHeaderName string

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

NOTE: This must be specified when versioning_scheme is set to Header.

VersionQueryName string

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

NOTE: This must be specified when versioning_scheme is set to Query.

apiManagementName
This property is required.
Changes to this property will trigger replacement.
String
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.
displayName This property is required. String
The display name of this API Version Set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versioningScheme This property is required. String
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
description String
The description of API Version Set.
name Changes to this property will trigger replacement. String
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.
versionHeaderName String

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

NOTE: This must be specified when versioning_scheme is set to Header.

versionQueryName String

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

NOTE: This must be specified when versioning_scheme is set to Query.

apiManagementName
This property is required.
Changes to this property will trigger replacement.
string
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.
displayName This property is required. string
The display name of this API Version Set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versioningScheme This property is required. string
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
description string
The description of API Version Set.
name Changes to this property will trigger replacement. string
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.
versionHeaderName string

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

NOTE: This must be specified when versioning_scheme is set to Header.

versionQueryName string

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

NOTE: This must be specified when versioning_scheme is set to Query.

api_management_name
This property is required.
Changes to this property will trigger replacement.
str
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.
display_name This property is required. str
The display name of this API Version Set.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versioning_scheme This property is required. str
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
description str
The description of API Version Set.
name Changes to this property will trigger replacement. str
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.
version_header_name str

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

NOTE: This must be specified when versioning_scheme is set to Header.

version_query_name str

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

NOTE: This must be specified when versioning_scheme is set to Query.

apiManagementName
This property is required.
Changes to this property will trigger replacement.
String
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.
displayName This property is required. String
The display name of this API Version Set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versioningScheme This property is required. String
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
description String
The description of API Version Set.
name Changes to this property will trigger replacement. String
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.
versionHeaderName String

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

NOTE: This must be specified when versioning_scheme is set to Header.

versionQueryName String

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

NOTE: This must be specified when versioning_scheme is set to Query.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiVersionSet resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ApiVersionSet Resource

Get an existing ApiVersionSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApiVersionSetState, opts?: CustomResourceOptions): ApiVersionSet
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_name: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        version_header_name: Optional[str] = None,
        version_query_name: Optional[str] = None,
        versioning_scheme: Optional[str] = None) -> ApiVersionSet
func GetApiVersionSet(ctx *Context, name string, id IDInput, state *ApiVersionSetState, opts ...ResourceOption) (*ApiVersionSet, error)
public static ApiVersionSet Get(string name, Input<string> id, ApiVersionSetState? state, CustomResourceOptions? opts = null)
public static ApiVersionSet get(String name, Output<String> id, ApiVersionSetState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:ApiVersionSet    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiManagementName Changes to this property will trigger replacement. string
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.
Description string
The description of API Version Set.
DisplayName string
The display name of this API Version Set.
Name Changes to this property will trigger replacement. string
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.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
VersionHeaderName string

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

NOTE: This must be specified when versioning_scheme is set to Header.

VersionQueryName string

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

NOTE: This must be specified when versioning_scheme is set to Query.

VersioningScheme string
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
ApiManagementName Changes to this property will trigger replacement. string
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.
Description string
The description of API Version Set.
DisplayName string
The display name of this API Version Set.
Name Changes to this property will trigger replacement. string
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.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
VersionHeaderName string

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

NOTE: This must be specified when versioning_scheme is set to Header.

VersionQueryName string

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

NOTE: This must be specified when versioning_scheme is set to Query.

VersioningScheme string
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
apiManagementName Changes to this property will trigger replacement. String
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.
description String
The description of API Version Set.
displayName String
The display name of this API Version Set.
name Changes to this property will trigger replacement. String
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.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versionHeaderName String

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

NOTE: This must be specified when versioning_scheme is set to Header.

versionQueryName String

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

NOTE: This must be specified when versioning_scheme is set to Query.

versioningScheme String
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
apiManagementName Changes to this property will trigger replacement. string
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.
description string
The description of API Version Set.
displayName string
The display name of this API Version Set.
name Changes to this property will trigger replacement. string
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.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versionHeaderName string

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

NOTE: This must be specified when versioning_scheme is set to Header.

versionQueryName string

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

NOTE: This must be specified when versioning_scheme is set to Query.

versioningScheme string
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
api_management_name Changes to this property will trigger replacement. str
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.
description str
The description of API Version Set.
display_name str
The display name of this API Version Set.
name Changes to this property will trigger replacement. str
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.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
version_header_name str

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

NOTE: This must be specified when versioning_scheme is set to Header.

version_query_name str

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

NOTE: This must be specified when versioning_scheme is set to Query.

versioning_scheme str
Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.
apiManagementName Changes to this property will trigger replacement. String
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.
description String
The description of API Version Set.
displayName String
The display name of this API Version Set.
name Changes to this property will trigger replacement. String
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.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
versionHeaderName String

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

NOTE: This must be specified when versioning_scheme is set to Header.

versionQueryName String

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

NOTE: This must be specified when versioning_scheme is set to Query.

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

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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure