Azure Native

v1.80.0 published on Tuesday, Oct 4, 2022 by Pulumi

ApiVersionSet

Api Version Set Contract details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateApiVersionSet

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var apiVersionSet = new AzureNative.ApiManagement.ApiVersionSet("apiVersionSet", new()
    {
        Description = "Version configuration",
        DisplayName = "api set 1",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        VersionSetId = "api1",
        VersioningScheme = "Segment",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiVersionSet(ctx, "apiVersionSet", &apimanagement.ApiVersionSetArgs{
			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("Segment"),
		})
		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.ApiVersionSet;
import com.pulumi.azurenative.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 apiVersionSet = new ApiVersionSet("apiVersionSet", ApiVersionSetArgs.builder()        
            .description("Version configuration")
            .displayName("api set 1")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .versionSetId("api1")
            .versioningScheme("Segment")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

api_version_set = azure_native.apimanagement.ApiVersionSet("apiVersionSet",
    description="Version configuration",
    display_name="api set 1",
    resource_group_name="rg1",
    service_name="apimService1",
    version_set_id="api1",
    versioning_scheme="Segment")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiVersionSet = new azure_native.apimanagement.ApiVersionSet("apiVersionSet", {
    description: "Version configuration",
    displayName: "api set 1",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    versionSetId: "api1",
    versioningScheme: "Segment",
});
resources:
  apiVersionSet:
    type: azure-native:apimanagement:ApiVersionSet
    properties:
      description: Version configuration
      displayName: api set 1
      resourceGroupName: rg1
      serviceName: apimService1
      versionSetId: api1
      versioningScheme: Segment

Create a ApiVersionSet Resource

new ApiVersionSet(name: string, args: ApiVersionSetArgs, opts?: CustomResourceOptions);
@overload
def ApiVersionSet(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  service_name: Optional[str] = None,
                  version_header_name: Optional[str] = None,
                  version_query_name: Optional[str] = None,
                  version_set_id: Optional[str] = None,
                  versioning_scheme: Optional[Union[str, VersioningScheme]] = None)
@overload
def ApiVersionSet(resource_name: str,
                  args: ApiVersionSetArgs,
                  opts: Optional[ResourceOptions] = 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-native:apimanagement:ApiVersionSet
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args 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 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.
name String
The unique name of the resource.
args ApiVersionSetArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The ApiVersionSet resource accepts the following input properties:

DisplayName string

Name of API Version Set

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

VersioningScheme string | Pulumi.AzureNative.ApiManagement.VersioningScheme

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

Description string

Description of API Version Set.

VersionHeaderName string

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

VersionQueryName string

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

VersionSetId string

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

DisplayName string

Name of API Version Set

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

VersioningScheme string | VersioningScheme

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

Description string

Description of API Version Set.

VersionHeaderName string

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

VersionQueryName string

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

VersionSetId string

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

displayName String

Name of API Version Set

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

versioningScheme String | VersioningScheme

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

description String

Description of API Version Set.

versionHeaderName String

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

versionQueryName String

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

versionSetId String

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

displayName string

Name of API Version Set

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

versioningScheme string | VersioningScheme

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

description string

Description of API Version Set.

versionHeaderName string

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

versionQueryName string

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

versionSetId string

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

display_name str

Name of API Version Set

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

versioning_scheme str | VersioningScheme

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

description str

Description of API Version Set.

version_header_name str

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

version_query_name str

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

version_set_id str

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

displayName String

Name of API Version Set

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

versioningScheme String | "Segment" | "Query" | "Header"

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

description String

Description of API Version Set.

versionHeaderName String

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

versionQueryName String

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

versionSetId String

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

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.

Name string

Resource name.

Type string

Resource type for API Management resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

type string

Resource type for API Management resource.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

type str

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

Supporting Types

VersioningScheme

Segment
Segment

The API Version is passed in a path segment.

Query
Query

The API Version is passed in a query parameter.

Header
Header

The API Version is passed in a HTTP header.

VersioningSchemeSegment
Segment

The API Version is passed in a path segment.

VersioningSchemeQuery
Query

The API Version is passed in a query parameter.

VersioningSchemeHeader
Header

The API Version is passed in a HTTP header.

Segment
Segment

The API Version is passed in a path segment.

Query
Query

The API Version is passed in a query parameter.

Header
Header

The API Version is passed in a HTTP header.

Segment
Segment

The API Version is passed in a path segment.

Query
Query

The API Version is passed in a query parameter.

Header
Header

The API Version is passed in a HTTP header.

SEGMENT
Segment

The API Version is passed in a path segment.

QUERY
Query

The API Version is passed in a query parameter.

HEADER
Header

The API Version is passed in a HTTP header.

"Segment"
Segment

The API Version is passed in a path segment.

"Query"
Query

The API Version is passed in a query parameter.

"Header"
Header

The API Version is passed in a HTTP header.

Import

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

$ pulumi import azure-native:apimanagement:ApiVersionSet api1 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0