getApi

suspend fun getApi(argument: GetApiPlainArgs): GetApiResult

Use this data source to access information about an existing API Management API.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.apimanagement.getApi({
name: "search-api",
apiManagementName: "search-api-management",
resourceGroupName: "search-service",
revision: "2",
});
export const apiManagementApiId = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.apimanagement.get_api(name="search-api",
api_management_name="search-api-management",
resource_group_name="search-service",
revision="2")
pulumi.export("apiManagementApiId", example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ApiManagement.GetApi.Invoke(new()
{
Name = "search-api",
ApiManagementName = "search-api-management",
ResourceGroupName = "search-service",
Revision = "2",
});
return new Dictionary<string, object?>
{
["apiManagementApiId"] = example.Apply(getApiResult => getApiResult.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.LookupApi(ctx, &apimanagement.LookupApiArgs{
Name: "search-api",
ApiManagementName: "search-api-management",
ResourceGroupName: "search-service",
Revision: "2",
}, nil)
if err != nil {
return err
}
ctx.Export("apiManagementApiId", 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.GetApiArgs;
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.getApi(GetApiArgs.builder()
.name("search-api")
.apiManagementName("search-api-management")
.resourceGroupName("search-service")
.revision("2")
.build());
ctx.export("apiManagementApiId", example.applyValue(getApiResult -> getApiResult.id()));
}
}
variables:
example:
fn::invoke:
function: azure:apimanagement:getApi
arguments:
name: search-api
apiManagementName: search-api-management
resourceGroupName: search-service
revision: '2'
outputs:
apiManagementApiId: ${example.id}

Return

A collection of values returned by getApi.

Parameters

argument

A collection of arguments for invoking getApi.


suspend fun getApi(apiManagementName: String, name: String, resourceGroupName: String, revision: String): GetApiResult

Return

A collection of values returned by getApi.

Parameters

apiManagementName

The name of the API Management Service in which the API Management API exists.

name

The name of the API Management API.

resourceGroupName

The Name of the Resource Group in which the API Management Service exists.

revision

The Revision of the API Management API.

See also


suspend fun getApi(argument: suspend GetApiPlainArgsBuilder.() -> Unit): GetApiResult

Return

A collection of values returned by getApi.

Parameters

argument

Builder for com.pulumi.azure.apimanagement.kotlin.inputs.GetApiPlainArgs.

See also