Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. Property
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.Property

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

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

    Example Usage

    ApiManagementCreateProperty

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var property = new AzureNative.ApiManagement.Property("property", new()
    {
        DisplayName = "prop3name",
        PropId = "testprop2",
        ResourceGroupName = "rg1",
        Secret = true,
        ServiceName = "apimService1",
        Tags = new[]
        {
            "foo",
            "bar",
        },
        Value = "propValue",
    });

});

    package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Property;
import com.pulumi.azurenative.apimanagement.PropertyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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 Property Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Property(name: string, args: PropertyArgs, opts?: CustomResourceOptions);
    @overload
def Property(resource_name: str,
             args: PropertyArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Property(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             display_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             service_name: Optional[str] = None,
             value: Optional[str] = None,
             prop_id: Optional[str] = None,
             secret: Optional[bool] = None,
             tags: Optional[Sequence[str]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var propertyResource = new AzureNative.Apimanagement.Property("propertyResource", new()
{
    DisplayName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    Value = "string",
    PropId = "string",
    Secret = false,
    Tags = new[]
    {
        "string",
    },
});

    example, err := apimanagement.NewProperty(ctx, "propertyResource", &apimanagement.PropertyArgs{
	DisplayName:       "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	Value:             "string",
	PropId:            "string",
	Secret:            false,
	Tags: []string{
		"string",
	},
})

    var propertyResource = new Property("propertyResource", PropertyArgs.builder()
    .displayName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .value("string")
    .propId("string")
    .secret(false)
    .tags("string")
    .build());

    property_resource = azure_native.apimanagement.Property("propertyResource",
    display_name=string,
    resource_group_name=string,
    service_name=string,
    value=string,
    prop_id=string,
    secret=False,
    tags=[string])

    const propertyResource = new azure_native.apimanagement.Property("propertyResource", {
    displayName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    value: "string",
    propId: "string",
    secret: false,
    tags: ["string"],
});

    type: azure-native:apimanagement:Property
properties:
    displayName: string
    propId: string
    resourceGroupName: string
    secret: false
    serviceName: string
    tags:
        - string
    value: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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<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 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<String>
    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native