We recommend using Azure Native.
azure.voice.ServicesCommunicationsGateway
Explore with Pulumi AI
Manages a Voice Services Communications Gateways.
!> NOTE: You must have signed an Operator Connect agreement with Microsoft to use this resource. For more information, see Prerequisites
.
!> NOTE: Access to Azure Communications Gateway is restricted, see Get access to Azure Communications Gateway for your Azure subscription
for details.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleServicesCommunicationsGateway = new azure.voice.ServicesCommunicationsGateway("example", {
name: "example-vcg",
location: "West Europe",
resourceGroupName: example.name,
connectivity: "PublicAddress",
codecs: "PCMA",
e911Type: "DirectToEsrp",
platforms: [
"OperatorConnect",
"TeamsPhoneMobile",
],
serviceLocations: [
{
location: "eastus",
allowedMediaSourceAddressPrefixes: ["10.1.2.0/24"],
allowedSignalingSourceAddressPrefixes: ["10.1.1.0/24"],
esrpAddresses: ["198.51.100.3"],
operatorAddresses: ["198.51.100.1"],
},
{
location: "eastus2",
allowedMediaSourceAddressPrefixes: ["10.2.2.0/24"],
allowedSignalingSourceAddressPrefixes: ["10.2.1.0/24"],
esrpAddresses: ["198.51.100.4"],
operatorAddresses: ["198.51.100.2"],
},
],
autoGeneratedDomainNameLabelScope: "SubscriptionReuse",
apiBridge: JSON.stringify({}),
emergencyDialStrings: [
"911",
"933",
],
onPremMcpEnabled: false,
tags: {
key: "value",
},
microsoftTeamsVoicemailPilotNumber: "1",
});
import pulumi
import json
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_services_communications_gateway = azure.voice.ServicesCommunicationsGateway("example",
name="example-vcg",
location="West Europe",
resource_group_name=example.name,
connectivity="PublicAddress",
codecs="PCMA",
e911_type="DirectToEsrp",
platforms=[
"OperatorConnect",
"TeamsPhoneMobile",
],
service_locations=[
azure.voice.ServicesCommunicationsGatewayServiceLocationArgs(
location="eastus",
allowed_media_source_address_prefixes=["10.1.2.0/24"],
allowed_signaling_source_address_prefixes=["10.1.1.0/24"],
esrp_addresses=["198.51.100.3"],
operator_addresses=["198.51.100.1"],
),
azure.voice.ServicesCommunicationsGatewayServiceLocationArgs(
location="eastus2",
allowed_media_source_address_prefixes=["10.2.2.0/24"],
allowed_signaling_source_address_prefixes=["10.2.1.0/24"],
esrp_addresses=["198.51.100.4"],
operator_addresses=["198.51.100.2"],
),
],
auto_generated_domain_name_label_scope="SubscriptionReuse",
api_bridge=json.dumps({}),
emergency_dial_strings=[
"911",
"933",
],
on_prem_mcp_enabled=False,
tags={
"key": "value",
},
microsoft_teams_voicemail_pilot_number="1")
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/voice"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(nil)
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = voice.NewServicesCommunicationsGateway(ctx, "example", &voice.ServicesCommunicationsGatewayArgs{
Name: pulumi.String("example-vcg"),
Location: pulumi.String("West Europe"),
ResourceGroupName: example.Name,
Connectivity: pulumi.String("PublicAddress"),
Codecs: pulumi.String("PCMA"),
E911Type: pulumi.String("DirectToEsrp"),
Platforms: pulumi.StringArray{
pulumi.String("OperatorConnect"),
pulumi.String("TeamsPhoneMobile"),
},
ServiceLocations: voice.ServicesCommunicationsGatewayServiceLocationArray{
&voice.ServicesCommunicationsGatewayServiceLocationArgs{
Location: pulumi.String("eastus"),
AllowedMediaSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.1.2.0/24"),
},
AllowedSignalingSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.1.1.0/24"),
},
EsrpAddresses: pulumi.StringArray{
pulumi.String("198.51.100.3"),
},
OperatorAddresses: pulumi.StringArray{
pulumi.String("198.51.100.1"),
},
},
&voice.ServicesCommunicationsGatewayServiceLocationArgs{
Location: pulumi.String("eastus2"),
AllowedMediaSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.2.2.0/24"),
},
AllowedSignalingSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("10.2.1.0/24"),
},
EsrpAddresses: pulumi.StringArray{
pulumi.String("198.51.100.4"),
},
OperatorAddresses: pulumi.StringArray{
pulumi.String("198.51.100.2"),
},
},
},
AutoGeneratedDomainNameLabelScope: pulumi.String("SubscriptionReuse"),
ApiBridge: pulumi.String(json0),
EmergencyDialStrings: pulumi.StringArray{
pulumi.String("911"),
pulumi.String("933"),
},
OnPremMcpEnabled: pulumi.Bool(false),
Tags: pulumi.StringMap{
"key": pulumi.String("value"),
},
MicrosoftTeamsVoicemailPilotNumber: pulumi.String("1"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleServicesCommunicationsGateway = new Azure.Voice.ServicesCommunicationsGateway("example", new()
{
Name = "example-vcg",
Location = "West Europe",
ResourceGroupName = example.Name,
Connectivity = "PublicAddress",
Codecs = "PCMA",
E911Type = "DirectToEsrp",
Platforms = new[]
{
"OperatorConnect",
"TeamsPhoneMobile",
},
ServiceLocations = new[]
{
new Azure.Voice.Inputs.ServicesCommunicationsGatewayServiceLocationArgs
{
Location = "eastus",
AllowedMediaSourceAddressPrefixes = new[]
{
"10.1.2.0/24",
},
AllowedSignalingSourceAddressPrefixes = new[]
{
"10.1.1.0/24",
},
EsrpAddresses = new[]
{
"198.51.100.3",
},
OperatorAddresses = new[]
{
"198.51.100.1",
},
},
new Azure.Voice.Inputs.ServicesCommunicationsGatewayServiceLocationArgs
{
Location = "eastus2",
AllowedMediaSourceAddressPrefixes = new[]
{
"10.2.2.0/24",
},
AllowedSignalingSourceAddressPrefixes = new[]
{
"10.2.1.0/24",
},
EsrpAddresses = new[]
{
"198.51.100.4",
},
OperatorAddresses = new[]
{
"198.51.100.2",
},
},
},
AutoGeneratedDomainNameLabelScope = "SubscriptionReuse",
ApiBridge = JsonSerializer.Serialize(new Dictionary<string, object?>
{
}),
EmergencyDialStrings = new[]
{
"911",
"933",
},
OnPremMcpEnabled = false,
Tags =
{
{ "key", "value" },
},
MicrosoftTeamsVoicemailPilotNumber = "1",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.voice.ServicesCommunicationsGateway;
import com.pulumi.azure.voice.ServicesCommunicationsGatewayArgs;
import com.pulumi.azure.voice.inputs.ServicesCommunicationsGatewayServiceLocationArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleServicesCommunicationsGateway = new ServicesCommunicationsGateway("exampleServicesCommunicationsGateway", ServicesCommunicationsGatewayArgs.builder()
.name("example-vcg")
.location("West Europe")
.resourceGroupName(example.name())
.connectivity("PublicAddress")
.codecs("PCMA")
.e911Type("DirectToEsrp")
.platforms(
"OperatorConnect",
"TeamsPhoneMobile")
.serviceLocations(
ServicesCommunicationsGatewayServiceLocationArgs.builder()
.location("eastus")
.allowedMediaSourceAddressPrefixes("10.1.2.0/24")
.allowedSignalingSourceAddressPrefixes("10.1.1.0/24")
.esrpAddresses("198.51.100.3")
.operatorAddresses("198.51.100.1")
.build(),
ServicesCommunicationsGatewayServiceLocationArgs.builder()
.location("eastus2")
.allowedMediaSourceAddressPrefixes("10.2.2.0/24")
.allowedSignalingSourceAddressPrefixes("10.2.1.0/24")
.esrpAddresses("198.51.100.4")
.operatorAddresses("198.51.100.2")
.build())
.autoGeneratedDomainNameLabelScope("SubscriptionReuse")
.apiBridge(serializeJson(
jsonObject(
)))
.emergencyDialStrings(
"911",
"933")
.onPremMcpEnabled(false)
.tags(Map.of("key", "value"))
.microsoftTeamsVoicemailPilotNumber("1")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleServicesCommunicationsGateway:
type: azure:voice:ServicesCommunicationsGateway
name: example
properties:
name: example-vcg
location: West Europe
resourceGroupName: ${example.name}
connectivity: PublicAddress
codecs: PCMA
e911Type: DirectToEsrp
platforms:
- OperatorConnect
- TeamsPhoneMobile
serviceLocations:
- location: eastus
allowedMediaSourceAddressPrefixes:
- 10.1.2.0/24
allowedSignalingSourceAddressPrefixes:
- 10.1.1.0/24
esrpAddresses:
- 198.51.100.3
operatorAddresses:
- 198.51.100.1
- location: eastus2
allowedMediaSourceAddressPrefixes:
- 10.2.2.0/24
allowedSignalingSourceAddressPrefixes:
- 10.2.1.0/24
esrpAddresses:
- 198.51.100.4
operatorAddresses:
- 198.51.100.2
autoGeneratedDomainNameLabelScope: SubscriptionReuse
apiBridge:
fn::toJSON: {}
emergencyDialStrings:
- '911'
- '933'
onPremMcpEnabled: false
tags:
key: value
microsoftTeamsVoicemailPilotNumber: '1'
Create ServicesCommunicationsGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ServicesCommunicationsGateway(name: string, args: ServicesCommunicationsGatewayArgs, opts?: CustomResourceOptions);
@overload
def ServicesCommunicationsGateway(resource_name: str,
args: ServicesCommunicationsGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ServicesCommunicationsGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
platforms: Optional[Sequence[str]] = None,
service_locations: Optional[Sequence[ServicesCommunicationsGatewayServiceLocationArgs]] = None,
codecs: Optional[str] = None,
connectivity: Optional[str] = None,
e911_type: Optional[str] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
microsoft_teams_voicemail_pilot_number: Optional[str] = None,
name: Optional[str] = None,
on_prem_mcp_enabled: Optional[bool] = None,
api_bridge: Optional[str] = None,
emergency_dial_strings: Optional[Sequence[str]] = None,
auto_generated_domain_name_label_scope: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewServicesCommunicationsGateway(ctx *Context, name string, args ServicesCommunicationsGatewayArgs, opts ...ResourceOption) (*ServicesCommunicationsGateway, error)
public ServicesCommunicationsGateway(string name, ServicesCommunicationsGatewayArgs args, CustomResourceOptions? opts = null)
public ServicesCommunicationsGateway(String name, ServicesCommunicationsGatewayArgs args)
public ServicesCommunicationsGateway(String name, ServicesCommunicationsGatewayArgs args, CustomResourceOptions options)
type: azure:voice:ServicesCommunicationsGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ServicesCommunicationsGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ServicesCommunicationsGatewayArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServicesCommunicationsGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServicesCommunicationsGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServicesCommunicationsGatewayArgs
- 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 servicesCommunicationsGatewayResource = new Azure.Voice.ServicesCommunicationsGateway("servicesCommunicationsGatewayResource", new()
{
Platforms = new[]
{
"string",
},
ServiceLocations = new[]
{
new Azure.Voice.Inputs.ServicesCommunicationsGatewayServiceLocationArgs
{
Location = "string",
OperatorAddresses = new[]
{
"string",
},
AllowedMediaSourceAddressPrefixes = new[]
{
"string",
},
AllowedSignalingSourceAddressPrefixes = new[]
{
"string",
},
EsrpAddresses = new[]
{
"string",
},
},
},
Codecs = "string",
Connectivity = "string",
E911Type = "string",
ResourceGroupName = "string",
Location = "string",
MicrosoftTeamsVoicemailPilotNumber = "string",
Name = "string",
OnPremMcpEnabled = false,
ApiBridge = "string",
EmergencyDialStrings = new[]
{
"string",
},
AutoGeneratedDomainNameLabelScope = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := voice.NewServicesCommunicationsGateway(ctx, "servicesCommunicationsGatewayResource", &voice.ServicesCommunicationsGatewayArgs{
Platforms: pulumi.StringArray{
pulumi.String("string"),
},
ServiceLocations: voice.ServicesCommunicationsGatewayServiceLocationArray{
&voice.ServicesCommunicationsGatewayServiceLocationArgs{
Location: pulumi.String("string"),
OperatorAddresses: pulumi.StringArray{
pulumi.String("string"),
},
AllowedMediaSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("string"),
},
AllowedSignalingSourceAddressPrefixes: pulumi.StringArray{
pulumi.String("string"),
},
EsrpAddresses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Codecs: pulumi.String("string"),
Connectivity: pulumi.String("string"),
E911Type: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
MicrosoftTeamsVoicemailPilotNumber: pulumi.String("string"),
Name: pulumi.String("string"),
OnPremMcpEnabled: pulumi.Bool(false),
ApiBridge: pulumi.String("string"),
EmergencyDialStrings: pulumi.StringArray{
pulumi.String("string"),
},
AutoGeneratedDomainNameLabelScope: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var servicesCommunicationsGatewayResource = new ServicesCommunicationsGateway("servicesCommunicationsGatewayResource", ServicesCommunicationsGatewayArgs.builder()
.platforms("string")
.serviceLocations(ServicesCommunicationsGatewayServiceLocationArgs.builder()
.location("string")
.operatorAddresses("string")
.allowedMediaSourceAddressPrefixes("string")
.allowedSignalingSourceAddressPrefixes("string")
.esrpAddresses("string")
.build())
.codecs("string")
.connectivity("string")
.e911Type("string")
.resourceGroupName("string")
.location("string")
.microsoftTeamsVoicemailPilotNumber("string")
.name("string")
.onPremMcpEnabled(false)
.apiBridge("string")
.emergencyDialStrings("string")
.autoGeneratedDomainNameLabelScope("string")
.tags(Map.of("string", "string"))
.build());
services_communications_gateway_resource = azure.voice.ServicesCommunicationsGateway("servicesCommunicationsGatewayResource",
platforms=["string"],
service_locations=[azure.voice.ServicesCommunicationsGatewayServiceLocationArgs(
location="string",
operator_addresses=["string"],
allowed_media_source_address_prefixes=["string"],
allowed_signaling_source_address_prefixes=["string"],
esrp_addresses=["string"],
)],
codecs="string",
connectivity="string",
e911_type="string",
resource_group_name="string",
location="string",
microsoft_teams_voicemail_pilot_number="string",
name="string",
on_prem_mcp_enabled=False,
api_bridge="string",
emergency_dial_strings=["string"],
auto_generated_domain_name_label_scope="string",
tags={
"string": "string",
})
const servicesCommunicationsGatewayResource = new azure.voice.ServicesCommunicationsGateway("servicesCommunicationsGatewayResource", {
platforms: ["string"],
serviceLocations: [{
location: "string",
operatorAddresses: ["string"],
allowedMediaSourceAddressPrefixes: ["string"],
allowedSignalingSourceAddressPrefixes: ["string"],
esrpAddresses: ["string"],
}],
codecs: "string",
connectivity: "string",
e911Type: "string",
resourceGroupName: "string",
location: "string",
microsoftTeamsVoicemailPilotNumber: "string",
name: "string",
onPremMcpEnabled: false,
apiBridge: "string",
emergencyDialStrings: ["string"],
autoGeneratedDomainNameLabelScope: "string",
tags: {
string: "string",
},
});
type: azure:voice:ServicesCommunicationsGateway
properties:
apiBridge: string
autoGeneratedDomainNameLabelScope: string
codecs: string
connectivity: string
e911Type: string
emergencyDialStrings:
- string
location: string
microsoftTeamsVoicemailPilotNumber: string
name: string
onPremMcpEnabled: false
platforms:
- string
resourceGroupName: string
serviceLocations:
- allowedMediaSourceAddressPrefixes:
- string
allowedSignalingSourceAddressPrefixes:
- string
esrpAddresses:
- string
location: string
operatorAddresses:
- string
tags:
string: string
ServicesCommunicationsGateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ServicesCommunicationsGateway resource accepts the following input properties:
- Codecs string
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - Connectivity string
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - E911Type string
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - Platforms List<string>
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - Resource
Group stringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Service
Locations List<ServicesCommunications Gateway Service Location> - A
service_location
block as defined below. - Api
Bridge string - Details of API bridge functionality, if required.
- Auto
Generated stringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - Emergency
Dial List<string>Strings - A list of dial strings used for emergency calling.
- Location string
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Microsoft
Teams stringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- Name string
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- On
Prem boolMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- Codecs string
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - Connectivity string
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - E911Type string
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - Platforms []string
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - Resource
Group stringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Service
Locations []ServicesCommunications Gateway Service Location Args - A
service_location
block as defined below. - Api
Bridge string - Details of API bridge functionality, if required.
- Auto
Generated stringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - Emergency
Dial []stringStrings - A list of dial strings used for emergency calling.
- Location string
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Microsoft
Teams stringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- Name string
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- On
Prem boolMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- map[string]string
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- codecs String
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity String
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911Type String
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - platforms List<String>
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource
Group StringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service
Locations List<ServicesCommunications Gateway Service Location> - A
service_location
block as defined below. - api
Bridge String - Details of API bridge functionality, if required.
- auto
Generated StringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - emergency
Dial List<String>Strings - A list of dial strings used for emergency calling.
- location String
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft
Teams StringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name String
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on
Prem BooleanMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- Map<String,String>
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- codecs string
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity string
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911Type string
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - platforms string[]
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource
Group stringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service
Locations ServicesCommunications Gateway Service Location[] - A
service_location
block as defined below. - api
Bridge string - Details of API bridge functionality, if required.
- auto
Generated stringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - emergency
Dial string[]Strings - A list of dial strings used for emergency calling.
- location string
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft
Teams stringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name string
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on
Prem booleanMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- codecs str
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity str
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911_
type str - How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - platforms Sequence[str]
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource_
group_ strname - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service_
locations Sequence[ServicesCommunications Gateway Service Location Args] - A
service_location
block as defined below. - api_
bridge str - Details of API bridge functionality, if required.
- auto_
generated_ strdomain_ name_ label_ scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - emergency_
dial_ Sequence[str]strings - A list of dial strings used for emergency calling.
- location str
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft_
teams_ strvoicemail_ pilot_ number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name str
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on_
prem_ boolmcp_ enabled - Whether an on-premises Mobile Control Point is in use.
- Mapping[str, str]
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- codecs String
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity String
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911Type String
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - platforms List<String>
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource
Group StringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service
Locations List<Property Map> - A
service_location
block as defined below. - api
Bridge String - Details of API bridge functionality, if required.
- auto
Generated StringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - emergency
Dial List<String>Strings - A list of dial strings used for emergency calling.
- location String
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft
Teams StringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name String
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on
Prem BooleanMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- Map<String>
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServicesCommunicationsGateway resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ServicesCommunicationsGateway Resource
Get an existing ServicesCommunicationsGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServicesCommunicationsGatewayState, opts?: CustomResourceOptions): ServicesCommunicationsGateway
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_bridge: Optional[str] = None,
auto_generated_domain_name_label_scope: Optional[str] = None,
codecs: Optional[str] = None,
connectivity: Optional[str] = None,
e911_type: Optional[str] = None,
emergency_dial_strings: Optional[Sequence[str]] = None,
location: Optional[str] = None,
microsoft_teams_voicemail_pilot_number: Optional[str] = None,
name: Optional[str] = None,
on_prem_mcp_enabled: Optional[bool] = None,
platforms: Optional[Sequence[str]] = None,
resource_group_name: Optional[str] = None,
service_locations: Optional[Sequence[ServicesCommunicationsGatewayServiceLocationArgs]] = None,
tags: Optional[Mapping[str, str]] = None) -> ServicesCommunicationsGateway
func GetServicesCommunicationsGateway(ctx *Context, name string, id IDInput, state *ServicesCommunicationsGatewayState, opts ...ResourceOption) (*ServicesCommunicationsGateway, error)
public static ServicesCommunicationsGateway Get(string name, Input<string> id, ServicesCommunicationsGatewayState? state, CustomResourceOptions? opts = null)
public static ServicesCommunicationsGateway get(String name, Output<String> id, ServicesCommunicationsGatewayState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Bridge string - Details of API bridge functionality, if required.
- Auto
Generated stringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - Codecs string
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - Connectivity string
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - E911Type string
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - Emergency
Dial List<string>Strings - A list of dial strings used for emergency calling.
- Location string
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Microsoft
Teams stringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- Name string
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- On
Prem boolMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- Platforms List<string>
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - Resource
Group stringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Service
Locations List<ServicesCommunications Gateway Service Location> - A
service_location
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- Api
Bridge string - Details of API bridge functionality, if required.
- Auto
Generated stringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - Codecs string
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - Connectivity string
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - E911Type string
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - Emergency
Dial []stringStrings - A list of dial strings used for emergency calling.
- Location string
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Microsoft
Teams stringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- Name string
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- On
Prem boolMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- Platforms []string
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - Resource
Group stringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- Service
Locations []ServicesCommunications Gateway Service Location Args - A
service_location
block as defined below. - map[string]string
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- api
Bridge String - Details of API bridge functionality, if required.
- auto
Generated StringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - codecs String
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity String
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911Type String
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - emergency
Dial List<String>Strings - A list of dial strings used for emergency calling.
- location String
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft
Teams StringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name String
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on
Prem BooleanMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- platforms List<String>
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource
Group StringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service
Locations List<ServicesCommunications Gateway Service Location> - A
service_location
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- api
Bridge string - Details of API bridge functionality, if required.
- auto
Generated stringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - codecs string
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity string
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911Type string
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - emergency
Dial string[]Strings - A list of dial strings used for emergency calling.
- location string
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft
Teams stringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name string
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on
Prem booleanMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- platforms string[]
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource
Group stringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service
Locations ServicesCommunications Gateway Service Location[] - A
service_location
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- api_
bridge str - Details of API bridge functionality, if required.
- auto_
generated_ strdomain_ name_ label_ scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - codecs str
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity str
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911_
type str - How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - emergency_
dial_ Sequence[str]strings - A list of dial strings used for emergency calling.
- location str
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft_
teams_ strvoicemail_ pilot_ number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name str
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on_
prem_ boolmcp_ enabled - Whether an on-premises Mobile Control Point is in use.
- platforms Sequence[str]
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource_
group_ strname - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service_
locations Sequence[ServicesCommunications Gateway Service Location Args] - A
service_location
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
- api
Bridge String - Details of API bridge functionality, if required.
- auto
Generated StringDomain Name Label Scope - Specifies the scope at which the auto-generated domain name can be re-used. Possible values are
TenantReuse
,SubscriptionReuse
,ResourceGroupReuse
andNoReuse
. Changing this forces a new resource to be created. Defaults toTenantReuse
. - codecs String
- The voice codecs expected for communication with Teams. Possible values are
PCMA
,PCMU
,G722
,G722_2
,SILK_8
andSILK_16
. - connectivity String
- How to connect back to the operator network, e.g. MAPS. Possible values is
PublicAddress
. Changing this forces a new Voice Services Communications Gateways to be created. - e911Type String
- How to handle 911 calls. Possible values are
Standard
andDirectToEsrp
. - emergency
Dial List<String>Strings - A list of dial strings used for emergency calling.
- location String
- Specifies the Azure Region where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- microsoft
Teams StringVoicemail Pilot Number - This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- name String
- Specifies the name which should be used for this Voice Services Communications Gateways. Changing this forces a new resource to be created.
- on
Prem BooleanMcp Enabled - Whether an on-premises Mobile Control Point is in use.
- platforms List<String>
- The Voice Services Communications GatewaysAvailable supports platform types. Possible values are
OperatorConnect
,TeamsPhoneMobile
. - resource
Group StringName - Specifies the name of the Resource Group where the Voice Services Communications Gateways should exist. Changing this forces a new resource to be created.
- service
Locations List<Property Map> - A
service_location
block as defined below. - Map<String>
- A mapping of tags which should be assigned to the Voice Services Communications Gateways.
Supporting Types
ServicesCommunicationsGatewayServiceLocation, ServicesCommunicationsGatewayServiceLocationArgs
- Location string
- Specifies the region in which the resources needed for Teams Calling will be deployed.
- Operator
Addresses List<string> - IP address to use to contact the operator network from this region.
- Allowed
Media List<string>Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for media.
- Allowed
Signaling List<string>Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for signaling.
- Esrp
Addresses List<string> IP address to use to contact the ESRP from this region.
!> NOTE: The
esrp_addresses
must be specified for eachservice_location
when thee911_type
is set toDirectToEsrp
. Theesrp_addresses
must not be specified for eachservice_location
when thee911_type
is set toStandard
.
- Location string
- Specifies the region in which the resources needed for Teams Calling will be deployed.
- Operator
Addresses []string - IP address to use to contact the operator network from this region.
- Allowed
Media []stringSource Address Prefixes - Specifies the allowed source IP address or CIDR ranges for media.
- Allowed
Signaling []stringSource Address Prefixes - Specifies the allowed source IP address or CIDR ranges for signaling.
- Esrp
Addresses []string IP address to use to contact the ESRP from this region.
!> NOTE: The
esrp_addresses
must be specified for eachservice_location
when thee911_type
is set toDirectToEsrp
. Theesrp_addresses
must not be specified for eachservice_location
when thee911_type
is set toStandard
.
- location String
- Specifies the region in which the resources needed for Teams Calling will be deployed.
- operator
Addresses List<String> - IP address to use to contact the operator network from this region.
- allowed
Media List<String>Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for media.
- allowed
Signaling List<String>Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for signaling.
- esrp
Addresses List<String> IP address to use to contact the ESRP from this region.
!> NOTE: The
esrp_addresses
must be specified for eachservice_location
when thee911_type
is set toDirectToEsrp
. Theesrp_addresses
must not be specified for eachservice_location
when thee911_type
is set toStandard
.
- location string
- Specifies the region in which the resources needed for Teams Calling will be deployed.
- operator
Addresses string[] - IP address to use to contact the operator network from this region.
- allowed
Media string[]Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for media.
- allowed
Signaling string[]Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for signaling.
- esrp
Addresses string[] IP address to use to contact the ESRP from this region.
!> NOTE: The
esrp_addresses
must be specified for eachservice_location
when thee911_type
is set toDirectToEsrp
. Theesrp_addresses
must not be specified for eachservice_location
when thee911_type
is set toStandard
.
- location str
- Specifies the region in which the resources needed for Teams Calling will be deployed.
- operator_
addresses Sequence[str] - IP address to use to contact the operator network from this region.
- allowed_
media_ Sequence[str]source_ address_ prefixes - Specifies the allowed source IP address or CIDR ranges for media.
- allowed_
signaling_ Sequence[str]source_ address_ prefixes - Specifies the allowed source IP address or CIDR ranges for signaling.
- esrp_
addresses Sequence[str] IP address to use to contact the ESRP from this region.
!> NOTE: The
esrp_addresses
must be specified for eachservice_location
when thee911_type
is set toDirectToEsrp
. Theesrp_addresses
must not be specified for eachservice_location
when thee911_type
is set toStandard
.
- location String
- Specifies the region in which the resources needed for Teams Calling will be deployed.
- operator
Addresses List<String> - IP address to use to contact the operator network from this region.
- allowed
Media List<String>Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for media.
- allowed
Signaling List<String>Source Address Prefixes - Specifies the allowed source IP address or CIDR ranges for signaling.
- esrp
Addresses List<String> IP address to use to contact the ESRP from this region.
!> NOTE: The
esrp_addresses
must be specified for eachservice_location
when thee911_type
is set toDirectToEsrp
. Theesrp_addresses
must not be specified for eachservice_location
when thee911_type
is set toStandard
.
Import
Voice Services Communications Gateways can be imported using the resource id
, e.g.
$ pulumi import azure:voice/servicesCommunicationsGateway:ServicesCommunicationsGateway example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.VoiceServices/communicationsGateways/communicationsGateway1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.