We recommend using Azure Native.
Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi
azure.apimanagement.getApiVersionSet
Explore with Pulumi AI
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);
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)
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
})
}
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),
};
});
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()));
}
}
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:
- Api
Management stringName - The name of the API Management Service where the API Version Set exists.
- Name string
- The name of the API Version Set.
- Resource
Group stringName - The name of the Resource Group in which the parent API Management Service exists.
- Api
Management stringName - The name of the API Management Service where the API Version Set exists.
- Name string
- The name of the API Version Set.
- Resource
Group stringName - The name of the Resource Group in which the parent API Management Service exists.
- api
Management StringName - The name of the API Management Service where the API Version Set exists.
- name String
- The name of the API Version Set.
- resource
Group StringName - The name of the Resource Group in which the parent API Management Service exists.
- api
Management stringName - The name of the API Management Service where the API Version Set exists.
- name string
- The name of the API Version Set.
- resource
Group stringName - The name of the Resource Group in which the parent API Management Service exists.
- api_
management_ strname - The name of the API Management Service where the API Version Set exists.
- name str
- The name of the API Version Set.
- resource_
group_ strname - The name of the Resource Group in which the parent API Management Service exists.
- api
Management StringName - The name of the API Management Service where the API Version Set exists.
- name String
- The name of the API Version Set.
- resource
Group StringName - The name of the Resource Group in which the parent API Management Service exists.
getApiVersionSet Result
The following output properties are available:
- Api
Management stringName - Description string
- The description of API Version Set.
- Display
Name string - The display name of this API Version Set.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource
Group stringName - Version
Header stringName - The name of the Header which should be read from Inbound Requests which defines the API Version.
- Version
Query stringName - The name of the Query String which should be read from Inbound Requests which defines the API Version.
- Versioning
Scheme string
- Api
Management stringName - Description string
- The description of API Version Set.
- Display
Name string - The display name of this API Version Set.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource
Group stringName - Version
Header stringName - The name of the Header which should be read from Inbound Requests which defines the API Version.
- Version
Query stringName - The name of the Query String which should be read from Inbound Requests which defines the API Version.
- Versioning
Scheme string
- api
Management StringName - description String
- The description of API Version Set.
- display
Name String - The display name of this API Version Set.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- resource
Group StringName - version
Header StringName - The name of the Header which should be read from Inbound Requests which defines the API Version.
- version
Query StringName - The name of the Query String which should be read from Inbound Requests which defines the API Version.
- versioning
Scheme String
- api
Management stringName - description string
- The description of API Version Set.
- display
Name string - The display name of this API Version Set.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- resource
Group stringName - version
Header stringName - The name of the Header which should be read from Inbound Requests which defines the API Version.
- version
Query stringName - The name of the Query String which should be read from Inbound Requests which defines the API Version.
- versioning
Scheme string
- api_
management_ strname - 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_ strname - version_
header_ strname - The name of the Header which should be read from Inbound Requests which defines the API Version.
- version_
query_ strname - The name of the Query String which should be read from Inbound Requests which defines the API Version.
- versioning_
scheme str
- api
Management StringName - description String
- The description of API Version Set.
- display
Name String - The display name of this API Version Set.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- resource
Group StringName - version
Header StringName - The name of the Header which should be read from Inbound Requests which defines the API Version.
- version
Query StringName - The name of the Query String which should be read from Inbound Requests which defines the API Version.
- versioning
Scheme String
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.