Azure Native v2.10.0, Oct 4 23

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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.apimanagement.ApiWiki

Explore with Pulumi AI

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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

pulumi/pulumi-azure-native

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 (
	"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.WikiDocumentationContractArgs{
				{
					DocumentationId: pulumi.String("docId1"),
				},
				{
					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 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(            
                Map.of("documentationId", "docId1"),
                Map.of("documentationId", "docId2"))
            .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=[
        azure_native.apimanagement.WikiDocumentationContractArgs(
            documentation_id="docId1",
        ),
        azure_native.apimanagement.WikiDocumentationContractArgs(
            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

new ApiWiki(name: string, args: ApiWikiArgs, opts?: CustomResourceOptions);

@overload
def ApiWiki(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_id: Optional[str] = None,
            documents: Optional[Sequence[WikiDocumentationContractArgs]] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None)
@overload
def ApiWiki(resource_name: str,
            args: ApiWikiArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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

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

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.apimanagement.ApiWiki

On this page

On this page

Example Usage

ApiManagementCreateApiWiki

Create ApiWiki Resource

ApiWiki Resource Properties

Inputs

Outputs

Supporting Types

WikiDocumentationContract, WikiDocumentationContractArgs

WikiDocumentationContractResponse, WikiDocumentationContractResponseArgs

Import

Package Details

On this page

On this page