azure-native.voiceservices.CommunicationsGateway

A CommunicationsGateway resource API Version: 2022-12-01-preview.

Example Usage

CreateCommunicationsGatewayResource

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

return await Deployment.RunAsync(() => 
{
    var communicationsGateway = new AzureNative.VoiceServices.CommunicationsGateway("communicationsGateway", new()
    {
        Codecs = new[]
        {
            "PCMA",
        },
        CommunicationsGatewayName = "myname",
        Connectivity = "PublicAddress",
        E911Type = "Standard",
        Location = "useast",
        Platforms = new[]
        {
            "OperatorConnect",
        },
        ResourceGroupName = "testrg",
        ServiceLocations = new[]
        {
            new AzureNative.VoiceServices.Inputs.ServiceRegionPropertiesArgs
            {
                Name = "useast",
                PrimaryRegionProperties = new AzureNative.VoiceServices.Inputs.PrimaryRegionPropertiesArgs
                {
                    OperatorAddresses = new[]
                    {
                        "198.51.100.1",
                    },
                },
            },
            new AzureNative.VoiceServices.Inputs.ServiceRegionPropertiesArgs
            {
                Name = "useast2",
                PrimaryRegionProperties = new AzureNative.VoiceServices.Inputs.PrimaryRegionPropertiesArgs
                {
                    OperatorAddresses = new[]
                    {
                        "198.51.100.2",
                    },
                },
            },
        },
    });

});

Coming soon!

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 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()        
            .codecs("PCMA")
            .communicationsGatewayName("myname")
            .connectivity("PublicAddress")
            .e911Type("Standard")
            .location("useast")
            .platforms("OperatorConnect")
            .resourceGroupName("testrg")
            .serviceLocations(            
                Map.ofEntries(
                    Map.entry("name", "useast"),
                    Map.entry("primaryRegionProperties", Map.of("operatorAddresses", "198.51.100.1"))
                ),
                Map.ofEntries(
                    Map.entry("name", "useast2"),
                    Map.entry("primaryRegionProperties", Map.of("operatorAddresses", "198.51.100.2"))
                ))
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

communications_gateway = azure_native.voiceservices.CommunicationsGateway("communicationsGateway",
    codecs=["PCMA"],
    communications_gateway_name="myname",
    connectivity="PublicAddress",
    e911_type="Standard",
    location="useast",
    platforms=["OperatorConnect"],
    resource_group_name="testrg",
    service_locations=[
        {
            "name": "useast",
            "primaryRegionProperties": azure_native.voiceservices.PrimaryRegionPropertiesArgs(
                operator_addresses=["198.51.100.1"],
            ),
        },
        {
            "name": "useast2",
            "primaryRegionProperties": azure_native.voiceservices.PrimaryRegionPropertiesArgs(
                operator_addresses=["198.51.100.2"],
            ),
        },
    ])
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const communicationsGateway = new azure_native.voiceservices.CommunicationsGateway("communicationsGateway", {
    codecs: ["PCMA"],
    communicationsGatewayName: "myname",
    connectivity: "PublicAddress",
    e911Type: "Standard",
    location: "useast",
    platforms: ["OperatorConnect"],
    resourceGroupName: "testrg",
    serviceLocations: [
        {
            name: "useast",
            primaryRegionProperties: {
                operatorAddresses: ["198.51.100.1"],
            },
        },
        {
            name: "useast2",
            primaryRegionProperties: {
                operatorAddresses: ["198.51.100.2"],
            },
        },
    ],
});
resources:
  communicationsGateway:
    type: azure-native:voiceservices:CommunicationsGateway
    properties:
      codecs:
        - PCMA
      communicationsGatewayName: myname
      connectivity: PublicAddress
      e911Type: Standard
      location: useast
      platforms:
        - OperatorConnect
      resourceGroupName: testrg
      serviceLocations:
        - name: useast
          primaryRegionProperties:
            operatorAddresses:
              - 198.51.100.1
        - name: useast2
          primaryRegionProperties:
            operatorAddresses:
              - 198.51.100.2

Create CommunicationsGateway Resource

