azure-native.voiceservices.getCommunicationsGateway
Explore with Pulumi AI
Get a CommunicationsGateway Azure REST API version: 2023-04-03.
Other available API versions: 2023-09-01.
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:
- Communications
Gateway stringName Unique identifier for this deployment
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Communications
Gateway stringName Unique identifier for this deployment
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- communications
Gateway StringName Unique identifier for this deployment
- resource
Group StringName The name of the resource group. The name is case insensitive.
- communications
Gateway stringName Unique identifier for this deployment
- resource
Group stringName The name of the resource group. The name is case insensitive.
- communications_
gateway_ strname Unique identifier for this deployment
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- communications
Gateway StringName Unique identifier for this deployment
- resource
Group StringName The name of the resource group. The name is case insensitive.
getCommunicationsGateway Result
The following output properties are available:
- Auto
Generated stringDomain Name Label 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
- Provisioning
State string Resource provisioning state.
- Service
Locations List<Pulumi.Azure Native. Voice Services. Outputs. Service Region Properties Response> The regions in which to deploy the resources needed for Teams Calling
- Status string
The current status of the deployment.
- System
Data Pulumi.Azure Native. Voice Services. Outputs. System Data Response 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"
- Api
Bridge object Details of API bridge functionality, if required
- Auto
Generated stringDomain Name Label Scope The scope at which the auto-generated domain name can be re-used
- Emergency
Dial List<string>Strings A list of dial strings used for emergency calling.
- Identity
Pulumi.
Azure Native. Voice Services. Outputs. Managed Service Identity Response The managed service identities assigned to this resource.
- Integrated
Mcp boolEnabled Whether an integrated Mobile Control Point is in use.
- On
Prem boolMcp Enabled Whether an on-premises Mobile Control Point is in use.
- Dictionary<string, string>
Resource tags.
- Teams
Voicemail stringPilot Number This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- Auto
Generated stringDomain Name Label 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
- Provisioning
State string Resource provisioning state.
- Service
Locations []ServiceRegion Properties Response The regions in which to deploy the resources needed for Teams Calling
- Status string
The current status of the deployment.
- System
Data SystemData Response 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"
- Api
Bridge interface{} Details of API bridge functionality, if required
- Auto
Generated stringDomain Name Label Scope The scope at which the auto-generated domain name can be re-used
- Emergency
Dial []stringStrings A list of dial strings used for emergency calling.
- Identity
Managed
Service Identity Response The managed service identities assigned to this resource.
- Integrated
Mcp boolEnabled Whether an integrated Mobile Control Point is in use.
- On
Prem boolMcp Enabled Whether an on-premises Mobile Control Point is in use.
- map[string]string
Resource tags.
- Teams
Voicemail stringPilot Number This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- auto
Generated StringDomain Name Label 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
- provisioning
State String Resource provisioning state.
- service
Locations List<ServiceRegion Properties Response> The regions in which to deploy the resources needed for Teams Calling
- status String
The current status of the deployment.
- system
Data SystemData Response 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"
- api
Bridge Object Details of API bridge functionality, if required
- auto
Generated StringDomain Name Label Scope The scope at which the auto-generated domain name can be re-used
- emergency
Dial List<String>Strings A list of dial strings used for emergency calling.
- identity
Managed
Service Identity Response The managed service identities assigned to this resource.
- integrated
Mcp BooleanEnabled Whether an integrated Mobile Control Point is in use.
- on
Prem BooleanMcp Enabled Whether an on-premises Mobile Control Point is in use.
- Map<String,String>
Resource tags.
- teams
Voicemail StringPilot Number This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- auto
Generated stringDomain Name Label 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
- provisioning
State string Resource provisioning state.
- service
Locations ServiceRegion Properties Response[] The regions in which to deploy the resources needed for Teams Calling
- status string
The current status of the deployment.
- system
Data SystemData Response 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"
- api
Bridge any Details of API bridge functionality, if required
- auto
Generated stringDomain Name Label Scope The scope at which the auto-generated domain name can be re-used
- emergency
Dial string[]Strings A list of dial strings used for emergency calling.
- identity
Managed
Service Identity Response The managed service identities assigned to this resource.
- integrated
Mcp booleanEnabled Whether an integrated Mobile Control Point is in use.
- on
Prem booleanMcp Enabled Whether an on-premises Mobile Control Point is in use.
- {[key: string]: string}
Resource tags.
- teams
Voicemail stringPilot Number This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- auto_
generated_ strdomain_ name_ label 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[ServiceRegion Properties Response] The regions in which to deploy the resources needed for Teams Calling
- status str
The current status of the deployment.
- system_
data SystemData Response 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_ strdomain_ name_ label_ scope The scope at which the auto-generated domain name can be re-used
- emergency_
dial_ Sequence[str]strings A list of dial strings used for emergency calling.
- identity
Managed
Service Identity Response The managed service identities assigned to this resource.
- integrated_
mcp_ boolenabled Whether an integrated Mobile Control Point is in use.
- on_
prem_ boolmcp_ enabled Whether an on-premises Mobile Control Point is in use.
- Mapping[str, str]
Resource tags.
- teams_
voicemail_ strpilot_ number This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
- auto
Generated StringDomain Name Label 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
- provisioning
State String Resource provisioning state.
- service
Locations List<Property Map> The regions in which to deploy the resources needed for Teams Calling
- status String
The current status of the deployment.
- system
Data 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"
- api
Bridge Any Details of API bridge functionality, if required
- auto
Generated StringDomain Name Label Scope The scope at which the auto-generated domain name can be re-used
- emergency
Dial List<String>Strings A list of dial strings used for emergency calling.
- identity Property Map
The managed service identities assigned to this resource.
- integrated
Mcp BooleanEnabled Whether an integrated Mobile Control Point is in use.
- on
Prem BooleanMcp Enabled Whether an on-premises Mobile Control Point is in use.
- Map<String>
Resource tags.
- teams
Voicemail StringPilot Number This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
Supporting Types
ManagedServiceIdentityResponse
- Principal
Id string The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id 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).
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Voice Services. Inputs. User Assigned Identity Response> 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 string The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id 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).
- User
Assigned map[string]UserIdentities Assigned Identity Response 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 String The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id 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).
- user
Assigned Map<String,UserIdentities Assigned Identity Response> 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 string The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id 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).
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} 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_ Mapping[str, Useridentities Assigned Identity Response] 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 String The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id 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).
- user
Assigned Map<Property Map>Identities 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
- Operator
Addresses List<string> IP address to use to contact the operator network from this region
- Allowed
Media List<string>Source Address Prefixes The allowed source IP address or CIDR ranges for media
- Allowed
Signaling List<string>Source Address Prefixes 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
- Operator
Addresses []string IP address to use to contact the operator network from this region
- Allowed
Media []stringSource Address Prefixes The allowed source IP address or CIDR ranges for media
- Allowed
Signaling []stringSource Address Prefixes The allowed source IP address or CIDR ranges for signaling
- Esrp
Addresses []string IP address to use to contact the ESRP from this region
- operator
Addresses List<String> IP address to use to contact the operator network from this region
- allowed
Media List<String>Source Address Prefixes The allowed source IP address or CIDR ranges for media
- allowed
Signaling List<String>Source Address Prefixes 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
- operator
Addresses string[] IP address to use to contact the operator network from this region
- allowed
Media string[]Source Address Prefixes The allowed source IP address or CIDR ranges for media
- allowed
Signaling string[]Source Address Prefixes The allowed source IP address or CIDR ranges for signaling
- esrp
Addresses 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_ Sequence[str]source_ address_ prefixes The allowed source IP address or CIDR ranges for media
- allowed_
signaling_ Sequence[str]source_ address_ prefixes 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
- operator
Addresses List<String> IP address to use to contact the operator network from this region
- allowed
Media List<String>Source Address Prefixes The allowed source IP address or CIDR ranges for media
- allowed
Signaling List<String>Source Address Prefixes 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
ServiceRegionPropertiesResponse
- Name string
The name of the region in which the resources needed for Teams Calling will be deployed.
- Primary
Region Pulumi.Properties Azure Native. Voice Services. Inputs. Primary Region Properties Response 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.
- Primary
Region PrimaryProperties Region Properties Response 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.
- primary
Region PrimaryProperties Region Properties Response 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.
- primary
Region PrimaryProperties Region Properties Response 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_ Primaryproperties Region Properties Response 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.
- primary
Region Property MapProperties The configuration used in this region as primary, and other regions as backup.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
UserAssignedIdentityResponse
- Client
Id string The client ID of the assigned identity.
- Principal
Id string The principal ID of the assigned identity.
- Client
Id string The client ID of the assigned identity.
- Principal
Id string The principal ID of the assigned identity.
- client
Id String The client ID of the assigned identity.
- principal
Id String The principal ID of the assigned identity.
- client
Id string The client ID of the assigned identity.
- principal
Id 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.
- client
Id String The client ID of the assigned identity.
- principal
Id String The principal ID of the assigned identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0