Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. Documentation
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.Documentation

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Markdown documentation details. Azure REST API version: 2022-08-01.

    Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.

    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/v2"
	"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 pulumi
import pulumi_azure_native as azure_native

documentation = azure_native.apimanagement.Documentation("documentation",
    content="content",
    documentation_id="57d1f7558aa04f15146d9d8a",
    resource_group_name="rg1",
    service_name="apimService1",
    title="Title")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const documentation = new azure_native.apimanagement.Documentation("documentation", {
    content: "content",
    documentationId: "57d1f7558aa04f15146d9d8a",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    title: "Title",
});

    resources:
  documentation:
    type: azure-native:apimanagement:Documentation
    properties:
      content: content
      documentationId: 57d1f7558aa04f15146d9d8a
      resourceGroupName: rg1
      serviceName: apimService1
      title: Title

    Create Documentation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Documentation(name: string, args: DocumentationArgs, opts?: CustomResourceOptions);
    @overload
def Documentation(resource_name: str,
                  args: DocumentationArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def Documentation(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  resource_group_name: Optional[str] = None,
                  service_name: Optional[str] = None,
                  content: Optional[str] = None,
                  documentation_id: Optional[str] = None,
                  title: Optional[str] = None)
    func NewDocumentation(ctx *Context, name string, args DocumentationArgs, opts ...ResourceOption) (*Documentation, error)
    public Documentation(string name, DocumentationArgs args, CustomResourceOptions? opts = null)
    public Documentation(String name, DocumentationArgs args)
public Documentation(String name, DocumentationArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:Documentation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DocumentationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DocumentationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DocumentationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var documentationResource = new AzureNative.ApiManagement.Documentation("documentationResource", new()
{
    ResourceGroupName = "string",
    ServiceName = "string",
    Content = "string",
    DocumentationId = "string",
    Title = "string",
});

    example, err := apimanagement.NewDocumentation(ctx, "documentationResource", &apimanagement.DocumentationArgs{
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Content:           pulumi.String("string"),
	DocumentationId:   pulumi.String("string"),
	Title:             pulumi.String("string"),
})

    var documentationResource = new Documentation("documentationResource", DocumentationArgs.builder()
    .resourceGroupName("string")
    .serviceName("string")
    .content("string")
    .documentationId("string")
    .title("string")
    .build());

    documentation_resource = azure_native.apimanagement.Documentation("documentationResource",
    resource_group_name="string",
    service_name="string",
    content="string",
    documentation_id="string",
    title="string")

    const documentationResource = new azure_native.apimanagement.Documentation("documentationResource", {
    resourceGroupName: "string",
    serviceName: "string",
    content: "string",
    documentationId: "string",
    title: "string",
});

    type: azure-native:apimanagement:Documentation
properties:
    content: string
    documentationId: string
    resourceGroupName: string
    serviceName: string
    title: string

    Documentation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Documentation resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Content string
    Markdown documentation content.
    DocumentationId string
    Documentation identifier. Must be unique in the current API Management service instance.
    Title string
    documentation title.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Content string
    Markdown documentation content.
    DocumentationId string
    Documentation identifier. Must be unique in the current API Management service instance.
    Title string
    documentation title.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    content String
    Markdown documentation content.
    documentationId String
    Documentation identifier. Must be unique in the current API Management service instance.
    title String
    documentation title.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    content string
    Markdown documentation content.
    documentationId string
    Documentation identifier. Must be unique in the current API Management service instance.
    title string
    documentation title.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    content str
    Markdown documentation content.
    documentation_id str
    Documentation identifier. Must be unique in the current API Management service instance.
    title str
    documentation title.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    content String
    Markdown documentation content.
    documentationId String
    Documentation identifier. Must be unique in the current API Management service instance.
    title String
    documentation title.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Documentation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    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}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native