new CommunicationsGateway(name: string, args: CommunicationsGatewayArgs, opts?: CustomResourceOptions);
@overload
def CommunicationsGateway(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          api_bridge: Optional[Any] = None,
                          codecs: Optional[Sequence[Union[str, TeamsCodecs]]] = None,
                          communications_gateway_name: Optional[str] = None,
                          connectivity: Optional[Union[str, Connectivity]] = None,
                          e911_type: Optional[Union[str, E911Type]] = None,
                          location: Optional[str] = None,
                          platforms: Optional[Sequence[Union[str, CommunicationsPlatform]]] = None,
                          resource_group_name: Optional[str] = None,
                          service_locations: Optional[Sequence[ServiceRegionPropertiesArgs]] = None,
                          tags: Optional[Mapping[str, str]] = None)
@overload
def CommunicationsGateway(resource_name: str,
                          args: CommunicationsGatewayArgs,
                          opts: Optional[ResourceOptions] = None)
func NewCommunicationsGateway(ctx *Context, name string, args CommunicationsGatewayArgs, opts ...ResourceOption) (*CommunicationsGateway, error)
public CommunicationsGateway(string name, CommunicationsGatewayArgs args, CustomResourceOptions? opts = null)
public CommunicationsGateway(String name, CommunicationsGatewayArgs args)
public CommunicationsGateway(String name, CommunicationsGatewayArgs args, CustomResourceOptions options)
type: azure-native:voiceservices:CommunicationsGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CommunicationsGatewayArgs
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 CommunicationsGatewayArgs
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 CommunicationsGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CommunicationsGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CommunicationsGatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Codecs List<Union<string, Pulumi.AzureNative.VoiceServices.TeamsCodecs>>

Voice codecs to support

Connectivity string | Pulumi.AzureNative.VoiceServices.Connectivity

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

E911Type string | Pulumi.AzureNative.VoiceServices.E911Type

How to handle 911 calls

Platforms List<Union<string, Pulumi.AzureNative.VoiceServices.CommunicationsPlatform>>

What platforms to support

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ServiceLocations List<Pulumi.AzureNative.VoiceServices.Inputs.ServiceRegionPropertiesArgs>

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

ApiBridge object

Details of API bridge functionality, if required

CommunicationsGatewayName string

Unique identifier for this deployment

Location string

The geo-location where the resource lives

Tags Dictionary<string, string>

Resource tags.

Codecs []string

Voice codecs to support

Connectivity string | Connectivity

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

E911Type string | E911Type

How to handle 911 calls

Platforms []string

What platforms to support

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ServiceLocations []ServiceRegionPropertiesArgs

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

ApiBridge interface{}

Details of API bridge functionality, if required

CommunicationsGatewayName string

Unique identifier for this deployment

Location string

The geo-location where the resource lives

Tags map[string]string

Resource tags.

codecs List<Either<String,TeamsCodecs>>

Voice codecs to support

connectivity String | Connectivity

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

e911Type String | E911Type

How to handle 911 calls

platforms List<Either<String,CommunicationsPlatform>>

What platforms to support

resourceGroupName String

The name of the resource group. The name is case insensitive.

serviceLocations List<ServiceRegionPropertiesArgs>

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

apiBridge Object

Details of API bridge functionality, if required

communicationsGatewayName String

Unique identifier for this deployment

location String

The geo-location where the resource lives

tags Map<String,String>

Resource tags.

codecs (string | TeamsCodecs)[]

Voice codecs to support

connectivity string | Connectivity

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

e911Type string | E911Type

How to handle 911 calls

platforms (string | CommunicationsPlatform)[]

What platforms to support

resourceGroupName string

The name of the resource group. The name is case insensitive.

serviceLocations ServiceRegionPropertiesArgs[]

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

apiBridge any

Details of API bridge functionality, if required

communicationsGatewayName string

Unique identifier for this deployment

location string

The geo-location where the resource lives

tags {[key: string]: string}

Resource tags.

codecs Sequence[Union[str, TeamsCodecs]]

Voice codecs to support

connectivity str | Connectivity

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

e911_type str | E911Type

How to handle 911 calls

platforms Sequence[Union[str, CommunicationsPlatform]]

What platforms to support

resource_group_name str

The name of the resource group. The name is case insensitive.

service_locations Sequence[ServiceRegionPropertiesArgs]

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

api_bridge Any

Details of API bridge functionality, if required

communications_gateway_name str

Unique identifier for this deployment

location str

The geo-location where the resource lives

tags Mapping[str, str]

Resource tags.

codecs List<String | "PCMA" | "PCMU" | "G722" | "G722_2" | "SILK_8" | "SILK_16">

Voice codecs to support

connectivity String | "PublicAddress"

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

e911Type String | "Standard" | "DirectToEsrp"

How to handle 911 calls

