Azure Classic v5.38.0, Mar 21 23

azure.apimanagement.getApiVersionSet

Uses this data source to access information about an API Version Set within an API Management Service.

Example Usage

using System.Collections.Generic;
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),
    };
});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/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
	})
}

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()));
    }
}

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)

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);

variables:
  example:
    fn::invoke:
      Function: azure:apimanagement:getApiVersionSet
      Arguments:
        resourceGroupName: example-resources
        apiManagementName: example-api
        name: example-api-version-set
outputs:
  apiManagementApiVersionSetId: ${example.id}

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>

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]

func LookupApiVersionSet(ctx *Context, args *LookupApiVersionSetArgs, opts ...InvokeOption) (*LookupApiVersionSetResult, error)
func LookupApiVersionSetOutput(ctx *Context, args *LookupApiVersionSetOutputArgs, opts ...InvokeOption) LookupApiVersionSetResultOutput

> 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)
}

public static CompletableFuture<GetApiVersionSetResult> getApiVersionSet(GetApiVersionSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:apimanagement/getApiVersionSet:getApiVersionSet
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiManagementName string: The name of the API Management Service where the API Version Set exists.
Name string: The name of the API Version Set.
ResourceGroupName string: The name of the Resource Group in which the parent API Management Service exists.

ApiManagementName string: The name of the API Management Service where the API Version Set exists.
Name string: The name of the API Version Set.
ResourceGroupName string: The name of the Resource Group in which the parent API Management Service exists.

apiManagementName String: The name of the API Management Service where the API Version Set exists.
name String: The name of the API Version Set.
resourceGroupName String: The name of the Resource Group in which the parent API Management Service exists.

apiManagementName string: The name of the API Management Service where the API Version Set exists.
name string: The name of the API Version Set.
resourceGroupName string: The name of the Resource Group in which the parent API Management Service exists.

api_management_name str: The name of the API Management Service where the API Version Set exists.
name str: The name of the API Version Set.
resource_group_name str: The name of the Resource Group in which the parent API Management Service exists.

apiManagementName String: The name of the API Management Service where the API Version Set exists.
name String: The name of the API Version Set.
resourceGroupName 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.

azure.apimanagement.getApiVersionSet

Example Usage

Using getApiVersionSet

getApiVersionSet Result

Package Details

Contents