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

We recommend using Azure Native.

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

azure.apimanagement.getApiVersionSet

Explore with Pulumi AI

We recommend using Azure Native.

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

Uses this data source to access information about 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 = azure.apimanagement.getApiVersionSet({
    resourceGroupName: "example-resources",
    apiManagementName: "example-api",
    name: "example-api-version-set",
});
export const apiManagementApiVersionSetId = example.then(example => example.id);
Copy
import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_api_version_set(resource_group_name="example-resources",
    api_management_name="example-api",
    name="example-api-version-set")
pulumi.export("apiManagementApiVersionSetId", example.id)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := apimanagement.LookupApiVersionSet(ctx, &apimanagement.LookupApiVersionSetArgs{
			ResourceGroupName: "example-resources",
			ApiManagementName: "example-api",
			Name:              "example-api-version-set",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("apiManagementApiVersionSetId", example.Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.ApiManagement.GetApiVersionSet.Invoke(new()
    {
        ResourceGroupName = "example-resources",
        ApiManagementName = "example-api",
        Name = "example-api-version-set",
    });

    return new Dictionary<string, object?>
    {
        ["apiManagementApiVersionSetId"] = example.Apply(getApiVersionSetResult => getApiVersionSetResult.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetApiVersionSetArgs;
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) {
        final var example = ApimanagementFunctions.getApiVersionSet(GetApiVersionSetArgs.builder()
            .resourceGroupName("example-resources")
            .apiManagementName("example-api")
            .name("example-api-version-set")
            .build());

        ctx.export("apiManagementApiVersionSetId", example.applyValue(getApiVersionSetResult -> getApiVersionSetResult.id()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:apimanagement:getApiVersionSet
      arguments:
        resourceGroupName: example-resources
        apiManagementName: example-api
        name: example-api-version-set
outputs:
  apiManagementApiVersionSetId: ${example.id}
Copy

Using getApiVersionSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiVersionSet(args: GetApiVersionSetArgs, opts?: InvokeOptions): Promise<GetApiVersionSetResult>
function getApiVersionSetOutput(args: GetApiVersionSetOutputArgs, opts?: InvokeOptions): Output<GetApiVersionSetResult>
Copy
def get_api_version_set(api_management_name: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetApiVersionSetResult
def get_api_version_set_output(api_management_name: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetApiVersionSetResult]
Copy
func LookupApiVersionSet(ctx *Context, args *LookupApiVersionSetArgs, opts ...InvokeOption) (*LookupApiVersionSetResult, error)
func LookupApiVersionSetOutput(ctx *Context, args *LookupApiVersionSetOutputArgs, opts ...InvokeOption) LookupApiVersionSetResultOutput
Copy

> Note: This function is named LookupApiVersionSet in the Go SDK.

public static class GetApiVersionSet 
{
    public static Task<GetApiVersionSetResult> InvokeAsync(GetApiVersionSetArgs args, InvokeOptions? opts = null)
    public static Output<GetApiVersionSetResult> Invoke(GetApiVersionSetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiVersionSetResult> getApiVersionSet(GetApiVersionSetArgs args, InvokeOptions options)
public static Output<GetApiVersionSetResult> getApiVersionSet(GetApiVersionSetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:apimanagement/getApiVersionSet:getApiVersionSet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiManagementName This property is required. string
The name of the API Management Service where the API Version Set exists.
Name This property is required. string
The name of the API Version Set.
ResourceGroupName This property is required. string
The name of the Resource Group in which the parent API Management Service exists.
ApiManagementName This property is required. string
The name of the API Management Service where the API Version Set exists.
Name This property is required. string
The name of the API Version Set.
ResourceGroupName This property is required. string
The name of the Resource Group in which the parent API Management Service exists.
apiManagementName This property is required. String
The name of the API Management Service where the API Version Set exists.
name This property is required. String
The name of the API Version Set.
resourceGroupName This property is required. String
The name of the Resource Group in which the parent API Management Service exists.
apiManagementName This property is required. string
The name of the API Management Service where the API Version Set exists.
name This property is required. string
The name of the API Version Set.
resourceGroupName This property is required. string
The name of the Resource Group in which the parent API Management Service exists.
api_management_name This property is required. str
The name of the API Management Service where the API Version Set exists.
name This property is required. str
The name of the API Version Set.
resource_group_name This property is required. str
The name of the Resource Group in which the parent API Management Service exists.
apiManagementName This property is required. String
The name of the API Management Service where the API Version Set exists.
name This property is required. String
The name of the API Version Set.
resourceGroupName This property is required. String
The name of the Resource Group in which the parent API Management Service exists.

getApiVersionSet Result

The following output properties are available:

ApiManagementName string
Description string
The description of API Version Set.
DisplayName string
The display name of this API Version Set.
Id string
The provider-assigned unique ID for this managed resource.
Name string
ResourceGroupName string
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
ApiManagementName string
Description string
The description of API Version Set.
DisplayName string
The display name of this API Version Set.
Id string
The provider-assigned unique ID for this managed resource.
Name string
ResourceGroupName string
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
apiManagementName String
description String
The description of API Version Set.
displayName String
The display name of this API Version Set.
id String
The provider-assigned unique ID for this managed resource.
name String
resourceGroupName String
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
apiManagementName string
description string
The description of API Version Set.
displayName string
The display name of this API Version Set.
id string
The provider-assigned unique ID for this managed resource.
name string
resourceGroupName string
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
api_management_name str
description str
The description of API Version Set.
display_name str
The display name of this API Version Set.
id str
The provider-assigned unique ID for this managed resource.
name str
resource_group_name str
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
apiManagementName String
description String
The description of API Version Set.
displayName String
The display name of this API Version Set.
id String
The provider-assigned unique ID for this managed resource.
name String
resourceGroupName String
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

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