Azure Native v2.21.2, Dec 8 23

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.21.2 published on Friday, Dec 8, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.voiceservices.getCommunicationsGateway

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.21.2 published on Friday, Dec 8, 2023 by Pulumi

pulumi/pulumi-azure-native

Using getCommunicationsGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCommunicationsGateway(args: GetCommunicationsGatewayArgs, opts?: InvokeOptions): Promise<GetCommunicationsGatewayResult>
function getCommunicationsGatewayOutput(args: GetCommunicationsGatewayOutputArgs, opts?: InvokeOptions): Output<GetCommunicationsGatewayResult>

def get_communications_gateway(communications_gateway_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetCommunicationsGatewayResult
def get_communications_gateway_output(communications_gateway_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetCommunicationsGatewayResult]

func LookupCommunicationsGateway(ctx *Context, args *LookupCommunicationsGatewayArgs, opts ...InvokeOption) (*LookupCommunicationsGatewayResult, error)
func LookupCommunicationsGatewayOutput(ctx *Context, args *LookupCommunicationsGatewayOutputArgs, opts ...InvokeOption) LookupCommunicationsGatewayResultOutput

> Note: This function is named LookupCommunicationsGateway in the Go SDK.

public static class GetCommunicationsGateway 
{
    public static Task<GetCommunicationsGatewayResult> InvokeAsync(GetCommunicationsGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetCommunicationsGatewayResult> Invoke(GetCommunicationsGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCommunicationsGatewayResult> getCommunicationsGateway(GetCommunicationsGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:voiceservices:getCommunicationsGateway
  arguments:
    # arguments dictionary

The following arguments are supported:

CommunicationsGatewayName string: Unique identifier for this deployment
ResourceGroupName string: The name of the resource group. The name is case insensitive.

CommunicationsGatewayName string: Unique identifier for this deployment
ResourceGroupName string: The name of the resource group. The name is case insensitive.

communicationsGatewayName String: Unique identifier for this deployment
resourceGroupName String: The name of the resource group. The name is case insensitive.

communicationsGatewayName string: Unique identifier for this deployment
resourceGroupName string: The name of the resource group. The name is case insensitive.

communications_gateway_name str: Unique identifier for this deployment
resource_group_name str: The name of the resource group. The name is case insensitive.

communicationsGatewayName String: Unique identifier for this deployment
resourceGroupName String: The name of the resource group. The name is case insensitive.

getCommunicationsGateway Result

The following output properties are available:

AutoGeneratedDomainNameLabel string: The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
Codecs List<string>: Voice codecs to support
Connectivity string: How to connect back to the operator network, e.g. MAPS
E911Type string: How to handle 911 calls
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
Platforms List<string>: What platforms to support
ProvisioningState string: Resource provisioning state.
ServiceLocations List<Pulumi.AzureNative.VoiceServices.Outputs.ServiceRegionPropertiesResponse>: The regions in which to deploy the resources needed for Teams Calling
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"
ApiBridge object: Details of API bridge functionality, if required
AutoGeneratedDomainNameLabelScope string: The scope at which the auto-generated domain name can be re-used
EmergencyDialStrings List<string>: A list of dial strings used for emergency calling.
Identity Pulumi.AzureNative.VoiceServices.Outputs.ManagedServiceIdentityResponse: The managed service identities assigned to this resource.
IntegratedMcpEnabled bool: Whether an integrated Mobile Control Point is in use.
OnPremMcpEnabled bool: Whether an on-premises Mobile Control Point is in use.
Tags Dictionary<string, string>: Resource tags.
TeamsVoicemailPilotNumber string: This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

AutoGeneratedDomainNameLabel string: The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
Codecs []string: Voice codecs to support
Connectivity string: How to connect back to the operator network, e.g. MAPS
E911Type string: How to handle 911 calls
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
Platforms []string: What platforms to support
ProvisioningState string: Resource provisioning state.
ServiceLocations []ServiceRegionPropertiesResponse: The regions in which to deploy the resources needed for Teams Calling
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"
ApiBridge interface{}: Details of API bridge functionality, if required
AutoGeneratedDomainNameLabelScope string: The scope at which the auto-generated domain name can be re-used
EmergencyDialStrings []string: A list of dial strings used for emergency calling.
Identity ManagedServiceIdentityResponse: The managed service identities assigned to this resource.
IntegratedMcpEnabled bool: Whether an integrated Mobile Control Point is in use.
OnPremMcpEnabled bool: Whether an on-premises Mobile Control Point is in use.
Tags map[string]string: Resource tags.
TeamsVoicemailPilotNumber string: This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

autoGeneratedDomainNameLabel String: The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
codecs List<String>: Voice codecs to support
connectivity String: How to connect back to the operator network, e.g. MAPS
e911Type String: How to handle 911 calls
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
platforms List<String>: What platforms to support
provisioningState String: Resource provisioning state.
serviceLocations List<ServiceRegionPropertiesResponse>: The regions in which to deploy the resources needed for Teams Calling
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"
apiBridge Object: Details of API bridge functionality, if required
autoGeneratedDomainNameLabelScope String: The scope at which the auto-generated domain name can be re-used
emergencyDialStrings List<String>: A list of dial strings used for emergency calling.
identity ManagedServiceIdentityResponse: The managed service identities assigned to this resource.
integratedMcpEnabled Boolean: Whether an integrated Mobile Control Point is in use.
onPremMcpEnabled Boolean: Whether an on-premises Mobile Control Point is in use.
tags Map<String,String>: Resource tags.
teamsVoicemailPilotNumber String: This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

autoGeneratedDomainNameLabel string: The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
codecs string[]: Voice codecs to support
connectivity string: How to connect back to the operator network, e.g. MAPS
e911Type string: How to handle 911 calls
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string: The geo-location where the resource lives
name string: The name of the resource
platforms string[]: What platforms to support
provisioningState string: Resource provisioning state.
serviceLocations ServiceRegionPropertiesResponse[]: The regions in which to deploy the resources needed for Teams Calling
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"
apiBridge any: Details of API bridge functionality, if required
autoGeneratedDomainNameLabelScope string: The scope at which the auto-generated domain name can be re-used
emergencyDialStrings string[]: A list of dial strings used for emergency calling.
identity ManagedServiceIdentityResponse: The managed service identities assigned to this resource.
integratedMcpEnabled boolean: Whether an integrated Mobile Control Point is in use.
onPremMcpEnabled boolean: Whether an on-premises Mobile Control Point is in use.
tags {[key: string]: string}: Resource tags.
teamsVoicemailPilotNumber string: This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

auto_generated_domain_name_label str: The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
codecs Sequence[str]: Voice codecs to support
connectivity str: How to connect back to the operator network, e.g. MAPS
e911_type str: How to handle 911 calls
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str: The geo-location where the resource lives
name str: The name of the resource
platforms Sequence[str]: What platforms to support
provisioning_state str: Resource provisioning state.
service_locations Sequence[ServiceRegionPropertiesResponse]: The regions in which to deploy the resources needed for Teams Calling
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"
api_bridge Any: Details of API bridge functionality, if required
auto_generated_domain_name_label_scope str: The scope at which the auto-generated domain name can be re-used
emergency_dial_strings Sequence[str]: A list of dial strings used for emergency calling.
identity ManagedServiceIdentityResponse: The managed service identities assigned to this resource.
integrated_mcp_enabled bool: Whether an integrated Mobile Control Point is in use.
on_prem_mcp_enabled bool: Whether an on-premises Mobile Control Point is in use.
tags Mapping[str, str]: Resource tags.
teams_voicemail_pilot_number str: This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

autoGeneratedDomainNameLabel String: The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
codecs List<String>: Voice codecs to support
connectivity String: How to connect back to the operator network, e.g. MAPS
e911Type String: How to handle 911 calls
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
platforms List<String>: What platforms to support
provisioningState String: Resource provisioning state.
serviceLocations List<Property Map>: The regions in which to deploy the resources needed for Teams Calling
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"
apiBridge Any: Details of API bridge functionality, if required
autoGeneratedDomainNameLabelScope String: The scope at which the auto-generated domain name can be re-used
emergencyDialStrings List<String>: A list of dial strings used for emergency calling.
identity Property Map: The managed service identities assigned to this resource.
integratedMcpEnabled Boolean: Whether an integrated Mobile Control Point is in use.
onPremMcpEnabled Boolean: Whether an on-premises Mobile Control Point is in use.
tags Map<String>: Resource tags.
teamsVoicemailPilotNumber String: This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.

Supporting Types

ManagedServiceIdentityResponse

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.VoiceServices.Inputs.UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principal_id str: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id str: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type str: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrimaryRegionPropertiesResponse

OperatorAddresses List<string>: IP address to use to contact the operator network from this region
AllowedMediaSourceAddressPrefixes List<string>: The allowed source IP address or CIDR ranges for media
AllowedSignalingSourceAddressPrefixes List<string>: The allowed source IP address or CIDR ranges for signaling
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
AllowedMediaSourceAddressPrefixes []string: The allowed source IP address or CIDR ranges for media
AllowedSignalingSourceAddressPrefixes []string: The allowed source IP address or CIDR ranges for signaling
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
allowedMediaSourceAddressPrefixes List<String>: The allowed source IP address or CIDR ranges for media
allowedSignalingSourceAddressPrefixes List<String>: The allowed source IP address or CIDR ranges for signaling
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
allowedMediaSourceAddressPrefixes string[]: The allowed source IP address or CIDR ranges for media
allowedSignalingSourceAddressPrefixes string[]: The allowed source IP address or CIDR ranges for signaling
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
allowed_media_source_address_prefixes Sequence[str]: The allowed source IP address or CIDR ranges for media
allowed_signaling_source_address_prefixes Sequence[str]: 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

operatorAddresses List<String>: IP address to use to contact the operator network from this region
allowedMediaSourceAddressPrefixes List<String>: The allowed source IP address or CIDR ranges for media
allowedSignalingSourceAddressPrefixes List<String>: The allowed source IP address or CIDR ranges for signaling
esrpAddresses List<String>: IP address to use to contact the ESRP from this region

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.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

Package Details

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

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.21.2 published on Friday, Dec 8, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.voiceservices.getCommunicationsGateway

On this page

On this page

Using getCommunicationsGateway

getCommunicationsGateway Result

Supporting Types

ManagedServiceIdentityResponse

PrimaryRegionPropertiesResponse

ServiceRegionPropertiesResponse

SystemDataResponse

UserAssignedIdentityResponse

Package Details

On this page

On this page