@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.85 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 CommunicationsGateway resource
*
* Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2023-04-03.
*
* Other available API versions: 2022-12-01-preview, 2023-01-31, 2023-04-03. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native voiceservices [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class CommunicationsGateway extends pulumi.CustomResource {
/**
* Get an existing CommunicationsGateway 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): CommunicationsGateway;
/**
* Returns true if the given object is an instance of CommunicationsGateway. 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 CommunicationsGateway;
/**
* A list of allocated IP prefixes which may be used to receive media data from this Communications Gateway.
*/
readonly allocatedMediaAddressPrefixes: pulumi.Output<string[]>;
/**
* A list of IP allocated prefixes which may be used to receive signaling data from this Communications Gateway.
*/
readonly allocatedSignalingAddressPrefixes: pulumi.Output<string[]>;
/**
* Details of API bridge functionality, if required
*/
readonly apiBridge: pulumi.Output<outputs.voiceservices.ApiBridgePropertiesResponse | undefined>;
/**
* The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
*/
readonly autoGeneratedDomainNameLabel: pulumi.Output<string>;
/**
* The scope at which the auto-generated domain name can be re-used
*/
readonly autoGeneratedDomainNameLabelScope: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Voice codecs to support
*/
readonly codecs: pulumi.Output<string[]>;
/**
* How to connect back to the operator network, e.g. MAPS
*/
readonly connectivity: pulumi.Output<string>;
/**
* Custom SIP Header to add to any subscriber with a custom_header value, if required.
*/
readonly customSipHeaders: pulumi.Output<outputs.voiceservices.CustomSipHeadersPropertiesResponse | undefined>;
/**
* Details of DNS Domains to delegate to the Communications Gateway.
*/
readonly dnsDelegations: pulumi.Output<outputs.voiceservices.DnsDelegationsPropertiesResponse | undefined>;
/**
* How to handle 911 calls
*/
readonly e911Type: pulumi.Output<string>;
/**
* A list of dial strings used for emergency calling.
*/
readonly emergencyDialStrings: pulumi.Output<string[] | undefined>;
/**
* The managed service identities assigned to this resource.
*/
readonly identity: pulumi.Output<outputs.voiceservices.ManagedServiceIdentityResponse | undefined>;
/**
* Whether an integrated Mobile Control Point is in use.
*/
readonly integratedMcpEnabled: pulumi.Output<boolean | undefined>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Whether an on-premises Mobile Control Point is in use.
*/
readonly onPremMcpEnabled: pulumi.Output<boolean | undefined>;
/**
* What platforms to support
*/
readonly platforms: pulumi.Output<string[]>;
/**
* Resource provisioning state.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The regions in which to deploy the resources needed for Teams Calling
*/
readonly serviceLocations: pulumi.Output<outputs.voiceservices.ServiceRegionPropertiesResponse[]>;
/**
* The SKU (Stock Keeping Unit) assigned to this resource.
*/
readonly sku: pulumi.Output<outputs.voiceservices.SkuResponse | undefined>;
/**
* The current status of the deployment.
*/
readonly status: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.voiceservices.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
*/
readonly teamsVoicemailPilotNumber: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a CommunicationsGateway 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: CommunicationsGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a CommunicationsGateway resource.
*/
export interface CommunicationsGatewayArgs {
/**
* Details of API bridge functionality, if required
*/
apiBridge?: pulumi.Input<inputs.voiceservices.ApiBridgePropertiesArgs>;
/**
* The scope at which the auto-generated domain name can be re-used
*/
autoGeneratedDomainNameLabelScope?: pulumi.Input<string | enums.voiceservices.AutoGeneratedDomainNameLabelScope>;
/**
* Voice codecs to support
*/
codecs: pulumi.Input<pulumi.Input<string | enums.voiceservices.TeamsCodecs>[]>;
/**
* Unique identifier for this deployment
*/
communicationsGatewayName?: pulumi.Input<string>;
/**
* How to connect back to the operator network, e.g. MAPS
*/
connectivity: pulumi.Input<string | enums.voiceservices.Connectivity>;
/**
* Custom SIP Header to add to any subscriber with a custom_header value, if required.
*/
customSipHeaders?: pulumi.Input<inputs.voiceservices.CustomSipHeadersPropertiesArgs>;
/**
* Details of DNS Domains to delegate to the Communications Gateway.
*/
dnsDelegations?: pulumi.Input<inputs.voiceservices.DnsDelegationsPropertiesArgs>;
/**
* How to handle 911 calls
*/
e911Type: pulumi.Input<string | enums.voiceservices.E911Type>;
/**
* A list of dial strings used for emergency calling.
*/
emergencyDialStrings?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The managed service identities assigned to this resource.
*/
identity?: pulumi.Input<inputs.voiceservices.ManagedServiceIdentityArgs>;
/**
* Whether an integrated Mobile Control Point is in use.
*/
integratedMcpEnabled?: pulumi.Input<boolean>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* Whether an on-premises Mobile Control Point is in use.
*/
onPremMcpEnabled?: pulumi.Input<boolean>;
/**
* What platforms to support
*/
platforms: pulumi.Input<pulumi.Input<string | enums.voiceservices.CommunicationsPlatform>[]>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The regions in which to deploy the resources needed for Teams Calling
*/
serviceLocations: pulumi.Input<pulumi.Input<inputs.voiceservices.ServiceRegionPropertiesArgs>[]>;
/**
* The SKU (Stock Keeping Unit) assigned to this resource.
*/
sku?: pulumi.Input<inputs.voiceservices.SkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
*/
teamsVoicemailPilotNumber?: pulumi.Input<string>;
}