azure-native.apimanagement.ProductWiki
Explore with Pulumi AI
Wiki properties
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 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
This property is required. string - The unique name of the resource.
- args
This property is required. ProductWikiArgs - 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. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ProductWikiArgs - 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. ProductWikiArgs - 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. ProductWikiArgs - 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 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=[{
"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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ProductWiki resource accepts the following input properties:
- Product
Id This property is required. Changes to this property will trigger replacement.
- Product identifier. Must be unique in the current API Management service instance.
- 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.
- Documents
List<Pulumi.
Azure Native. Api Management. Inputs. Wiki Documentation Contract> - Collection wiki documents included into this wiki.
- Product
Id This property is required. Changes to this property will trigger replacement.
- Product identifier. Must be unique in the current API Management service instance.
- 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.
- Documents
[]Wiki
Documentation Contract Args - Collection wiki documents included into this wiki.
- product
Id This property is required. Changes to this property will trigger replacement.
- Product identifier. Must be unique in the current API Management service instance.
- 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.
- documents
List<Wiki
Documentation Contract> - Collection wiki documents included into this wiki.
- product
Id This property is required. Changes to this property will trigger replacement.
- Product identifier. Must be unique in the current API Management service instance.
- 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.
- documents
Wiki
Documentation Contract[] - Collection wiki documents included into this wiki.
- product_
id This property is required. Changes to this property will trigger replacement.
- Product identifier. Must be unique in the current API Management service instance.
- 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.
- documents
Sequence[Wiki
Documentation Contract Args] - Collection wiki documents included into this wiki.
- product
Id This property is required. Changes to this property will trigger replacement.
- Product identifier. Must be unique in the current API Management service instance.
- 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.
- 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:
- 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"
Supporting Types
WikiDocumentationContract, WikiDocumentationContractArgs
- Documentation
Id string - Documentation Identifier
- Documentation
Id string - Documentation Identifier
- documentation
Id String - Documentation Identifier
- documentation
Id string - Documentation Identifier
- documentation_
id str - Documentation Identifier
- documentation
Id String - Documentation Identifier
WikiDocumentationContractResponse, WikiDocumentationContractResponseArgs
- Documentation
Id string - Documentation Identifier
- Documentation
Id string - Documentation Identifier
- documentation
Id String - Documentation Identifier
- documentation
Id string - Documentation Identifier
- documentation_
id str - Documentation Identifier
- documentation
Id 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