@pulumi/azure-native/voiceservices/getCommunicationsGateway.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Get a CommunicationsGateway
 *
 * Uses Azure REST API version 2023-09-01.
 *
 * Other available API versions: 2022-12-01-preview, 2023-01-31, 2023-04-03. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native voiceservices [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getCommunicationsGateway(args: GetCommunicationsGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetCommunicationsGatewayResult>;
export interface GetCommunicationsGatewayArgs {
    /**
     * Unique identifier for this deployment
     */
    communicationsGatewayName: string;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
}
/**
 * A CommunicationsGateway resource
 */
export interface GetCommunicationsGatewayResult {
    /**
     * A list of allocated IP prefixes which may be used to receive media data from this Communications Gateway.
     */
    readonly allocatedMediaAddressPrefixes: string[];
    /**
     * A list of IP allocated prefixes which may be used to receive signaling data from this Communications Gateway.
     */
    readonly allocatedSignalingAddressPrefixes: string[];
    /**
     * Details of API bridge functionality, if required
     */
    readonly apiBridge?: outputs.voiceservices.ApiBridgePropertiesResponse;
    /**
     * The autogenerated label used as part of the FQDNs for accessing the Communications Gateway
     */
    readonly autoGeneratedDomainNameLabel: string;
    /**
     * The scope at which the auto-generated domain name can be re-used
     */
    readonly autoGeneratedDomainNameLabelScope?: string;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * Voice codecs to support
     */
    readonly codecs: string[];
    /**
     * How to connect back to the operator network, e.g. MAPS
     */
    readonly connectivity: string;
    /**
     * Custom SIP Header to add to any subscriber with a custom_header value, if required.
     */
    readonly customSipHeaders?: outputs.voiceservices.CustomSipHeadersPropertiesResponse;
    /**
     * Details of DNS Domains to delegate to the Communications Gateway.
     */
    readonly dnsDelegations?: outputs.voiceservices.DnsDelegationsPropertiesResponse;
    /**
     * How to handle 911 calls
     */
    readonly e911Type: string;
    /**
     * A list of dial strings used for emergency calling.
     */
    readonly emergencyDialStrings?: string[];
    /**
     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
     */
    readonly id: string;
    /**
     * The managed service identities assigned to this resource.
     */
    readonly identity?: outputs.voiceservices.ManagedServiceIdentityResponse;
    /**
     * Whether an integrated Mobile Control Point is in use.
     */
    readonly integratedMcpEnabled?: boolean;
    /**
     * The geo-location where the resource lives
     */
    readonly location: string;
    /**
     * The name of the resource
     */
    readonly name: string;
    /**
     * Whether an on-premises Mobile Control Point is in use.
     */
    readonly onPremMcpEnabled?: boolean;
    /**
     * What platforms to support
     */
    readonly platforms: string[];
    /**
     * Resource provisioning state.
     */
    readonly provisioningState: string;
    /**
     * The regions in which to deploy the resources needed for Teams Calling
     */
    readonly serviceLocations: outputs.voiceservices.ServiceRegionPropertiesResponse[];
    /**
     * The SKU (Stock Keeping Unit) assigned to this resource.
     */
    readonly sku?: outputs.voiceservices.SkuResponse;
    /**
     * The current status of the deployment.
     */
    readonly status: string;
    /**
     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
     */
    readonly systemData: outputs.voiceservices.SystemDataResponse;
    /**
     * Resource tags.
     */
    readonly tags?: {
        [key: string]: string;
    };
    /**
     * This number is used in Teams Phone Mobile scenarios for access to the voicemail IVR from the native dialer.
     */
    readonly teamsVoicemailPilotNumber?: string;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: string;
}
/**
 * Get a CommunicationsGateway
 *
 * Uses Azure REST API version 2023-09-01.
 *
 * Other available API versions: 2022-12-01-preview, 2023-01-31, 2023-04-03. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native voiceservices [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getCommunicationsGatewayOutput(args: GetCommunicationsGatewayOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCommunicationsGatewayResult>;
export interface GetCommunicationsGatewayOutputArgs {
    /**
     * Unique identifier for this deployment
     */
    communicationsGatewayName: pulumi.Input<string>;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
}