DocumentationArgs

data class DocumentationArgs(val content: Output<String>? = null, val documentationId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val title: Output<String>? = null) : ConvertibleToJava<DocumentationArgs>

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

Example Usage

ApiManagementCreateDocumentation

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var documentation = new AzureNative.ApiManagement.Documentation("documentation", new()
{
Content = "content",
DocumentationId = "57d1f7558aa04f15146d9d8a",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Title = "Title",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewDocumentation(ctx, "documentation", &apimanagement.DocumentationArgs{
Content: pulumi.String("content"),
DocumentationId: pulumi.String("57d1f7558aa04f15146d9d8a"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Title: pulumi.String("Title"),
})
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.apimanagement.Documentation;
import com.pulumi.azurenative.apimanagement.DocumentationArgs;
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 documentation = new Documentation("documentation", DocumentationArgs.builder()
.content("content")
.documentationId("57d1f7558aa04f15146d9d8a")
.resourceGroupName("rg1")
.serviceName("apimService1")
.title("Title")
.build());
}
}

Import

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

$ pulumi import azure-native:apimanagement:Documentation 57d1f7558aa04f15146d9d8a /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}

Constructors

Link copied to clipboard
constructor(content: Output<String>? = null, documentationId: Output<String>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, title: Output<String>? = null)

Properties

Link copied to clipboard
val content: Output<String>? = null

Markdown documentation content.

Link copied to clipboard
val documentationId: Output<String>? = null

Documentation identifier. Must be unique in the current API Management service instance.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the API Management service.

Link copied to clipboard
val title: Output<String>? = null

documentation title.

Functions

Link copied to clipboard
open override fun toJava(): DocumentationArgs