platforms List<String | "OperatorConnect" | "TeamsPhoneMobile">

What platforms to support

resourceGroupName String

The name of the resource group. The name is case insensitive.

serviceLocations List<Property Map>

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

apiBridge Any

Details of API bridge functionality, if required

communicationsGatewayName String

Unique identifier for this deployment

location String

The geo-location where the resource lives

tags Map<String>

Resource tags.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource

ProvisioningState string

Resource provisioning state.

Status string

The current status of the deployment.

SystemData Pulumi.AzureNative.VoiceServices.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"

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource

ProvisioningState string

Resource provisioning state.

Status string

The current status of the deployment.

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"

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource

provisioningState String

Resource provisioning state.

status String

The current status of the deployment.

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"

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the resource

provisioningState string

Resource provisioning state.

status string

The current status of the deployment.

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"

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the resource

provisioning_state str

Resource provisioning state.

status str

The current status of the deployment.

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"

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource

provisioningState String

Resource provisioning state.

status String

The current status of the deployment.

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

CommunicationsPlatform

OperatorConnect
OperatorConnect
TeamsPhoneMobile
TeamsPhoneMobile
CommunicationsPlatformOperatorConnect
OperatorConnect
CommunicationsPlatformTeamsPhoneMobile
TeamsPhoneMobile
OperatorConnect
OperatorConnect
TeamsPhoneMobile
TeamsPhoneMobile
OperatorConnect
OperatorConnect
TeamsPhoneMobile
TeamsPhoneMobile
OPERATOR_CONNECT
OperatorConnect
TEAMS_PHONE_MOBILE
TeamsPhoneMobile
"OperatorConnect"
OperatorConnect
"TeamsPhoneMobile"
TeamsPhoneMobile

Connectivity

PublicAddress
PublicAddress

This deployment connects to the operator network using a Public IP address, e.g. when using MAPS

ConnectivityPublicAddress
PublicAddress

This deployment connects to the operator network using a Public IP address, e.g. when using MAPS

PublicAddress
PublicAddress

This deployment connects to the operator network using a Public IP address, e.g. when using MAPS

PublicAddress
PublicAddress

This deployment connects to the operator network using a Public IP address, e.g. when using MAPS

PUBLIC_ADDRESS
PublicAddress

This deployment connects to the operator network using a Public IP address, e.g. when using MAPS

"PublicAddress"
PublicAddress

This deployment connects to the operator network using a Public IP address, e.g. when using MAPS

E911Type

Standard
Standard

Emergency calls are not handled different from other calls

DirectToEsrp
DirectToEsrp

Emergency calls are routed directly to the ESRP

E911TypeStandard
Standard

Emergency calls are not handled different from other calls

E911TypeDirectToEsrp
DirectToEsrp

Emergency calls are routed directly to the ESRP

Standard
Standard

Emergency calls are not handled different from other calls

DirectToEsrp
DirectToEsrp

Emergency calls are routed directly to the ESRP

Standard
Standard

Emergency calls are not handled different from other calls

DirectToEsrp
DirectToEsrp

Emergency calls are routed directly to the ESRP

STANDARD
Standard

Emergency calls are not handled different from other calls

DIRECT_TO_ESRP
DirectToEsrp

Emergency calls are routed directly to the ESRP

"Standard"
Standard

Emergency calls are not handled different from other calls

"DirectToEsrp"
DirectToEsrp

Emergency calls are routed directly to the ESRP

PrimaryRegionProperties

OperatorAddresses List<string>

IP address to use to contact the operator network from this region

EsrpAddresses List<string>

IP address to use to contact the ESRP from this region

OperatorAddresses []string

IP address to use to contact the operator network from this region

EsrpAddresses []string

IP address to use to contact the ESRP from this region

operatorAddresses List<String>

IP address to use to contact the operator network from this region

esrpAddresses List<String>

IP address to use to contact the ESRP from this region

operatorAddresses string[]

IP address to use to contact the operator network from this region

esrpAddresses string[]

IP address to use to contact the ESRP from this region

operator_addresses Sequence[str]

IP address to use to contact the operator network from this region

esrp_addresses Sequence[str]

IP address to use to contact the ESRP from this region

operatorAddresses List<String>

IP address to use to contact the operator network from this region

esrpAddresses List<String>

IP address to use to contact the ESRP from this region

PrimaryRegionPropertiesResponse

OperatorAddresses List<string>

IP address to use to contact the operator network from this region

