ApiVersionSet

Manages an API Version Set within an API Management Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "pub1",
            PublisherEmail = "pub1@email.com",
            SkuName = "Developer_1",
        });
        var exampleApiVersionSet = new Azure.ApiManagement.ApiVersionSet("exampleApiVersionSet", new Azure.ApiManagement.ApiVersionSetArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            ApiManagementName = exampleService.Name,
            DisplayName = "ExampleAPIVersionSet",
            VersioningScheme = "Segment",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.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, "exampleApiVersionSet", &apimanagement.ApiVersionSetArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            ApiManagementName: exampleService.Name,
            DisplayName:       pulumi.String("ExampleAPIVersionSet"),
            VersioningScheme:  pulumi.String("Segment"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_api_version_set = azure.apimanagement.ApiVersionSet("exampleApiVersionSet",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="ExampleAPIVersionSet",
    versioning_scheme="Segment")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleApiVersionSet = new azure.apimanagement.ApiVersionSet("exampleApiVersionSet", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleAPIVersionSet",
    versioningScheme: "Segment",
});

Create a ApiVersionSet Resource

new ApiVersionSet(name: string, args: ApiVersionSetArgs, opts?: CustomResourceOptions);

def ApiVersionSet(resource_name, opts=None, api_management_name=None, description=None, display_name=None, name=None, resource_group_name=None, version_header_name=None, version_query_name=None, versioning_scheme=None, __props__=None);

func NewApiVersionSet(ctx *Context, name string, args ApiVersionSetArgs, opts ...ResourceOption) (*ApiVersionSet, error)

public ApiVersionSet(string name, ApiVersionSetArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ApiVersionSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ApiVersionSetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ApiVersionSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ApiVersionSet Resource Properties

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

Inputs

The ApiVersionSet resource accepts the following input properties:

ApiManagementName string: The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Version Set.
ResourceGroupName 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 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 string: The name of the API Version Set. 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.
VersionQueryName string: The name of the Query String which should be read from Inbound Requests which defines the API Version.

ApiManagementName string: The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Version Set.
ResourceGroupName 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 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 string: The name of the API Version Set. 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.
VersionQueryName string: The name of the Query String which should be read from Inbound Requests which defines the API Version.

apiManagementName string: The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.
displayName string: The display name of this API Version Set.
resourceGroupName 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 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 string: The name of the API Version Set. 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.
versionQueryName string: The name of the Query String which should be read from Inbound Requests which defines the API Version.

api_management_name str: The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.
display_name str: The display name of this API Version Set.
resource_group_name 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 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 str: The name of the API Version Set. 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.
version_query_name str: The name of the Query String which should be read from Inbound Requests which defines the API Version.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, api_management_name=None, description=None, display_name=None, name=None, resource_group_name=None, version_header_name=None, version_query_name=None, versioning_scheme=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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 string: The name of the API Management Service in which the API Version Set should exist. 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 string: The name of the API Version Set. Changing this forces a new resource to be created.
ResourceGroupName 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.
VersionQueryName string: The name of the Query String which should be read from Inbound Requests which defines the API Version.
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 string: The name of the API Management Service in which the API Version Set should exist. 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 string: The name of the API Version Set. Changing this forces a new resource to be created.
ResourceGroupName 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.
VersionQueryName string: The name of the Query String which should be read from Inbound Requests which defines the API Version.
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 string: The name of the API Management Service in which the API Version Set should exist. 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 string: The name of the API Version Set. Changing this forces a new resource to be created.
resourceGroupName 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.
versionQueryName string: The name of the Query String which should be read from Inbound Requests which defines the API Version.
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 str: The name of the API Management Service in which the API Version Set should exist. 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 str: The name of the API Version Set. Changing this forces a new resource to be created.
resource_group_name 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.
version_query_name str: The name of the Query String which should be read from Inbound Requests which defines the API Version.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud