@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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.
*
* Other available API versions: 2025-03-30-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native programmableconnectivity [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class OperatorApiConnection extends pulumi.CustomResource {
/**
* Get an existing OperatorApiConnection resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): OperatorApiConnection;
/**
* Returns true if the given object is an instance of OperatorApiConnection. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is OperatorApiConnection;
/**
* Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
*/
readonly accountType: pulumi.Output<string>;
/**
* Application ID of the App Developer that is registered with the Operator in a specific country/region.
*/
readonly appId: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The Network API for the current operator in the country/region provided in the linked Operator API Plan.
*/
readonly camaraApiName: pulumi.Output<string>;
/**
* Details about the Application that would use the Operator's Network APIs.
*/
readonly configuredApplication: pulumi.Output<outputs.programmableconnectivity.ApplicationPropertiesResponse | undefined>;
/**
* Reference to the APC Gateway resource ID.
*/
readonly gatewayId: pulumi.Output<string>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Reference to the Operator API Plan Resource ID.
*/
readonly operatorApiPlanId: pulumi.Output<string>;
/**
* Name of the Operator in the linked Operator API Plan belongs to.
*/
readonly operatorName: pulumi.Output<string>;
/**
* The status of the last operation.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Details about the SaaS offer purchased from the marketplace.
*/
readonly saasProperties: pulumi.Output<outputs.programmableconnectivity.SaasPropertiesResponse | undefined>;
/**
* The status of the OperatorApiConnection resource.
*/
readonly status: pulumi.Output<outputs.programmableconnectivity.StatusResponse>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.programmableconnectivity.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a OperatorApiConnection resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: OperatorApiConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a OperatorApiConnection resource.
*/
export interface OperatorApiConnectionArgs {
/**
* Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
*/
accountType: pulumi.Input<string | enums.programmableconnectivity.AccountType>;
/**
* Application ID of the App Developer that is registered with the Operator in a specific country/region.
*/
appId?: pulumi.Input<string>;
/**
* Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read.
*/
appSecret?: pulumi.Input<string>;
/**
* Details about the Application that would use the Operator's Network APIs.
*/
configuredApplication?: pulumi.Input<inputs.programmableconnectivity.ApplicationPropertiesArgs>;
/**
* Reference to the APC Gateway resource ID.
*/
gatewayId: pulumi.Input<string>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* Azure Programmable Connectivity (APC) Operator API Connection Name.
*/
operatorApiConnectionName?: pulumi.Input<string>;
/**
* Reference to the Operator API Plan Resource ID.
*/
operatorApiPlanId: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Details about the SaaS offer purchased from the marketplace.
*/
saasProperties?: pulumi.Input<inputs.programmableconnectivity.SaasPropertiesArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}