@kengachu-pulumi/azure-native-apimanagement
Version:
Pulumi Azure Native package for apimanagement
75 lines (74 loc) • 2.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Markdown documentation details.
* Azure REST API version: 2022-08-01.
*
* Other available API versions: 2022-09-01-preview, 2023-03-01-preview.
*/
export declare class Documentation extends pulumi.CustomResource {
/**
* Get an existing Documentation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Documentation;
/** @internal */
static readonly __pulumiType = "azure-native:apimanagement:Documentation";
/**
* Returns true if the given object is an instance of Documentation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Documentation;
/**
* Markdown documentation content.
*/
readonly content: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* documentation title.
*/
readonly title: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a Documentation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DocumentationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Documentation resource.
*/
export interface DocumentationArgs {
/**
* Markdown documentation content.
*/
content?: pulumi.Input<string>;
/**
* Documentation identifier. Must be unique in the current API Management service instance.
*/
documentationId?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* documentation title.
*/
title?: pulumi.Input<string>;
}