Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. Binding
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.appplatform.Binding

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Binding resource payload Azure REST API version: 2023-05-01-preview. Prior API version in Azure Native 1.x: 2020-07-01.

    Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-01-01-preview, 2024-05-01-preview.

    Example Usage

    Bindings_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var binding = new AzureNative.AppPlatform.Binding("binding", new()
    {
        AppName = "myapp",
        BindingName = "mybinding",
        Properties = new AzureNative.AppPlatform.Inputs.BindingResourcePropertiesArgs
        {
            BindingParameters = 
            {
                { "apiType", "SQL" },
                { "databaseName", "db1" },
            },
            Key = "xxxx",
            ResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1",
        },
        ResourceGroupName = "myResourceGroup",
        ServiceName = "myservice",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appplatform.NewBinding(ctx, "binding", &appplatform.BindingArgs{
			AppName:     pulumi.String("myapp"),
			BindingName: pulumi.String("mybinding"),
			Properties: &appplatform.BindingResourcePropertiesArgs{
				BindingParameters: pulumi.StringMap{
					"apiType":      pulumi.String("SQL"),
					"databaseName": pulumi.String("db1"),
				},
				Key:        pulumi.String("xxxx"),
				ResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1"),
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ServiceName:       pulumi.String("myservice"),
		})
		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.appplatform.Binding;
import com.pulumi.azurenative.appplatform.BindingArgs;
import com.pulumi.azurenative.appplatform.inputs.BindingResourcePropertiesArgs;
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 binding = new Binding("binding", BindingArgs.builder()
            .appName("myapp")
            .bindingName("mybinding")
            .properties(BindingResourcePropertiesArgs.builder()
                .bindingParameters(Map.ofEntries(
                    Map.entry("apiType", "SQL"),
                    Map.entry("databaseName", "db1")
                ))
                .key("xxxx")
                .resourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1")
                .build())
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

binding = azure_native.appplatform.Binding("binding",
    app_name="myapp",
    binding_name="mybinding",
    properties={
        "binding_parameters": {
            "api_type": "SQL",
            "database_name": "db1",
        },
        "key": "xxxx",
        "resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1",
    },
    resource_group_name="myResourceGroup",
    service_name="myservice")

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

const binding = new azure_native.appplatform.Binding("binding", {
    appName: "myapp",
    bindingName: "mybinding",
    properties: {
        bindingParameters: {
            apiType: "SQL",
            databaseName: "db1",
        },
        key: "xxxx",
        resourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1",
    },
    resourceGroupName: "myResourceGroup",
    serviceName: "myservice",
});

    resources:
  binding:
    type: azure-native:appplatform:Binding
    properties:
      appName: myapp
      bindingName: mybinding
      properties:
        bindingParameters:
          apiType: SQL
          databaseName: db1
        key: xxxx
        resourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1
      resourceGroupName: myResourceGroup
      serviceName: myservice

    Create Binding Resource

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

    Constructor syntax

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

@overload
def Binding(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            app_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            binding_name: Optional[str] = None,
            properties: Optional[BindingResourcePropertiesArgs] = None)
    func NewBinding(ctx *Context, name string, args BindingArgs, opts ...ResourceOption) (*Binding, error)
    public Binding(string name, BindingArgs args, CustomResourceOptions? opts = null)
    public Binding(String name, BindingArgs args)
public Binding(String name, BindingArgs args, CustomResourceOptions options)

    type: azure-native:appplatform:Binding
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 BindingArgs
    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 BindingArgs
    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 BindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BindingArgs
    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 bindingResource = new AzureNative.AppPlatform.Binding("bindingResource", new()
{
    AppName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    BindingName = "string",
    Properties = new AzureNative.AppPlatform.Inputs.BindingResourcePropertiesArgs
    {
        BindingParameters = 
        {
            { "string", "string" },
        },
        Key = "string",
        ResourceId = "string",
    },
});

    example, err := appplatform.NewBinding(ctx, "bindingResource", &appplatform.BindingArgs{
	AppName:           pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	BindingName:       pulumi.String("string"),
	Properties: &appplatform.BindingResourcePropertiesArgs{
		BindingParameters: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Key:        pulumi.String("string"),
		ResourceId: pulumi.String("string"),
	},
})

    var bindingResource = new Binding("bindingResource", BindingArgs.builder()
    .appName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .bindingName("string")
    .properties(BindingResourcePropertiesArgs.builder()
        .bindingParameters(Map.of("string", "string"))
        .key("string")
        .resourceId("string")
        .build())
    .build());

    binding_resource = azure_native.appplatform.Binding("bindingResource",
    app_name="string",
    resource_group_name="string",
    service_name="string",
    binding_name="string",
    properties={
        "bindingParameters": {
            "string": "string",
        },
        "key": "string",
        "resourceId": "string",
    })

    const bindingResource = new azure_native.appplatform.Binding("bindingResource", {
    appName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    bindingName: "string",
    properties: {
        bindingParameters: {
            string: "string",
        },
        key: "string",
        resourceId: "string",
    },
});

    type: azure-native:appplatform:Binding
properties:
    appName: string
    bindingName: string
    properties:
        bindingParameters:
            string: string
        key: string
        resourceId: string
    resourceGroupName: string
    serviceName: string

    Binding 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 Binding resource accepts the following input properties:

    AppName string
    The name of the App resource.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServiceName string
    The name of the Service resource.
    BindingName string
    The name of the Binding resource.
    Properties Pulumi.AzureNative.AppPlatform.Inputs.BindingResourceProperties
    Properties of the Binding resource
    AppName string
    The name of the App resource.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServiceName string
    The name of the Service resource.
    BindingName string
    The name of the Binding resource.
    Properties BindingResourcePropertiesArgs
    Properties of the Binding resource
    appName String
    The name of the App resource.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serviceName String
    The name of the Service resource.
    bindingName String
    The name of the Binding resource.
    properties BindingResourceProperties
    Properties of the Binding resource
    appName string
    The name of the App resource.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serviceName string
    The name of the Service resource.
    bindingName string
    The name of the Binding resource.
    properties BindingResourceProperties
    Properties of the Binding resource
    app_name str
    The name of the App resource.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    service_name str
    The name of the Service resource.
    binding_name str
    The name of the Binding resource.
    properties BindingResourcePropertiesArgs
    Properties of the Binding resource
    appName String
    The name of the App resource.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serviceName String
    The name of the Service resource.
    bindingName String
    The name of the Binding resource.
    properties Property Map
    Properties of the Binding resource

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.

    Supporting Types

    BindingResourceProperties, BindingResourcePropertiesArgs

    BindingParameters Dictionary<string, string>
    Binding parameters of the Binding resource
    Key string
    The key of the bound resource
    ResourceId string
    The Azure resource id of the bound resource
    BindingParameters map[string]string
    Binding parameters of the Binding resource
    Key string
    The key of the bound resource
    ResourceId string
    The Azure resource id of the bound resource
    bindingParameters Map<String,String>
    Binding parameters of the Binding resource
    key String
    The key of the bound resource
    resourceId String
    The Azure resource id of the bound resource
    bindingParameters {[key: string]: string}
    Binding parameters of the Binding resource
    key string
    The key of the bound resource
    resourceId string
    The Azure resource id of the bound resource
    binding_parameters Mapping[str, str]
    Binding parameters of the Binding resource
    key str
    The key of the bound resource
    resource_id str
    The Azure resource id of the bound resource
    bindingParameters Map<String>
    Binding parameters of the Binding resource
    key String
    The key of the bound resource
    resourceId String
    The Azure resource id of the bound resource

    BindingResourcePropertiesResponse, BindingResourcePropertiesResponseArgs

    CreatedAt string
    Creation time of the Binding resource
    GeneratedProperties string
    The generated Spring Boot property file for this binding. The secret will be deducted.
    ResourceName string
    The name of the bound resource
    ResourceType string
    The standard Azure resource type of the bound resource
    UpdatedAt string
    Update time of the Binding resource
    BindingParameters Dictionary<string, string>
    Binding parameters of the Binding resource
    Key string
    The key of the bound resource
    ResourceId string
    The Azure resource id of the bound resource
    CreatedAt string
    Creation time of the Binding resource
    GeneratedProperties string
    The generated Spring Boot property file for this binding. The secret will be deducted.
    ResourceName string
    The name of the bound resource
    ResourceType string
    The standard Azure resource type of the bound resource
    UpdatedAt string
    Update time of the Binding resource
    BindingParameters map[string]string
    Binding parameters of the Binding resource
    Key string
    The key of the bound resource
    ResourceId string
    The Azure resource id of the bound resource
    createdAt String
    Creation time of the Binding resource
    generatedProperties String
    The generated Spring Boot property file for this binding. The secret will be deducted.
    resourceName String
    The name of the bound resource
    resourceType String
    The standard Azure resource type of the bound resource
    updatedAt String
    Update time of the Binding resource
    bindingParameters Map<String,String>
    Binding parameters of the Binding resource
    key String
    The key of the bound resource
    resourceId String
    The Azure resource id of the bound resource
    createdAt string
    Creation time of the Binding resource
    generatedProperties string
    The generated Spring Boot property file for this binding. The secret will be deducted.
    resourceName string
    The name of the bound resource
    resourceType string
    The standard Azure resource type of the bound resource
    updatedAt string
    Update time of the Binding resource
    bindingParameters {[key: string]: string}
    Binding parameters of the Binding resource
    key string
    The key of the bound resource
    resourceId string
    The Azure resource id of the bound resource
    created_at str
    Creation time of the Binding resource
    generated_properties str
    The generated Spring Boot property file for this binding. The secret will be deducted.
    resource_name str
    The name of the bound resource
    resource_type str
    The standard Azure resource type of the bound resource
    updated_at str
    Update time of the Binding resource
    binding_parameters Mapping[str, str]
    Binding parameters of the Binding resource
    key str
    The key of the bound resource
    resource_id str
    The Azure resource id of the bound resource
    createdAt String
    Creation time of the Binding resource
    generatedProperties String
    The generated Spring Boot property file for this binding. The secret will be deducted.
    resourceName String
    The name of the bound resource
    resourceType String
    The standard Azure resource type of the bound resource
    updatedAt String
    Update time of the Binding resource
    bindingParameters Map<String>
    Binding parameters of the Binding resource
    key String
    The key of the bound resource
    resourceId String
    The Azure resource id of the bound resource

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource modification (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource modification (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource modification (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource modification (UTC).
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource modification (UTC).
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource modification (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:appplatform:Binding mybinding /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native