Class Product

Manages an API Management Product.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "West Europe",
    });
    var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@exmaple.com",
        SkuName = "Developer_1",
    });
    var exampleProduct = new Azure.ApiManagement.Product("exampleProduct", new Azure.ApiManagement.ProductArgs
    {
        ProductId = "test-product",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = exampleResourceGroup.Name,
        DisplayName = "Test Product",
        SubscriptionRequired = true,
        ApprovalRequired = true,
        Published = true,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Product

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class Product : CustomResource

Constructors

Product(String, ProductArgs, CustomResourceOptions)

Create a Product resource with the given unique name, arguments, and options.

Declaration

public Product(string name, ProductArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ProductArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

The name of the API Management Service. Changing this forces a new resource to be created.

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

ApprovalRequired

Do subscribers need to be approved prior to being able to use the Product?

Declaration

public Output<bool?> ApprovalRequired { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Description

A description of this Product, which may include HTML formatting tags.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

The Display Name for this API Management Product.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

ProductId

The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.

Declaration

public Output<string> ProductId { get; }

Property Value

Type	Description
Output<System.String>

Published

Is this Product Published?

Declaration

public Output<bool> Published { get; }

Property Value

Type	Description
Output<System.Boolean>

ResourceGroupName

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SubscriptionRequired

Is a Subscription required to access API's included in this Product?

Declaration

public Output<bool> SubscriptionRequired { get; }

Property Value

Type	Description
Output<System.Boolean>

SubscriptionsLimit

The number of subscriptions a user can have to this Product at the same time.

Declaration

public Output<int?> SubscriptionsLimit { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Terms

The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

Declaration

public Output<string> Terms { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ProductState, CustomResourceOptions)

Get an existing Product resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Product Get(string name, Input<string> id, ProductState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ProductState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Product