azure-native.apimanagement.Documentation
Explore with Pulumi AI
Markdown documentation details.
Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.
Other available API versions: 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]
. See the version guide for details.
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
This property is required. string - The unique name of the resource.
- args
This property is required. DocumentationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. DocumentationArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DocumentationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- Content string
- Markdown documentation content.
- Documentation
Id Changes to this property will trigger replacement.
- Documentation identifier. Must be unique in the current API Management service instance.
- Title string
- documentation title.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- Content string
- Markdown documentation content.
- Documentation
Id Changes to this property will trigger replacement.
- Documentation identifier. Must be unique in the current API Management service instance.
- Title string
- documentation title.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- content String
- Markdown documentation content.
- documentation
Id Changes to this property will trigger replacement.
- Documentation identifier. Must be unique in the current API Management service instance.
- title String
- documentation title.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- content string
- Markdown documentation content.
- documentation
Id Changes to this property will trigger replacement.
- Documentation identifier. Must be unique in the current API Management service instance.
- title string
- documentation title.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service_
name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- content str
- Markdown documentation content.
- documentation_
id Changes to this property will trigger replacement.
- Documentation identifier. Must be unique in the current API Management service instance.
- title str
- documentation title.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- content String
- Markdown documentation content.
- documentation
Id Changes to this property will trigger replacement.
- 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- 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"
- azure
Api StringVersion - The Azure API version of the resource.
- 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"
- azure
Api stringVersion - The Azure API version of the resource.
- 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"
- azure_
api_ strversion - The Azure API version of the resource.
- 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"
- azure
Api StringVersion - The Azure API version of the resource.
- 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