CommunicationsGateway

class CommunicationsGateway : KotlinCustomResource

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/#accessing-any-api-version-via-local-packages for details.

Example Usage

CreateCommunicationsGatewayResource

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var communicationsGateway = new AzureNative.VoiceServices.CommunicationsGateway("communicationsGateway", new()
{
ApiBridge = new AzureNative.VoiceServices.Inputs.ApiBridgePropertiesArgs
{
AllowedAddressPrefixes = new[]
{
"198.51.100.192/26",
},
ConfigureApiBridge = AzureNative.VoiceServices.ApiBridgeActivationState.Enabled,
},
AutoGeneratedDomainNameLabelScope = AzureNative.VoiceServices.AutoGeneratedDomainNameLabelScope.NoReuse,
Codecs = new[]
{
AzureNative.VoiceServices.TeamsCodecs.PCMA,
},
CommunicationsGatewayName = "myname",
Connectivity = AzureNative.VoiceServices.Connectivity.PublicAddress,
CustomSipHeaders = new AzureNative.VoiceServices.Inputs.CustomSipHeadersPropertiesArgs
{
Headers = new[]
{
new AzureNative.VoiceServices.Inputs.CustomSipHeaderArgs
{
Name = "x-contoso-commsgw-identifier",
},
},
},
DnsDelegations = new AzureNative.VoiceServices.Inputs.DnsDelegationsPropertiesArgs
{
Delegations = new[]
{
new AzureNative.VoiceServices.Inputs.DnsDelegationPropertiesArgs
{
Domain = "commsgw.contoso.com",
},
},
},
E911Type = AzureNative.VoiceServices.E911Type.Standard,
Location = "useast",
Platforms = new[]
{
AzureNative.VoiceServices.CommunicationsPlatform.OperatorConnect,
AzureNative.VoiceServices.CommunicationsPlatform.TeamsDirectRouting,
},
ResourceGroupName = "testrg",
ServiceLocations = new[]
{
new AzureNative.VoiceServices.Inputs.ServiceRegionPropertiesArgs
{
Name = "useast",
PrimaryRegionProperties = new AzureNative.VoiceServices.Inputs.PrimaryRegionPropertiesArgs
{
AllowedMediaSourceAddressPrefixes = new[]
{
"10.1.2.0/24",
},
AllowedSignalingSourceAddressPrefixes = new[]
{
"10.1.1.0/24",
},
OperatorAddresses = new[]
{
"198.51.100.1",
},
},
},
new AzureNative.VoiceServices.Inputs.ServiceRegionPropertiesArgs
{
Name = "useast2",
PrimaryRegionProperties = new AzureNative.VoiceServices.Inputs.PrimaryRegionPropertiesArgs
{
AllowedMediaSourceAddressPrefixes = new[]
{
"10.2.2.0/24",
},
AllowedSignalingSourceAddressPrefixes = new[]
{
"10.2.1.0/24",
},
OperatorAddresses = new[]
{
"198.51.100.2",
},
},
},
},
Sku = new AzureNative.VoiceServices.Inputs.SkuArgs
{
Name = "standard",
},
TeamsVoicemailPilotNumber = "1234567890",
});
});
package main
import (
voiceservices "github.com/pulumi/pulumi-azure-native-sdk/voiceservices/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := voiceservices.NewCommunicationsGateway(ctx, "communicationsGateway", &voiceservices.CommunicationsGatewayArgs{
ApiBridge: &voiceservices.ApiBridgePropertiesArgs{
AllowedAddressPrefixes: pulumi.StringArray{
pulumi.String("198.51.100.192/26"),
},
ConfigureApiBridge: pulumi.String(voiceservices.ApiBridgeActivationStateEnabled),
},
AutoGeneratedDomainNameLabelScope: pulumi.String(voiceservices.AutoGeneratedDomainNameLabelScopeNoReuse),
Codecs: pulumi.StringArray{
pulumi.String(voiceservices.TeamsCodecsPCMA),
},
CommunicationsGatewayName: pulumi.String("myname"),
Connectivity: pulumi.String(voiceservices.ConnectivityPublicAddress),
CustomSipHeaders: &voiceservices.CustomSipHeadersPropertiesArgs{
Headers: voiceservices.CustomSipHeaderArray{
&voiceservices.CustomSipHeaderArgs{
Name: pulumi.String("x-contoso-commsgw-identifier"),
},
},
},
DnsDelegations: &voiceservices.DnsDelegationsPropertiesArgs{
Delegations: voiceservices.DnsDelegationPropertiesArray{
&voiceservices.DnsDelegationPropertiesArgs{
Domain: pulumi.String("commsgw.contoso.com"),
},
},
},
E911Type: pulumi.String(voiceservices.E911TypeStandard),
Location: pulumi.String("useast"),
Platforms: pulumi.StringArray{
pulumi.String(voiceservices.CommunicationsPlatformOperatorConnect),
pulumi.String(voiceservices.CommunicationsPlatformTeamsDirectRouting),
},
ResourceGroupName: pulumi.String("testrg"),
ServiceLocations: voiceservices.ServiceRegionPropertiesArray{
&voiceservices.ServiceRegionPropertiesArgs{
Name: pulumi.String("useast"),
PrimaryRegionProperties: &voiceservices.PrimaryRegionPropertiesArgs{
AllowedMediaSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.1.2.0/24"),
},
AllowedSignalingSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.1.1.0/24"),
},
OperatorAddresses: pulumi.StringArray{
pulumi.String("198.51.100.1"),
},
},
},
&voiceservices.ServiceRegionPropertiesArgs{
Name: pulumi.String("useast2"),
PrimaryRegionProperties: &voiceservices.PrimaryRegionPropertiesArgs{
AllowedMediaSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.2.2.0/24"),
},
AllowedSignalingSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.2.1.0/24"),
},
OperatorAddresses: pulumi.StringArray{
pulumi.String("198.51.100.2"),
},
},
},
},
Sku: &voiceservices.SkuArgs{
Name: pulumi.String("standard"),
},
TeamsVoicemailPilotNumber: pulumi.String("1234567890"),
})
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.voiceservices.CommunicationsGateway;
import com.pulumi.azurenative.voiceservices.CommunicationsGatewayArgs;
import com.pulumi.azurenative.voiceservices.inputs.ApiBridgePropertiesArgs;
import com.pulumi.azurenative.voiceservices.inputs.CustomSipHeadersPropertiesArgs;
import com.pulumi.azurenative.voiceservices.inputs.DnsDelegationsPropertiesArgs;
import com.pulumi.azurenative.voiceservices.inputs.ServiceRegionPropertiesArgs;
import com.pulumi.azurenative.voiceservices.inputs.PrimaryRegionPropertiesArgs;
import com.pulumi.azurenative.voiceservices.inputs.SkuArgs;
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 communicationsGateway = new CommunicationsGateway("communicationsGateway", CommunicationsGatewayArgs.builder()
.apiBridge(ApiBridgePropertiesArgs.builder()
.allowedAddressPrefixes("198.51.100.192/26")
.configureApiBridge("enabled")
.build())
.autoGeneratedDomainNameLabelScope("NoReuse")
.codecs("PCMA")
.communicationsGatewayName("myname")
.connectivity("PublicAddress")
.customSipHeaders(CustomSipHeadersPropertiesArgs.builder()
.headers(CustomSipHeaderArgs.builder()
.name("x-contoso-commsgw-identifier")
.build())
.build())
.dnsDelegations(DnsDelegationsPropertiesArgs.builder()
.delegations(DnsDelegationPropertiesArgs.builder()
.domain("commsgw.contoso.com")
.build())
.build())
.e911Type("Standard")
.location("useast")
.platforms(
"OperatorConnect",
"TeamsDirectRouting")
.resourceGroupName("testrg")
.serviceLocations(
ServiceRegionPropertiesArgs.builder()
.name("useast")
.primaryRegionProperties(PrimaryRegionPropertiesArgs.builder()
.allowedMediaSourceAddressPrefixes("10.1.2.0/24")
.allowedSignalingSourceAddressPrefixes("10.1.1.0/24")
.operatorAddresses("198.51.100.1")
.build())
.build(),
ServiceRegionPropertiesArgs.builder()
.name("useast2")
.primaryRegionProperties(PrimaryRegionPropertiesArgs.builder()
.allowedMediaSourceAddressPrefixes("10.2.2.0/24")
.allowedSignalingSourceAddressPrefixes("10.2.1.0/24")
.operatorAddresses("198.51.100.2")
.build())
.build())
.sku(SkuArgs.builder()
.name("standard")
.build())
.teamsVoicemailPilotNumber("1234567890")
.build());
}
}

