azure-native.apimanagement.ApiVersionSet
Explore with Pulumi AI
API Version Set Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateApiVersionSet
using System.Collections.Generic;
using System.Linq;
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 = AzureNative.ApiManagement.VersioningScheme.Segment,
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"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(apimanagement.VersioningSchemeSegment),
})
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=azure_native.apimanagement.VersioningScheme.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: azure_native.apimanagement.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 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,
display_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
versioning_scheme: Optional[Union[str, VersioningScheme]] = None,
description: Optional[str] = None,
version_header_name: Optional[str] = None,
version_query_name: Optional[str] = None,
version_set_id: 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-native:apimanagement:ApiVersionSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var apiVersionSetResource = new AzureNative.ApiManagement.ApiVersionSet("apiVersionSetResource", new()
{
DisplayName = "string",
ResourceGroupName = "string",
ServiceName = "string",
VersioningScheme = "string",
Description = "string",
VersionHeaderName = "string",
VersionQueryName = "string",
VersionSetId = "string",
});
example, err := apimanagement.NewApiVersionSet(ctx, "apiVersionSetResource", &apimanagement.ApiVersionSetArgs{
DisplayName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
VersioningScheme: pulumi.String("string"),
Description: pulumi.String("string"),
VersionHeaderName: pulumi.String("string"),
VersionQueryName: pulumi.String("string"),
VersionSetId: pulumi.String("string"),
})
var apiVersionSetResource = new ApiVersionSet("apiVersionSetResource", ApiVersionSetArgs.builder()
.displayName("string")
.resourceGroupName("string")
.serviceName("string")
.versioningScheme("string")
.description("string")
.versionHeaderName("string")
.versionQueryName("string")
.versionSetId("string")
.build());
api_version_set_resource = azure_native.apimanagement.ApiVersionSet("apiVersionSetResource",
display_name="string",
resource_group_name="string",
service_name="string",
versioning_scheme="string",
description="string",
version_header_name="string",
version_query_name="string",
version_set_id="string")
const apiVersionSetResource = new azure_native.apimanagement.ApiVersionSet("apiVersionSetResource", {
displayName: "string",
resourceGroupName: "string",
serviceName: "string",
versioningScheme: "string",
description: "string",
versionHeaderName: "string",
versionQueryName: "string",
versionSetId: "string",
});
type: azure-native:apimanagement:ApiVersionSet
properties:
description: string
displayName: string
resourceGroupName: string
serviceName: string
versionHeaderName: string
versionQueryName: string
versionSetId: string
versioningScheme: string
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:
- Display
Name string - Name of API Version Set
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Versioning
Scheme string | Pulumi.Azure Native. Api Management. Versioning Scheme - An value that determines where the API Version identifier will be located in a HTTP request.
- Description string
- Description of API Version Set.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - Version
Set stringId - Api Version Set identifier. Must be unique in the current API Management service instance.
- Display
Name string - Name of API Version Set
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Versioning
Scheme 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.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - Version
Set stringId - Api Version Set identifier. Must be unique in the current API Management service instance.
- display
Name String - Name of API Version Set
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- versioning
Scheme 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.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - version
Set StringId - Api Version Set identifier. Must be unique in the current API Management service instance.
- display
Name string - Name of API Version Set
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- versioning
Scheme 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.
- version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - version
Set stringId - Api Version Set identifier. Must be unique in the current API Management service instance.
- display_
name str - Name of API Version Set
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- 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_ strname - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version_
query_ strname - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - version_
set_ strid - Api Version Set identifier. Must be unique in the current API Management service instance.
- display
Name String - Name of API Version Set
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- versioning
Scheme 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.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header
. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query
. - version
Set StringId - 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:
Supporting Types
VersioningScheme, VersioningSchemeArgs
- Segment
- SegmentThe API Version is passed in a path segment.
- Query
- QueryThe API Version is passed in a query parameter.
- Header
- HeaderThe API Version is passed in a HTTP header.
- Versioning
Scheme Segment - SegmentThe API Version is passed in a path segment.
- Versioning
Scheme Query - QueryThe API Version is passed in a query parameter.
- Versioning
Scheme Header - HeaderThe API Version is passed in a HTTP header.
- Segment
- SegmentThe API Version is passed in a path segment.
- Query
- QueryThe API Version is passed in a query parameter.
- Header
- HeaderThe API Version is passed in a HTTP header.
- Segment
- SegmentThe API Version is passed in a path segment.
- Query
- QueryThe API Version is passed in a query parameter.
- Header
- HeaderThe API Version is passed in a HTTP header.
- SEGMENT
- SegmentThe API Version is passed in a path segment.
- QUERY
- QueryThe API Version is passed in a query parameter.
- HEADER
- HeaderThe API Version is passed in a HTTP header.
- "Segment"
- SegmentThe API Version is passed in a path segment.
- "Query"
- QueryThe API Version is passed in a query parameter.
- "Header"
- HeaderThe 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0