Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ApiWiki
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.ApiWiki

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

    Wiki properties 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

    ApiManagementCreateApiWiki

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var apiWiki = new AzureNative.ApiManagement.ApiWiki("apiWiki", new()
    {
        ApiId = "57d1f7558aa04f15146d9d8a",
        Documents = new[]
        {
            new AzureNative.ApiManagement.Inputs.WikiDocumentationContractArgs
            {
                DocumentationId = "docId1",
            },
            new AzureNative.ApiManagement.Inputs.WikiDocumentationContractArgs
            {
                DocumentationId = "docId2",
            },
        },
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });

});

    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.NewApiWiki(ctx, "apiWiki", &apimanagement.ApiWikiArgs{
			ApiId: pulumi.String("57d1f7558aa04f15146d9d8a"),
			Documents: apimanagement.WikiDocumentationContractArray{
				&apimanagement.WikiDocumentationContractArgs{
					DocumentationId: pulumi.String("docId1"),
				},
				&apimanagement.WikiDocumentationContractArgs{
					DocumentationId: pulumi.String("docId2"),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
		})
		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.ApiWiki;
import com.pulumi.azurenative.apimanagement.ApiWikiArgs;
import com.pulumi.azurenative.apimanagement.inputs.WikiDocumentationContractArgs;
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 apiWiki = new ApiWiki("apiWiki", ApiWikiArgs.builder()
            .apiId("57d1f7558aa04f15146d9d8a")
            .documents(            
                WikiDocumentationContractArgs.builder()
                    .documentationId("docId1")
                    .build(),
                WikiDocumentationContractArgs.builder()
                    .documentationId("docId2")
                    .build())
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

api_wiki = azure_native.apimanagement.ApiWiki("apiWiki",
    api_id="57d1f7558aa04f15146d9d8a",
    documents=[
        {
            "documentation_id": "docId1",
        },
        {
            "documentation_id": "docId2",
        },
    ],
    resource_group_name="rg1",
    service_name="apimService1")

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

const apiWiki = new azure_native.apimanagement.ApiWiki("apiWiki", {
    apiId: "57d1f7558aa04f15146d9d8a",
    documents: [
        {
            documentationId: "docId1",
        },
        {
            documentationId: "docId2",
        },
    ],
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});

    resources:
  apiWiki:
    type: azure-native:apimanagement:ApiWiki
    properties:
      apiId: 57d1f7558aa04f15146d9d8a
      documents:
        - documentationId: docId1
        - documentationId: docId2
      resourceGroupName: rg1
      serviceName: apimService1

    Create ApiWiki Resource

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

    Constructor syntax

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

@overload
def ApiWiki(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            documents: Optional[Sequence[WikiDocumentationContractArgs]] = None)
    func NewApiWiki(ctx *Context, name string, args ApiWikiArgs, opts ...ResourceOption) (*ApiWiki, error)
    public ApiWiki(string name, ApiWikiArgs args, CustomResourceOptions? opts = null)
    public ApiWiki(String name, ApiWikiArgs args)
public ApiWiki(String name, ApiWikiArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:ApiWiki
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 ApiWikiArgs
    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 ApiWikiArgs
    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 ApiWikiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiWikiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiWikiArgs
    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 apiWikiResource = new AzureNative.ApiManagement.ApiWiki("apiWikiResource", new()
{
    ApiId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    Documents = new[]
    {
        new AzureNative.ApiManagement.Inputs.WikiDocumentationContractArgs
        {
            DocumentationId = "string",
        },
    },
});

    example, err := apimanagement.NewApiWiki(ctx, "apiWikiResource", &apimanagement.ApiWikiArgs{
	ApiId:             pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Documents: apimanagement.WikiDocumentationContractArray{
		&apimanagement.WikiDocumentationContractArgs{
			DocumentationId: pulumi.String("string"),
		},
	},
})

    var apiWikiResource = new ApiWiki("apiWikiResource", ApiWikiArgs.builder()
    .apiId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .documents(WikiDocumentationContractArgs.builder()
        .documentationId("string")
        .build())
    .build());

    api_wiki_resource = azure_native.apimanagement.ApiWiki("apiWikiResource",
    api_id="string",
    resource_group_name="string",
    service_name="string",
    documents=[{
        "documentation_id": "string",
    }])

    const apiWikiResource = new azure_native.apimanagement.ApiWiki("apiWikiResource", {
    apiId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    documents: [{
        documentationId: "string",
    }],
});

    type: azure-native:apimanagement:ApiWiki
properties:
    apiId: string
    documents:
        - documentationId: string
    resourceGroupName: string
    serviceName: string

    ApiWiki 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 ApiWiki resource accepts the following input properties:

    ApiId string
    API identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Documents List<Pulumi.AzureNative.ApiManagement.Inputs.WikiDocumentationContract>
    Collection wiki documents included into this wiki.
    ApiId string
    API identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Documents []WikiDocumentationContractArgs
    Collection wiki documents included into this wiki.
    apiId String
    API identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    documents List<WikiDocumentationContract>
    Collection wiki documents included into this wiki.
    apiId string
    API identifier. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    documents WikiDocumentationContract[]
    Collection wiki documents included into this wiki.
    api_id str
    API identifier. Must be unique in the current API Management service instance.
    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.
    documents Sequence[WikiDocumentationContractArgs]
    Collection wiki documents included into this wiki.
    apiId String
    API identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    documents List<Property Map>
    Collection wiki documents included into this wiki.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiWiki 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"

    Supporting Types

    WikiDocumentationContract, WikiDocumentationContractArgs

    DocumentationId string
    Documentation Identifier
    DocumentationId string
    Documentation Identifier
    documentationId String
    Documentation Identifier
    documentationId string
    Documentation Identifier
    documentation_id str
    Documentation Identifier
    documentationId String
    Documentation Identifier

    WikiDocumentationContractResponse, WikiDocumentationContractResponseArgs

    DocumentationId string
    Documentation Identifier
    DocumentationId string
    Documentation Identifier
    documentationId String
    Documentation Identifier
    documentationId string
    Documentation Identifier
    documentation_id str
    Documentation Identifier
    documentationId String
    Documentation Identifier

    Import

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

    $ pulumi import azure-native:apimanagement:ApiWiki default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default

    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