Import

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

$ pulumi import azure-native:voiceservices:CommunicationsGateway myname /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VoiceServices/communicationsGateways/{communicationsGatewayName}

Properties

Link copied to clipboard

A list of allocated IP prefixes which may be used to receive media data from this Communications Gateway.

Link copied to clipboard

A list of IP allocated prefixes which may be used to receive signaling data from this Communications Gateway.

Link copied to clipboard

Details of API bridge functionality, if required

Link copied to clipboard

The autogenerated label used as part of the FQDNs for accessing the Communications Gateway

Link copied to clipboard

The scope at which the auto-generated domain name can be re-used

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val codecs: Output<List<String>>

Voice codecs to support

Link copied to clipboard
val connectivity: Output<String>

How to connect back to the operator network, e.g. MAPS

Link copied to clipboard

Custom SIP Header to add to any subscriber with a custom_header value, if required.

Link copied to clipboard

Details of DNS Domains to delegate to the Communications Gateway.

Link copied to clipboard
val e911Type: Output<String>

How to handle 911 calls

Link copied to clipboard

A list of dial strings used for emergency calling.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

The managed service identities assigned to this resource.

Link copied to clipboard

Whether an integrated Mobile Control Point is in use.

Link copied to clipboard
val location: Output<String>

The geo-location where the resource lives

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard

Whether an on-premises Mobile Control Point is in use.

Link copied to clipboard
val platforms: Output<List<String>>

What platforms to support

Link copied to clipboard

Resource provisioning state.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The regions in which to deploy the resources needed for Teams Calling

Link copied to clipboard
val sku: Output<SkuResponse>?

The SKU (Stock Keeping Unit) assigned to this resource.

Link copied to clipboard
val status: Output<String>

The current status of the deployment.

Link copied to clipboard

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard

This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>