Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ApiVersionSet

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class ApiVersionSet : CustomResource

Constructors

ApiVersionSet(String, ApiVersionSetArgs, CustomResourceOptions)

Create a ApiVersionSet resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApiVersionSetArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of API Version Set.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

The display name of this API Version Set.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the API Version Set. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

VersionHeaderName

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

Declaration

public Output<string> VersionHeaderName { get; }

Property Value

Type	Description
Output<System.String>

VersioningScheme

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

Declaration

public Output<string> VersioningScheme { get; }

Property Value

Type	Description
Output<System.String>

VersionQueryName

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

Declaration

public Output<string> VersionQueryName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ApiVersionSetState, CustomResourceOptions)

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

Declaration

public static ApiVersionSet Get(string name, Input<string> id, ApiVersionSetState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApiVersionSetState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ApiVersionSet