← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

Source code

Property

Property details. API Version: 2019-01-01.

Example Usage

ApiManagementCreateProperty

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var property = new AzureNative.ApiManagement.Property("property", new AzureNative.ApiManagement.PropertyArgs
        {
            DisplayName = "prop3name",
            PropId = "testprop2",
            ResourceGroupName = "rg1",
            Secret = true,
            ServiceName = "apimService1",
            Tags = 
            {
                "foo",
                "bar",
            },
            Value = "propValue",
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewProperty(ctx, "property", &apimanagement.PropertyArgs{
			DisplayName:       pulumi.String("prop3name"),
			PropId:            pulumi.String("testprop2"),
			ResourceGroupName: pulumi.String("rg1"),
			Secret:            pulumi.Bool(true),
			ServiceName:       pulumi.String("apimService1"),
			Tags: pulumi.StringArray{
				pulumi.String("foo"),
				pulumi.String("bar"),
			},
			Value: pulumi.String("propValue"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var property = new Property("property", PropertyArgs.builder()        
            .displayName("prop3name")
            .propId("testprop2")
            .resourceGroupName("rg1")
            .secret(true)
            .serviceName("apimService1")
            .tags(            
                "foo",
                "bar")
            .value("propValue")
            .build());

        }
}

import pulumi
import pulumi_azure_native as azure_native

property = azure_native.apimanagement.Property("property",
    display_name="prop3name",
    prop_id="testprop2",
    resource_group_name="rg1",
    secret=True,
    service_name="apimService1",
    tags=[
        "foo",
        "bar",
    ],
    value="propValue")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const property = new azure_native.apimanagement.Property("property", {
    displayName: "prop3name",
    propId: "testprop2",
    resourceGroupName: "rg1",
    secret: true,
    serviceName: "apimService1",
    tags: [
        "foo",
        "bar",
    ],
    value: "propValue",
});

resources:
  property:
    type: azure-native:apimanagement:Property
    properties:
      displayName: prop3name
      propId: testprop2
      resourceGroupName: rg1
      secret: true
      serviceName: apimService1
      tags:
        - foo
        - bar
      value: propValue

Create a Property Resource

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

@overload
def Property(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             display_name: Optional[str] = None,
             prop_id: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             secret: Optional[bool] = None,
             service_name: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             value: Optional[str] = None)
@overload
def Property(resource_name: str,
             args: PropertyArgs,
             opts: Optional[ResourceOptions] = None)

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

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

public Property(String name, PropertyArgs args)
public Property(String name, PropertyArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:Property
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args PropertyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args PropertyArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Property resource accepts the following input properties:

DisplayName string: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
Value string: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
PropId string: Identifier of the property.
Secret bool: Determines whether the value is a secret and should be encrypted or not. Default value is false.
Tags List<string>: Optional tags that when provided can be used to filter the property list.

DisplayName string: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
Value string: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
PropId string: Identifier of the property.
Secret bool: Determines whether the value is a secret and should be encrypted or not. Default value is false.
Tags []string: Optional tags that when provided can be used to filter the property list.

displayName String: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
value String: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
propId String: Identifier of the property.
secret Boolean: Determines whether the value is a secret and should be encrypted or not. Default value is false.
tags List: Optional tags that when provided can be used to filter the property list.

displayName string: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.
value string: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
propId string: Identifier of the property.
secret boolean: Determines whether the value is a secret and should be encrypted or not. Default value is false.
tags string[]: Optional tags that when provided can be used to filter the property list.

display_name str: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.
value str: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
prop_id str: Identifier of the property.
secret bool: Determines whether the value is a secret and should be encrypted or not. Default value is false.
tags Sequence[str]: Optional tags that when provided can be used to filter the property list.

displayName String: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
value String: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
propId String: Identifier of the property.
secret Boolean: Determines whether the value is a secret and should be encrypted or not. Default value is false.
tags List: Optional tags that when provided can be used to filter the property list.

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.
Name string: Resource name.
Type string: Resource type for API Management resource.

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
type string: Resource type for API Management resource.

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
type str: Resource type for API Management resource.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:Property testprop2 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/properties/testprop2

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0