1. Packages
  2. Azure Native v1
  3. API Docs
  4. appplatform
  5. Binding
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

azure-native.appplatform.Binding

Explore with Pulumi AI

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

Binding resource payload API Version: 2020-07-01.

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",
    });

});
Copy
package main

import (
	appplatform "github.com/pulumi/pulumi-azure-native-sdk/appplatform"
	"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.AnyMap{
					"apiType":      pulumi.Any("SQL"),
					"databaseName": pulumi.Any("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
	})
}
Copy
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 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(Map.ofEntries(
                Map.entry("bindingParameters", Map.ofEntries(
                    Map.entry("apiType", "SQL"),
                    Map.entry("databaseName", "db1")
                )),
                Map.entry("key", "xxxx"),
                Map.entry("resourceId", "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1")
            ))
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .build());

    }
}
Copy
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",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

binding = azure_native.appplatform.Binding("binding",
    app_name="myapp",
    binding_name="mybinding",
    properties=azure_native.appplatform.BindingResourcePropertiesArgs(
        binding_parameters={
            "apiType": "SQL",
            "databaseName": "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")
Copy
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
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. BindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. BindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 = 
    {
        { "bindingParameters", 
        {
            { "string", "any" },
        } },
        { "key", "string" },
        { "resourceId", "string" },
    },
});
Copy
example, err := appplatform.NewBinding(ctx, "bindingResource", &appplatform.BindingArgs{
	AppName:           "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	BindingName:       "string",
	Properties: map[string]interface{}{
		"bindingParameters": map[string]interface{}{
			"string": "any",
		},
		"key":        "string",
		"resourceId": "string",
	},
})
Copy
var bindingResource = new Binding("bindingResource", BindingArgs.builder()
    .appName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .bindingName("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
binding_resource = azure_native.appplatform.Binding("bindingResource",
    app_name=string,
    resource_group_name=string,
    service_name=string,
    binding_name=string,
    properties={
        bindingParameters: {
            string: any,
        },
        key: string,
        resourceId: string,
    })
Copy
const bindingResource = new azure_native.appplatform.Binding("bindingResource", {
    appName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    bindingName: "string",
    properties: {
        bindingParameters: {
            string: "any",
        },
        key: "string",
        resourceId: "string",
    },
});
Copy
type: azure-native:appplatform:Binding
properties:
    appName: string
    bindingName: string
    properties:
        bindingParameters:
            string: any
        key: string
        resourceId: string
    resourceGroupName: string
    serviceName: string
Copy

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

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

The Binding resource accepts the following input properties:

AppName
This property is required.
Changes to this property will trigger replacement.
string
The name of the App resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
BindingName Changes to this property will trigger replacement. string
The name of the Binding resource.
Properties Pulumi.AzureNative.AppPlatform.Inputs.BindingResourceProperties
Properties of the Binding resource
AppName
This property is required.
Changes to this property will trigger replacement.
string
The name of the App resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
BindingName Changes to this property will trigger replacement. string
The name of the Binding resource.
Properties BindingResourcePropertiesArgs
Properties of the Binding resource
appName
This property is required.
Changes to this property will trigger replacement.
String
The name of the App resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
bindingName Changes to this property will trigger replacement. String
The name of the Binding resource.
properties BindingResourceProperties
Properties of the Binding resource
appName
This property is required.
Changes to this property will trigger replacement.
string
The name of the App resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
bindingName Changes to this property will trigger replacement. string
The name of the Binding resource.
properties BindingResourceProperties
Properties of the Binding resource
app_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the App resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
binding_name Changes to this property will trigger replacement. str
The name of the Binding resource.
properties BindingResourcePropertiesArgs
Properties of the Binding resource
appName
This property is required.
Changes to this property will trigger replacement.
String
The name of the App resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
bindingName Changes to this property will trigger replacement. 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.
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.
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.
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.
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.
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.
type String
The type of the resource.

Supporting Types

BindingResourceProperties
, BindingResourcePropertiesArgs

BindingParameters Dictionary<string, object>
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]interface{}
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,Object>
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]: any}
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, Any]
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<Any>
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 This property is required. string
Creation time of the Binding resource
GeneratedProperties This property is required. string
The generated Spring Boot property file for this binding. The secret will be deducted.
ResourceName This property is required. string
The name of the bound resource
ResourceType This property is required. string
The standard Azure resource type of the bound resource
UpdatedAt This property is required. string
Update time of the Binding resource
BindingParameters Dictionary<string, object>
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 This property is required. string
Creation time of the Binding resource
GeneratedProperties This property is required. string
The generated Spring Boot property file for this binding. The secret will be deducted.
ResourceName This property is required. string
The name of the bound resource
ResourceType This property is required. string
The standard Azure resource type of the bound resource
UpdatedAt This property is required. string
Update time of the Binding resource
BindingParameters map[string]interface{}
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 This property is required. String
Creation time of the Binding resource
generatedProperties This property is required. String
The generated Spring Boot property file for this binding. The secret will be deducted.
resourceName This property is required. String
The name of the bound resource
resourceType This property is required. String
The standard Azure resource type of the bound resource
updatedAt This property is required. String
Update time of the Binding resource
bindingParameters Map<String,Object>
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 This property is required. string
Creation time of the Binding resource
generatedProperties This property is required. string
The generated Spring Boot property file for this binding. The secret will be deducted.
resourceName This property is required. string
The name of the bound resource
resourceType This property is required. string
The standard Azure resource type of the bound resource
updatedAt This property is required. string
Update time of the Binding resource
bindingParameters {[key: string]: any}
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 This property is required. str
Creation time of the Binding resource
generated_properties This property is required. str
The generated Spring Boot property file for this binding. The secret will be deducted.
resource_name This property is required. str
The name of the bound resource
resource_type This property is required. str
The standard Azure resource type of the bound resource
updated_at This property is required. str
Update time of the Binding resource
binding_parameters Mapping[str, Any]
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 This property is required. String
Creation time of the Binding resource
generatedProperties This property is required. String
The generated Spring Boot property file for this binding. The secret will be deducted.
resourceName This property is required. String
The name of the bound resource
resourceType This property is required. String
The standard Azure resource type of the bound resource
updatedAt This property is required. String
Update time of the Binding resource
bindingParameters Map<Any>
Binding parameters of the Binding resource
key String
The key of the bound resource
resourceId String
The Azure resource id of the bound 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/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding 
Copy

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