Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. programmableconnectivity
  5. OperatorApiConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.programmableconnectivity.OperatorApiConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A Programmable Connectivity Operator API Connection resource

Uses Azure REST API version 2024-01-15-preview. In version 2.x of the Azure Native provider, it used API version 2024-01-15-preview.

Example Usage

OperatorApiConnections_Create

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

return await Deployment.RunAsync(() => 
{
    var operatorApiConnection = new AzureNative.ProgrammableConnectivity.OperatorApiConnection("operatorApiConnection", new()
    {
        AccountType = AzureNative.ProgrammableConnectivity.AccountType.AzureManaged,
        AppId = "czgrhbvgr",
        AppSecret = "wtxnpes",
        ConfiguredApplication = new AzureNative.ProgrammableConnectivity.Inputs.ApplicationPropertiesArgs
        {
            ApplicationDescription = "gjlwegnqvffvsc",
            ApplicationType = "f",
            LegalName = "ar",
            Name = "idzqqen",
            OrganizationDescription = "fcueqzlxxr",
            PrivacyContactEmailAddress = "l",
            TaxNumber = "ngzv",
        },
        GatewayId = "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/example-rg/providers/Microsoft.ProgrammableConnectivity/gateways/cdvcixxcdhjqw",
        Location = "dwvzfkjoepbmksygazllqryyinn",
        OperatorApiConnectionName = "nzsdg",
        OperatorApiPlanId = "/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/livmzrh",
        ResourceGroupName = "rgopenapi",
        SaasProperties = new AzureNative.ProgrammableConnectivity.Inputs.SaasPropertiesArgs
        {
            SaasResourceId = "pekejefyvfviabimdrmno",
            SaasSubscriptionId = "mgyusmqt",
        },
        Tags = 
        {
            { "key5536", "bjhvpzsmtalqxmjjbsfdizhg" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := programmableconnectivity.NewOperatorApiConnection(ctx, "operatorApiConnection", &programmableconnectivity.OperatorApiConnectionArgs{
			AccountType: pulumi.String(programmableconnectivity.AccountTypeAzureManaged),
			AppId:       pulumi.String("czgrhbvgr"),
			AppSecret:   pulumi.String("wtxnpes"),
			ConfiguredApplication: &programmableconnectivity.ApplicationPropertiesArgs{
				ApplicationDescription:     pulumi.String("gjlwegnqvffvsc"),
				ApplicationType:            pulumi.String("f"),
				LegalName:                  pulumi.String("ar"),
				Name:                       pulumi.String("idzqqen"),
				OrganizationDescription:    pulumi.String("fcueqzlxxr"),
				PrivacyContactEmailAddress: pulumi.String("l"),
				TaxNumber:                  pulumi.String("ngzv"),
			},
			GatewayId:                 pulumi.String("/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/example-rg/providers/Microsoft.ProgrammableConnectivity/gateways/cdvcixxcdhjqw"),
			Location:                  pulumi.String("dwvzfkjoepbmksygazllqryyinn"),
			OperatorApiConnectionName: pulumi.String("nzsdg"),
			OperatorApiPlanId:         pulumi.String("/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/livmzrh"),
			ResourceGroupName:         pulumi.String("rgopenapi"),
			SaasProperties: &programmableconnectivity.SaasPropertiesArgs{
				SaasResourceId:     pulumi.String("pekejefyvfviabimdrmno"),
				SaasSubscriptionId: pulumi.String("mgyusmqt"),
			},
			Tags: pulumi.StringMap{
				"key5536": pulumi.String("bjhvpzsmtalqxmjjbsfdizhg"),
			},
		})
		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.programmableconnectivity.OperatorApiConnection;
import com.pulumi.azurenative.programmableconnectivity.OperatorApiConnectionArgs;
import com.pulumi.azurenative.programmableconnectivity.inputs.ApplicationPropertiesArgs;
import com.pulumi.azurenative.programmableconnectivity.inputs.SaasPropertiesArgs;
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 operatorApiConnection = new OperatorApiConnection("operatorApiConnection", OperatorApiConnectionArgs.builder()
            .accountType("AzureManaged")
            .appId("czgrhbvgr")
            .appSecret("wtxnpes")
            .configuredApplication(ApplicationPropertiesArgs.builder()
                .applicationDescription("gjlwegnqvffvsc")
                .applicationType("f")
                .legalName("ar")
                .name("idzqqen")
                .organizationDescription("fcueqzlxxr")
                .privacyContactEmailAddress("l")
                .taxNumber("ngzv")
                .build())
            .gatewayId("/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/example-rg/providers/Microsoft.ProgrammableConnectivity/gateways/cdvcixxcdhjqw")
            .location("dwvzfkjoepbmksygazllqryyinn")
            .operatorApiConnectionName("nzsdg")
            .operatorApiPlanId("/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/livmzrh")
            .resourceGroupName("rgopenapi")
            .saasProperties(SaasPropertiesArgs.builder()
                .saasResourceId("pekejefyvfviabimdrmno")
                .saasSubscriptionId("mgyusmqt")
                .build())
            .tags(Map.of("key5536", "bjhvpzsmtalqxmjjbsfdizhg"))
            .build());

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

const operatorApiConnection = new azure_native.programmableconnectivity.OperatorApiConnection("operatorApiConnection", {
    accountType: azure_native.programmableconnectivity.AccountType.AzureManaged,
    appId: "czgrhbvgr",
    appSecret: "wtxnpes",
    configuredApplication: {
        applicationDescription: "gjlwegnqvffvsc",
        applicationType: "f",
        legalName: "ar",
        name: "idzqqen",
        organizationDescription: "fcueqzlxxr",
        privacyContactEmailAddress: "l",
        taxNumber: "ngzv",
    },
    gatewayId: "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/example-rg/providers/Microsoft.ProgrammableConnectivity/gateways/cdvcixxcdhjqw",
    location: "dwvzfkjoepbmksygazllqryyinn",
    operatorApiConnectionName: "nzsdg",
    operatorApiPlanId: "/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/livmzrh",
    resourceGroupName: "rgopenapi",
    saasProperties: {
        saasResourceId: "pekejefyvfviabimdrmno",
        saasSubscriptionId: "mgyusmqt",
    },
    tags: {
        key5536: "bjhvpzsmtalqxmjjbsfdizhg",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

operator_api_connection = azure_native.programmableconnectivity.OperatorApiConnection("operatorApiConnection",
    account_type=azure_native.programmableconnectivity.AccountType.AZURE_MANAGED,
    app_id="czgrhbvgr",
    app_secret="wtxnpes",
    configured_application={
        "application_description": "gjlwegnqvffvsc",
        "application_type": "f",
        "legal_name": "ar",
        "name": "idzqqen",
        "organization_description": "fcueqzlxxr",
        "privacy_contact_email_address": "l",
        "tax_number": "ngzv",
    },
    gateway_id="/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/example-rg/providers/Microsoft.ProgrammableConnectivity/gateways/cdvcixxcdhjqw",
    location="dwvzfkjoepbmksygazllqryyinn",
    operator_api_connection_name="nzsdg",
    operator_api_plan_id="/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/livmzrh",
    resource_group_name="rgopenapi",
    saas_properties={
        "saas_resource_id": "pekejefyvfviabimdrmno",
        "saas_subscription_id": "mgyusmqt",
    },
    tags={
        "key5536": "bjhvpzsmtalqxmjjbsfdizhg",
    })
Copy
resources:
  operatorApiConnection:
    type: azure-native:programmableconnectivity:OperatorApiConnection
    properties:
      accountType: AzureManaged
      appId: czgrhbvgr
      appSecret: wtxnpes
      configuredApplication:
        applicationDescription: gjlwegnqvffvsc
        applicationType: f
        legalName: ar
        name: idzqqen
        organizationDescription: fcueqzlxxr
        privacyContactEmailAddress: l
        taxNumber: ngzv
      gatewayId: /subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/example-rg/providers/Microsoft.ProgrammableConnectivity/gateways/cdvcixxcdhjqw
      location: dwvzfkjoepbmksygazllqryyinn
      operatorApiConnectionName: nzsdg
      operatorApiPlanId: /subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/livmzrh
      resourceGroupName: rgopenapi
      saasProperties:
        saasResourceId: pekejefyvfviabimdrmno
        saasSubscriptionId: mgyusmqt
      tags:
        key5536: bjhvpzsmtalqxmjjbsfdizhg
Copy

Create OperatorApiConnection Resource

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

Constructor syntax

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

@overload
def OperatorApiConnection(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          account_type: Optional[Union[str, AccountType]] = None,
                          gateway_id: Optional[str] = None,
                          operator_api_plan_id: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          app_id: Optional[str] = None,
                          app_secret: Optional[str] = None,
                          configured_application: Optional[ApplicationPropertiesArgs] = None,
                          location: Optional[str] = None,
                          operator_api_connection_name: Optional[str] = None,
                          saas_properties: Optional[SaasPropertiesArgs] = None,
                          tags: Optional[Mapping[str, str]] = None)
func NewOperatorApiConnection(ctx *Context, name string, args OperatorApiConnectionArgs, opts ...ResourceOption) (*OperatorApiConnection, error)
public OperatorApiConnection(string name, OperatorApiConnectionArgs args, CustomResourceOptions? opts = null)
public OperatorApiConnection(String name, OperatorApiConnectionArgs args)
public OperatorApiConnection(String name, OperatorApiConnectionArgs args, CustomResourceOptions options)

type: azure-native:programmableconnectivity:OperatorApiConnection
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. OperatorApiConnectionArgs
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. OperatorApiConnectionArgs
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. OperatorApiConnectionArgs
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. OperatorApiConnectionArgs
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. OperatorApiConnectionArgs
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 operatorApiConnectionResource = new AzureNative.ProgrammableConnectivity.OperatorApiConnection("operatorApiConnectionResource", new()
{
    AccountType = "string",
    GatewayId = "string",
    OperatorApiPlanId = "string",
    ResourceGroupName = "string",
    AppId = "string",
    AppSecret = "string",
    ConfiguredApplication = new AzureNative.ProgrammableConnectivity.Inputs.ApplicationPropertiesArgs
    {
        ApplicationDescription = "string",
        ApplicationType = "string",
        LegalName = "string",
        Name = "string",
        OrganizationDescription = "string",
        PrivacyContactEmailAddress = "string",
        TaxNumber = "string",
    },
    Location = "string",
    OperatorApiConnectionName = "string",
    SaasProperties = new AzureNative.ProgrammableConnectivity.Inputs.SaasPropertiesArgs
    {
        SaasResourceId = "string",
        SaasSubscriptionId = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := programmableconnectivity.NewOperatorApiConnection(ctx, "operatorApiConnectionResource", &programmableconnectivity.OperatorApiConnectionArgs{
	AccountType:       pulumi.String("string"),
	GatewayId:         pulumi.String("string"),
	OperatorApiPlanId: pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	AppId:             pulumi.String("string"),
	AppSecret:         pulumi.String("string"),
	ConfiguredApplication: &programmableconnectivity.ApplicationPropertiesArgs{
		ApplicationDescription:     pulumi.String("string"),
		ApplicationType:            pulumi.String("string"),
		LegalName:                  pulumi.String("string"),
		Name:                       pulumi.String("string"),
		OrganizationDescription:    pulumi.String("string"),
		PrivacyContactEmailAddress: pulumi.String("string"),
		TaxNumber:                  pulumi.String("string"),
	},
	Location:                  pulumi.String("string"),
	OperatorApiConnectionName: pulumi.String("string"),
	SaasProperties: &programmableconnectivity.SaasPropertiesArgs{
		SaasResourceId:     pulumi.String("string"),
		SaasSubscriptionId: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var operatorApiConnectionResource = new OperatorApiConnection("operatorApiConnectionResource", OperatorApiConnectionArgs.builder()
    .accountType("string")
    .gatewayId("string")
    .operatorApiPlanId("string")
    .resourceGroupName("string")
    .appId("string")
    .appSecret("string")
    .configuredApplication(ApplicationPropertiesArgs.builder()
        .applicationDescription("string")
        .applicationType("string")
        .legalName("string")
        .name("string")
        .organizationDescription("string")
        .privacyContactEmailAddress("string")
        .taxNumber("string")
        .build())
    .location("string")
    .operatorApiConnectionName("string")
    .saasProperties(SaasPropertiesArgs.builder()
        .saasResourceId("string")
        .saasSubscriptionId("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
operator_api_connection_resource = azure_native.programmableconnectivity.OperatorApiConnection("operatorApiConnectionResource",
    account_type="string",
    gateway_id="string",
    operator_api_plan_id="string",
    resource_group_name="string",
    app_id="string",
    app_secret="string",
    configured_application={
        "application_description": "string",
        "application_type": "string",
        "legal_name": "string",
        "name": "string",
        "organization_description": "string",
        "privacy_contact_email_address": "string",
        "tax_number": "string",
    },
    location="string",
    operator_api_connection_name="string",
    saas_properties={
        "saas_resource_id": "string",
        "saas_subscription_id": "string",
    },
    tags={
        "string": "string",
    })
Copy
const operatorApiConnectionResource = new azure_native.programmableconnectivity.OperatorApiConnection("operatorApiConnectionResource", {
    accountType: "string",
    gatewayId: "string",
    operatorApiPlanId: "string",
    resourceGroupName: "string",
    appId: "string",
    appSecret: "string",
    configuredApplication: {
        applicationDescription: "string",
        applicationType: "string",
        legalName: "string",
        name: "string",
        organizationDescription: "string",
        privacyContactEmailAddress: "string",
        taxNumber: "string",
    },
    location: "string",
    operatorApiConnectionName: "string",
    saasProperties: {
        saasResourceId: "string",
        saasSubscriptionId: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:programmableconnectivity:OperatorApiConnection
properties:
    accountType: string
    appId: string
    appSecret: string
    configuredApplication:
        applicationDescription: string
        applicationType: string
        legalName: string
        name: string
        organizationDescription: string
        privacyContactEmailAddress: string
        taxNumber: string
    gatewayId: string
    location: string
    operatorApiConnectionName: string
    operatorApiPlanId: string
    resourceGroupName: string
    saasProperties:
        saasResourceId: string
        saasSubscriptionId: string
    tags:
        string: string
Copy

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

AccountType
This property is required.
Changes to this property will trigger replacement.
string | Pulumi.AzureNative.ProgrammableConnectivity.AccountType
Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
Reference to the APC Gateway resource ID.
OperatorApiPlanId This property is required. string
Reference to the Operator API Plan Resource ID.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AppId string
Application ID of the App Developer that is registered with the Operator in a specific country/region.
AppSecret string
Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
ConfiguredApplication Pulumi.AzureNative.ProgrammableConnectivity.Inputs.ApplicationProperties
Details about the Application that would use the Operator's Network APIs.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
OperatorApiConnectionName Changes to this property will trigger replacement. string
Azure Programmable Connectivity (APC) Operator API Connection Name.
SaasProperties Pulumi.AzureNative.ProgrammableConnectivity.Inputs.SaasProperties
Details about the SaaS offer purchased from the marketplace.
Tags Dictionary<string, string>
Resource tags.
AccountType
This property is required.
Changes to this property will trigger replacement.
string | AccountType
Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
Reference to the APC Gateway resource ID.
OperatorApiPlanId This property is required. string
Reference to the Operator API Plan Resource ID.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AppId string
Application ID of the App Developer that is registered with the Operator in a specific country/region.
AppSecret string
Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
ConfiguredApplication ApplicationPropertiesArgs
Details about the Application that would use the Operator's Network APIs.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
OperatorApiConnectionName Changes to this property will trigger replacement. string
Azure Programmable Connectivity (APC) Operator API Connection Name.
SaasProperties SaasPropertiesArgs
Details about the SaaS offer purchased from the marketplace.
Tags map[string]string
Resource tags.
accountType
This property is required.
Changes to this property will trigger replacement.
String | AccountType
Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
Reference to the APC Gateway resource ID.
operatorApiPlanId This property is required. String
Reference to the Operator API Plan Resource ID.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
appId String
Application ID of the App Developer that is registered with the Operator in a specific country/region.
appSecret String
Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
configuredApplication ApplicationProperties
Details about the Application that would use the Operator's Network APIs.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
operatorApiConnectionName Changes to this property will trigger replacement. String
Azure Programmable Connectivity (APC) Operator API Connection Name.
saasProperties SaasProperties
Details about the SaaS offer purchased from the marketplace.
tags Map<String,String>
Resource tags.
accountType
This property is required.
Changes to this property will trigger replacement.
string | AccountType
Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
gatewayId
This property is required.
Changes to this property will trigger replacement.
string
Reference to the APC Gateway resource ID.
operatorApiPlanId This property is required. string
Reference to the Operator API Plan Resource ID.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
appId string
Application ID of the App Developer that is registered with the Operator in a specific country/region.
appSecret string
Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
configuredApplication ApplicationProperties
Details about the Application that would use the Operator's Network APIs.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
operatorApiConnectionName Changes to this property will trigger replacement. string
Azure Programmable Connectivity (APC) Operator API Connection Name.
saasProperties SaasProperties
Details about the SaaS offer purchased from the marketplace.
tags {[key: string]: string}
Resource tags.
account_type
This property is required.
Changes to this property will trigger replacement.
str | AccountType
Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
gateway_id
This property is required.
Changes to this property will trigger replacement.
str
Reference to the APC Gateway resource ID.
operator_api_plan_id This property is required. str
Reference to the Operator API Plan Resource ID.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
app_id str
Application ID of the App Developer that is registered with the Operator in a specific country/region.
app_secret str
Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
configured_application ApplicationPropertiesArgs
Details about the Application that would use the Operator's Network APIs.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
operator_api_connection_name Changes to this property will trigger replacement. str
Azure Programmable Connectivity (APC) Operator API Connection Name.
saas_properties SaasPropertiesArgs
Details about the SaaS offer purchased from the marketplace.
tags Mapping[str, str]
Resource tags.
accountType
This property is required.
Changes to this property will trigger replacement.
String | "AzureManaged" | "UserManaged"
Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
Reference to the APC Gateway resource ID.
operatorApiPlanId This property is required. String
Reference to the Operator API Plan Resource ID.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
appId String
Application ID of the App Developer that is registered with the Operator in a specific country/region.
appSecret String
Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
configuredApplication Property Map
Details about the Application that would use the Operator's Network APIs.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
operatorApiConnectionName Changes to this property will trigger replacement. String
Azure Programmable Connectivity (APC) Operator API Connection Name.
saasProperties Property Map
Details about the SaaS offer purchased from the marketplace.
tags Map<String>
Resource tags.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
CamaraApiName string
The Network API for the current operator in the country/region provided in the linked Operator API Plan.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
OperatorName string
Name of the Operator in the linked Operator API Plan belongs to.
ProvisioningState string
The status of the last operation.
Status Pulumi.AzureNative.ProgrammableConnectivity.Outputs.StatusResponse
The status of the OperatorApiConnection resource.
SystemData Pulumi.AzureNative.ProgrammableConnectivity.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
CamaraApiName string
The Network API for the current operator in the country/region provided in the linked Operator API Plan.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
OperatorName string
Name of the Operator in the linked Operator API Plan belongs to.
ProvisioningState string
The status of the last operation.
Status StatusResponse
The status of the OperatorApiConnection resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
camaraApiName String
The Network API for the current operator in the country/region provided in the linked Operator API Plan.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
operatorName String
Name of the Operator in the linked Operator API Plan belongs to.
provisioningState String
The status of the last operation.
status StatusResponse
The status of the OperatorApiConnection resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
camaraApiName string
The Network API for the current operator in the country/region provided in the linked Operator API Plan.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
operatorName string
Name of the Operator in the linked Operator API Plan belongs to.
provisioningState string
The status of the last operation.
status StatusResponse
The status of the OperatorApiConnection resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
camara_api_name str
The Network API for the current operator in the country/region provided in the linked Operator API Plan.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
operator_name str
Name of the Operator in the linked Operator API Plan belongs to.
provisioning_state str
The status of the last operation.
status StatusResponse
The status of the OperatorApiConnection resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
camaraApiName String
The Network API for the current operator in the country/region provided in the linked Operator API Plan.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
operatorName String
Name of the Operator in the linked Operator API Plan belongs to.
provisioningState String
The status of the last operation.
status Property Map
The status of the OperatorApiConnection resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

AccountType
, AccountTypeArgs

AzureManaged
AzureManagedManaged by Azure on-behalf-of the user.
UserManaged
UserManagedManaged by the User themselves on the Operator end.
AccountTypeAzureManaged
AzureManagedManaged by Azure on-behalf-of the user.
AccountTypeUserManaged
UserManagedManaged by the User themselves on the Operator end.
AzureManaged
AzureManagedManaged by Azure on-behalf-of the user.
UserManaged
UserManagedManaged by the User themselves on the Operator end.
AzureManaged
AzureManagedManaged by Azure on-behalf-of the user.
UserManaged
UserManagedManaged by the User themselves on the Operator end.
AZURE_MANAGED
AzureManagedManaged by Azure on-behalf-of the user.
USER_MANAGED
UserManagedManaged by the User themselves on the Operator end.
"AzureManaged"
AzureManagedManaged by Azure on-behalf-of the user.
"UserManaged"
UserManagedManaged by the User themselves on the Operator end.

ApplicationProperties
, ApplicationPropertiesArgs

ApplicationDescription string
Description of the application.
ApplicationType string
The category that describes the application.
LegalName string
Legal name of the organization owning the application.
Name string
Name of the application. Example: Contoso App.
OrganizationDescription string
A description of the organization owning the application.
PrivacyContactEmailAddress string
Email address of the Privacy contact or Data Protection officer of the organization.
TaxNumber string
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
ApplicationDescription string
Description of the application.
ApplicationType string
The category that describes the application.
LegalName string
Legal name of the organization owning the application.
Name string
Name of the application. Example: Contoso App.
OrganizationDescription string
A description of the organization owning the application.
PrivacyContactEmailAddress string
Email address of the Privacy contact or Data Protection officer of the organization.
TaxNumber string
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
applicationDescription String
Description of the application.
applicationType String
The category that describes the application.
legalName String
Legal name of the organization owning the application.
name String
Name of the application. Example: Contoso App.
organizationDescription String
A description of the organization owning the application.
privacyContactEmailAddress String
Email address of the Privacy contact or Data Protection officer of the organization.
taxNumber String
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
applicationDescription string
Description of the application.
applicationType string
The category that describes the application.
legalName string
Legal name of the organization owning the application.
name string
Name of the application. Example: Contoso App.
organizationDescription string
A description of the organization owning the application.
privacyContactEmailAddress string
Email address of the Privacy contact or Data Protection officer of the organization.
taxNumber string
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
application_description str
Description of the application.
application_type str
The category that describes the application.
legal_name str
Legal name of the organization owning the application.
name str
Name of the application. Example: Contoso App.
organization_description str
A description of the organization owning the application.
privacy_contact_email_address str
Email address of the Privacy contact or Data Protection officer of the organization.
tax_number str
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
applicationDescription String
Description of the application.
applicationType String
The category that describes the application.
legalName String
Legal name of the organization owning the application.
name String
Name of the application. Example: Contoso App.
organizationDescription String
A description of the organization owning the application.
privacyContactEmailAddress String
Email address of the Privacy contact or Data Protection officer of the organization.
taxNumber String
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.

ApplicationPropertiesResponse
, ApplicationPropertiesResponseArgs

ApplicationDescription string
Description of the application.
ApplicationType string
The category that describes the application.
LegalName string
Legal name of the organization owning the application.
Name string
Name of the application. Example: Contoso App.
OrganizationDescription string
A description of the organization owning the application.
PrivacyContactEmailAddress string
Email address of the Privacy contact or Data Protection officer of the organization.
TaxNumber string
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
ApplicationDescription string
Description of the application.
ApplicationType string
The category that describes the application.
LegalName string
Legal name of the organization owning the application.
Name string
Name of the application. Example: Contoso App.
OrganizationDescription string
A description of the organization owning the application.
PrivacyContactEmailAddress string
Email address of the Privacy contact or Data Protection officer of the organization.
TaxNumber string
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
applicationDescription String
Description of the application.
applicationType String
The category that describes the application.
legalName String
Legal name of the organization owning the application.
name String
Name of the application. Example: Contoso App.
organizationDescription String
A description of the organization owning the application.
privacyContactEmailAddress String
Email address of the Privacy contact or Data Protection officer of the organization.
taxNumber String
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
applicationDescription string
Description of the application.
applicationType string
The category that describes the application.
legalName string
Legal name of the organization owning the application.
name string
Name of the application. Example: Contoso App.
organizationDescription string
A description of the organization owning the application.
privacyContactEmailAddress string
Email address of the Privacy contact or Data Protection officer of the organization.
taxNumber string
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
application_description str
Description of the application.
application_type str
The category that describes the application.
legal_name str
Legal name of the organization owning the application.
name str
Name of the application. Example: Contoso App.
organization_description str
A description of the organization owning the application.
privacy_contact_email_address str
Email address of the Privacy contact or Data Protection officer of the organization.
tax_number str
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
applicationDescription String
Description of the application.
applicationType String
The category that describes the application.
legalName String
Legal name of the organization owning the application.
name String
Name of the application. Example: Contoso App.
organizationDescription String
A description of the organization owning the application.
privacyContactEmailAddress String
Email address of the Privacy contact or Data Protection officer of the organization.
taxNumber String
Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.

SaasProperties
, SaasPropertiesArgs

SaasResourceId string
Resource ID of the SaaS offer purchased from the marketplace.
SaasSubscriptionId string
Subscription ID of the SaaS offer purchased from the marketplace.
SaasResourceId string
Resource ID of the SaaS offer purchased from the marketplace.
SaasSubscriptionId string
Subscription ID of the SaaS offer purchased from the marketplace.
saasResourceId String
Resource ID of the SaaS offer purchased from the marketplace.
saasSubscriptionId String
Subscription ID of the SaaS offer purchased from the marketplace.
saasResourceId string
Resource ID of the SaaS offer purchased from the marketplace.
saasSubscriptionId string
Subscription ID of the SaaS offer purchased from the marketplace.
saas_resource_id str
Resource ID of the SaaS offer purchased from the marketplace.
saas_subscription_id str
Subscription ID of the SaaS offer purchased from the marketplace.
saasResourceId String
Resource ID of the SaaS offer purchased from the marketplace.
saasSubscriptionId String
Subscription ID of the SaaS offer purchased from the marketplace.

SaasPropertiesResponse
, SaasPropertiesResponseArgs

SaasResourceId string
Resource ID of the SaaS offer purchased from the marketplace.
SaasSubscriptionId string
Subscription ID of the SaaS offer purchased from the marketplace.
SaasResourceId string
Resource ID of the SaaS offer purchased from the marketplace.
SaasSubscriptionId string
Subscription ID of the SaaS offer purchased from the marketplace.
saasResourceId String
Resource ID of the SaaS offer purchased from the marketplace.
saasSubscriptionId String
Subscription ID of the SaaS offer purchased from the marketplace.
saasResourceId string
Resource ID of the SaaS offer purchased from the marketplace.
saasSubscriptionId string
Subscription ID of the SaaS offer purchased from the marketplace.
saas_resource_id str
Resource ID of the SaaS offer purchased from the marketplace.
saas_subscription_id str
Subscription ID of the SaaS offer purchased from the marketplace.
saasResourceId String
Resource ID of the SaaS offer purchased from the marketplace.
saasSubscriptionId String
Subscription ID of the SaaS offer purchased from the marketplace.

StatusResponse
, StatusResponseArgs

Reason string
Explanation of the current state of the OperatorApiConnection resource.
State string
Current state of the OperatorApiConnection resource.
Reason string
Explanation of the current state of the OperatorApiConnection resource.
State string
Current state of the OperatorApiConnection resource.
reason String
Explanation of the current state of the OperatorApiConnection resource.
state String
Current state of the OperatorApiConnection resource.
reason string
Explanation of the current state of the OperatorApiConnection resource.
state string
Current state of the OperatorApiConnection resource.
reason str
Explanation of the current state of the OperatorApiConnection resource.
state str
Current state of the OperatorApiConnection resource.
reason String
Explanation of the current state of the OperatorApiConnection resource.
state String
Current state of the OperatorApiConnection 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 last 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 last 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 last 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 last 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 last 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 last 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:programmableconnectivity:OperatorApiConnection zsilgtpflhroamaglfbywbn /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/operatorApiConnections/{operatorApiConnectionName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native