EsrpAddresses List<string>

IP address to use to contact the ESRP from this region

OperatorAddresses []string

IP address to use to contact the operator network from this region

EsrpAddresses []string

IP address to use to contact the ESRP from this region

operatorAddresses List<String>

IP address to use to contact the operator network from this region

esrpAddresses List<String>

IP address to use to contact the ESRP from this region

operatorAddresses string[]

IP address to use to contact the operator network from this region

esrpAddresses string[]

IP address to use to contact the ESRP from this region

operator_addresses Sequence[str]

IP address to use to contact the operator network from this region

esrp_addresses Sequence[str]

IP address to use to contact the ESRP from this region

operatorAddresses List<String>

IP address to use to contact the operator network from this region

esrpAddresses List<String>

IP address to use to contact the ESRP from this region

ServiceRegionProperties

Name string

The name of the region in which the resources needed for Teams Calling will be deployed.

PrimaryRegionProperties Pulumi.AzureNative.VoiceServices.Inputs.PrimaryRegionProperties

The configuration used in this region as primary, and other regions as backup.

Name string

The name of the region in which the resources needed for Teams Calling will be deployed.

PrimaryRegionProperties PrimaryRegionProperties

The configuration used in this region as primary, and other regions as backup.

name String

The name of the region in which the resources needed for Teams Calling will be deployed.

primaryRegionProperties PrimaryRegionProperties

The configuration used in this region as primary, and other regions as backup.

name string

The name of the region in which the resources needed for Teams Calling will be deployed.

primaryRegionProperties PrimaryRegionProperties

The configuration used in this region as primary, and other regions as backup.

name str

The name of the region in which the resources needed for Teams Calling will be deployed.

primary_region_properties PrimaryRegionProperties

The configuration used in this region as primary, and other regions as backup.

name String

The name of the region in which the resources needed for Teams Calling will be deployed.

primaryRegionProperties Property Map

The configuration used in this region as primary, and other regions as backup.

ServiceRegionPropertiesResponse

Name string

The name of the region in which the resources needed for Teams Calling will be deployed.

PrimaryRegionProperties Pulumi.AzureNative.VoiceServices.Inputs.PrimaryRegionPropertiesResponse

The configuration used in this region as primary, and other regions as backup.

Name string

The name of the region in which the resources needed for Teams Calling will be deployed.

PrimaryRegionProperties PrimaryRegionPropertiesResponse

The configuration used in this region as primary, and other regions as backup.

name String

The name of the region in which the resources needed for Teams Calling will be deployed.

primaryRegionProperties PrimaryRegionPropertiesResponse

The configuration used in this region as primary, and other regions as backup.

name string

The name of the region in which the resources needed for Teams Calling will be deployed.

primaryRegionProperties PrimaryRegionPropertiesResponse

The configuration used in this region as primary, and other regions as backup.

name str

The name of the region in which the resources needed for Teams Calling will be deployed.

primary_region_properties PrimaryRegionPropertiesResponse

The configuration used in this region as primary, and other regions as backup.

name String

The name of the region in which the resources needed for Teams Calling will be deployed.

primaryRegionProperties Property Map

The configuration used in this region as primary, and other regions as backup.

SystemDataResponse

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.

TeamsCodecs

PCMA
PCMA
PCMU
PCMU
G722
G722
G722_2
G722_2
SILK_8
SILK_8
SILK_16
SILK_16
TeamsCodecsPCMA
PCMA
TeamsCodecsPCMU
PCMU
TeamsCodecsG722
G722
TeamsCodecs_G722_2
G722_2
TeamsCodecs_SILK_8
SILK_8
TeamsCodecs_SILK_16
SILK_16
PCMA
PCMA
PCMU
PCMU
G722
G722
G722_2
G722_2
SILK_8
SILK_8
SILK_16
SILK_16
PCMA
PCMA
PCMU
PCMU
G722
G722
G722_2
G722_2
SILK_8
SILK_8
SILK_16
SILK_16
PCMA
PCMA
PCMU
PCMU
G722
G722
G722_2
G722_2
SIL_K_8
SILK_8
SIL_K_16
SILK_16
"PCMA"
PCMA
"PCMU"
PCMU
"G722"
G722
"G722_2"
G722_2
"SILK_8"
SILK_8
"SILK_16"
SILK_16

Import

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

$ pulumi import azure-native:voiceservices:CommunicationsGateway myname /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VoiceService/communicationsGateway/myname 

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0