1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ProductWiki
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.ProductWiki

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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    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.

    Example Usage

    ApiManagementCreateProductWiki

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var productWiki = new AzureNative.ApiManagement.ProductWiki("productWiki", new()
        {
            Documents = new[]
            {
                new AzureNative.ApiManagement.Inputs.WikiDocumentationContractArgs
                {
                    DocumentationId = "docId1",
                },
                new AzureNative.ApiManagement.Inputs.WikiDocumentationContractArgs
                {
                    DocumentationId = "docId2",
                },
            },
            ProductId = "57d1f7558aa04f15146d9d8a",
            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.NewProductWiki(ctx, "productWiki", &apimanagement.ProductWikiArgs{
    			Documents: apimanagement.WikiDocumentationContractArray{
    				&apimanagement.WikiDocumentationContractArgs{
    					DocumentationId: pulumi.String("docId1"),
    				},
    				&apimanagement.WikiDocumentationContractArgs{
    					DocumentationId: pulumi.String("docId2"),
    				},
    			},
    			ProductId:         pulumi.String("57d1f7558aa04f15146d9d8a"),
    			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.ProductWiki;
    import com.pulumi.azurenative.apimanagement.ProductWikiArgs;
    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 productWiki = new ProductWiki("productWiki", ProductWikiArgs.builder()        
                .documents(            
                    WikiDocumentationContractArgs.builder()
                        .documentationId("docId1")
                        .build(),
                    WikiDocumentationContractArgs.builder()
                        .documentationId("docId2")
                        .build())
                .productId("57d1f7558aa04f15146d9d8a")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    product_wiki = azure_native.apimanagement.ProductWiki("productWiki",
        documents=[
            azure_native.apimanagement.WikiDocumentationContractArgs(
                documentation_id="docId1",
            ),
            azure_native.apimanagement.WikiDocumentationContractArgs(
                documentation_id="docId2",
            ),
        ],
        product_id="57d1f7558aa04f15146d9d8a",
        resource_group_name="rg1",
        service_name="apimService1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const productWiki = new azure_native.apimanagement.ProductWiki("productWiki", {
        documents: [
            {
                documentationId: "docId1",
            },
            {
                documentationId: "docId2",
            },
        ],
        productId: "57d1f7558aa04f15146d9d8a",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
    });
    
    resources:
      productWiki:
        type: azure-native:apimanagement:ProductWiki
        properties:
          documents:
            - documentationId: docId1
            - documentationId: docId2
          productId: 57d1f7558aa04f15146d9d8a
          resourceGroupName: rg1
          serviceName: apimService1
    

    Create ProductWiki Resource

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

    Constructor syntax

    new ProductWiki(name: string, args: ProductWikiArgs, opts?: CustomResourceOptions);
    @overload
    def ProductWiki(resource_name: str,
                    args: ProductWikiArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProductWiki(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    product_id: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    service_name: Optional[str] = None,
                    documents: Optional[Sequence[WikiDocumentationContractArgs]] = None)
    func NewProductWiki(ctx *Context, name string, args ProductWikiArgs, opts ...ResourceOption) (*ProductWiki, error)
    public ProductWiki(string name, ProductWikiArgs args, CustomResourceOptions? opts = null)
    public ProductWiki(String name, ProductWikiArgs args)
    public ProductWiki(String name, ProductWikiArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:ProductWiki
    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 ProductWikiArgs
    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 ProductWikiArgs
    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 ProductWikiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProductWikiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProductWikiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var productWikiResource = new AzureNative.ApiManagement.ProductWiki("productWikiResource", new()
    {
        ProductId = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        Documents = new[]
        {
            new AzureNative.ApiManagement.Inputs.WikiDocumentationContractArgs
            {
                DocumentationId = "string",
            },
        },
    });
    
    example, err := apimanagement.NewProductWiki(ctx, "productWikiResource", &apimanagement.ProductWikiArgs{
    ProductId: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    Documents: apimanagement.WikiDocumentationContractArray{
    &apimanagement.WikiDocumentationContractArgs{
    DocumentationId: pulumi.String("string"),
    },
    },
    })
    
    var productWikiResource = new ProductWiki("productWikiResource", ProductWikiArgs.builder()        
        .productId("string")
        .resourceGroupName("string")
        .serviceName("string")
        .documents(WikiDocumentationContractArgs.builder()
            .documentationId("string")
            .build())
        .build());
    
    product_wiki_resource = azure_native.apimanagement.ProductWiki("productWikiResource",
        product_id="string",
        resource_group_name="string",
        service_name="string",
        documents=[azure_native.apimanagement.WikiDocumentationContractArgs(
            documentation_id="string",
        )])
    
    const productWikiResource = new azure_native.apimanagement.ProductWiki("productWikiResource", {
        productId: "string",
        resourceGroupName: "string",
        serviceName: "string",
        documents: [{
            documentationId: "string",
        }],
    });
    
    type: azure-native:apimanagement:ProductWiki
    properties:
        documents:
            - documentationId: string
        productId: string
        resourceGroupName: string
        serviceName: string
    

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

    ProductId string
    Product 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.
    ProductId string
    Product 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.
    productId String
    Product 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.
    productId string
    Product 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.
    product_id str
    Product 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.
    productId String
    Product 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 ProductWiki 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:ProductWiki default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/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.37.0 published on Monday, Apr 15, 2024 by Pulumi