Property

Manages an API Management Property.

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 US",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "pub1",
            PublisherEmail = "pub1@email.com",
            SkuName = "Developer_1",
        });
        var exampleProperty = new Azure.ApiManagement.Property("exampleProperty", new Azure.ApiManagement.PropertyArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            ApiManagementName = exampleService.Name,
            DisplayName = "ExampleProperty",
            Value = "Example Value",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            PublisherName:     pulumi.String("pub1"),
            PublisherEmail:    pulumi.String("pub1@email.com"),
            SkuName:           pulumi.String("Developer_1"),
        })
        if err != nil {
            return err
        }
        _, err = apimanagement.NewProperty(ctx, "exampleProperty", &apimanagement.PropertyArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            ApiManagementName: exampleService.Name,
            DisplayName:       pulumi.String("ExampleProperty"),
            Value:             pulumi.String("Example Value"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_property = azure.apimanagement.Property("exampleProperty",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="ExampleProperty",
    value="Example Value")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleProperty = new azure.apimanagement.Property("exampleProperty", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleProperty",
    value: "Example Value",
});

Create a Property Resource

new Property(name: string, args: PropertyArgs, opts?: CustomResourceOptions);

def Property(resource_name, opts=None, api_management_name=None, display_name=None, name=None, resource_group_name=None, secret=None, tags=None, value=None, __props__=None);

func NewProperty(ctx *Context, name string, args PropertyArgs, opts ...ResourceOption) (*Property, error)

public Property(string name, PropertyArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args PropertyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PropertyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PropertyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Property Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Property resource accepts the following input properties:

ApiManagementName string: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Management Property.
ResourceGroupName string: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
Value string: The value of this API Management Property.
Name string: The name of the API Management Property. Changing this forces a new resource to be created.
Secret bool: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
Tags List<string>: A list of tags to be applied to the API Management Property.

ApiManagementName string: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Management Property.
ResourceGroupName string: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
Value string: The value of this API Management Property.
Name string: The name of the API Management Property. Changing this forces a new resource to be created.
Secret bool: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
Tags []string: A list of tags to be applied to the API Management Property.

apiManagementName string: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
displayName string: The display name of this API Management Property.
resourceGroupName string: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
value string: The value of this API Management Property.
name string: The name of the API Management Property. Changing this forces a new resource to be created.
secret boolean: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
tags string[]: A list of tags to be applied to the API Management Property.

api_management_name str: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
display_name str: The display name of this API Management Property.
resource_group_name str: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
value str: The value of this API Management Property.
name str: The name of the API Management Property. Changing this forces a new resource to be created.
secret bool: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
tags List[str]: A list of tags to be applied to the API Management Property.

Outputs

All input properties are implicitly available as output properties. Additionally, the Property resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Property Resource

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

public static get(name: string, id: Input<ID>, state?: PropertyState, opts?: CustomResourceOptions): Property

static get(resource_name, id, opts=None, api_management_name=None, display_name=None, name=None, resource_group_name=None, secret=None, tags=None, value=None, __props__=None);

func GetProperty(ctx *Context, name string, id IDInput, state *PropertyState, opts ...ResourceOption) (*Property, error)

public static Property Get(string name, Input<string> id, PropertyState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiManagementName string: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Management Property.
Name string: The name of the API Management Property. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
Secret bool: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
Tags List<string>: A list of tags to be applied to the API Management Property.
Value string: The value of this API Management Property.

ApiManagementName string: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
DisplayName string: The display name of this API Management Property.
Name string: The name of the API Management Property. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
Secret bool: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
Tags []string: A list of tags to be applied to the API Management Property.
Value string: The value of this API Management Property.

apiManagementName string: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
displayName string: The display name of this API Management Property.
name string: The name of the API Management Property. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
secret boolean: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
tags string[]: A list of tags to be applied to the API Management Property.
value string: The value of this API Management Property.

api_management_name str: The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
display_name str: The display name of this API Management Property.
name str: The name of the API Management Property. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
secret bool: Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
tags List[str]: A list of tags to be applied to the API Management Property.
value str: The value of this API Management Property.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud