Api
API entity. Azure REST API version: 2024-03-01.
Example Usage
Apis_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var api = new AzureNative.ApiCenter.Api("api", new()
    {
        ApiName = "echo-api",
        CustomProperties =
        {
            { "author", "John Doe" },
        },
        Description = "A simple HTTP request/response service.",
        ExternalDocumentation = new[]
        {
            new AzureNative.ApiCenter.Inputs.ExternalDocumentationArgs
            {
                Title = "Onboarding docs",
                Url = "https://docs.contoso.com",
            },
        },
        Kind = "rest",
        License = new AzureNative.ApiCenter.Inputs.LicenseArgs
        {
            Url = "https://contoso.com/license",
        },
        ResourceGroupName = "contoso-resources",
        ServiceName = "contoso",
        TermsOfService = new AzureNative.ApiCenter.Inputs.TermsOfServiceArgs
        {
            Url = "https://contoso.com/terms-of-service",
        },
        Title = "Echo API",
        WorkspaceName = "default",
    });
});Content copied to clipboard
package main
import (
	"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.NewApi(ctx, "api", &apicenter.ApiArgs{
			ApiName: pulumi.String("echo-api"),
			CustomProperties: pulumi.Any{
				Author: "John Doe",
			},
			Description: pulumi.String("A simple HTTP request/response service."),
			ExternalDocumentation: []apicenter.ExternalDocumentationArgs{
				{
					Title: pulumi.String("Onboarding docs"),
					Url:   pulumi.String("https://docs.contoso.com"),
				},
			},
			Kind: pulumi.String("rest"),
			License: &apicenter.LicenseArgs{
				Url: pulumi.String("https://contoso.com/license"),
			},
			ResourceGroupName: pulumi.String("contoso-resources"),
			ServiceName:       pulumi.String("contoso"),
			TermsOfService: &apicenter.TermsOfServiceArgs{
				Url: pulumi.String("https://contoso.com/terms-of-service"),
			},
			Title:         pulumi.String("Echo API"),
			WorkspaceName: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apicenter.Api;
import com.pulumi.azurenative.apicenter.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
            .apiName("echo-api")
            .customProperties(Map.of("author", "John Doe"))
            .description("A simple HTTP request/response service.")
            .externalDocumentation(Map.ofEntries(
                Map.entry("title", "Onboarding docs"),
                Map.entry("url", "https://docs.contoso.com")
            ))
            .kind("rest")
            .license(Map.of("url", "https://contoso.com/license"))
            .resourceGroupName("contoso-resources")
            .serviceName("contoso")
            .termsOfService(Map.of("url", "https://contoso.com/terms-of-service"))
            .title("Echo API")
            .workspaceName("default")
            .build());
    }
}Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apicenter:Api echo-api /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}Content copied to clipboard