pulumi-azure-native-kotlin/com.pulumi.azurenative.apicenter.kotlin/ApiDefinition

ApiDefinition

class ApiDefinition : KotlinCustomResource

API definition entity. Uses Azure REST API version 2024-03-15-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01. Other available API versions: 2024-03-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apicenter [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

ApiDefinitions_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var apiDefinition = new AzureNative.ApiCenter.ApiDefinition("apiDefinition", new()
    {
        ApiName = "openapi",
        DefinitionName = "openapi",
        Description = "Default spec",
        ResourceGroupName = "contoso-resources",
        ServiceName = "contoso",
        Title = "OpenAPI",
        VersionName = "2023-01-01",
        WorkspaceName = "default",
    });
});

package main
import (
	apicenter "github.com/pulumi/pulumi-azure-native-sdk/apicenter/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apicenter.NewApiDefinition(ctx, "apiDefinition", &apicenter.ApiDefinitionArgs{
			ApiName:           pulumi.String("openapi"),
			DefinitionName:    pulumi.String("openapi"),
			Description:       pulumi.String("Default spec"),
			ResourceGroupName: pulumi.String("contoso-resources"),
			ServiceName:       pulumi.String("contoso"),
			Title:             pulumi.String("OpenAPI"),
			VersionName:       pulumi.String("2023-01-01"),
			WorkspaceName:     pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apicenter.ApiDefinition;
import com.pulumi.azurenative.apicenter.ApiDefinitionArgs;
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) {
        var apiDefinition = new ApiDefinition("apiDefinition", ApiDefinitionArgs.builder()
            .apiName("openapi")
            .definitionName("openapi")
            .description("Default spec")
            .resourceGroupName("contoso-resources")
            .serviceName("contoso")
            .title("OpenAPI")
            .versionName("2023-01-01")
            .workspaceName("default")
            .build());
    }
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apicenter:ApiDefinition openapi /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}