1. Packages
  2. Azure Native v2
  3. API Docs
  4. communication
  5. getCommunicationService
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.communication.getCommunicationService

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Get the CommunicationService and its properties. Azure REST API version: 2023-03-31.

Other available API versions: 2023-04-01, 2023-04-01-preview, 2023-06-01-preview.

Using getCommunicationService

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 getCommunicationService(args: GetCommunicationServiceArgs, opts?: InvokeOptions): Promise<GetCommunicationServiceResult>
function getCommunicationServiceOutput(args: GetCommunicationServiceOutputArgs, opts?: InvokeOptions): Output<GetCommunicationServiceResult>
Copy
def get_communication_service(communication_service_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCommunicationServiceResult
def get_communication_service_output(communication_service_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCommunicationServiceResult]
Copy
func LookupCommunicationService(ctx *Context, args *LookupCommunicationServiceArgs, opts ...InvokeOption) (*LookupCommunicationServiceResult, error)
func LookupCommunicationServiceOutput(ctx *Context, args *LookupCommunicationServiceOutputArgs, opts ...InvokeOption) LookupCommunicationServiceResultOutput
Copy

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

public static class GetCommunicationService 
{
    public static Task<GetCommunicationServiceResult> InvokeAsync(GetCommunicationServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetCommunicationServiceResult> Invoke(GetCommunicationServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCommunicationServiceResult> getCommunicationService(GetCommunicationServiceArgs args, InvokeOptions options)
public static Output<GetCommunicationServiceResult> getCommunicationService(GetCommunicationServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:communication:getCommunicationService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CommunicationServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the CommunicationService resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CommunicationServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the CommunicationService resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
communicationServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the CommunicationService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
communicationServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the CommunicationService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
communication_service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the CommunicationService resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
communicationServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the CommunicationService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getCommunicationService Result

The following output properties are available:

DataLocation string
The location where the communication service stores its data at rest.
HostName string
FQDN of the CommunicationService instance.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ImmutableResourceId string
The immutable resource Id of the communication service.
Location string
The geo-location where the resource lives
Name string
The name of the resource
NotificationHubId string
Resource ID of an Azure Notification Hub linked to this resource.
ProvisioningState string
Provisioning state of the resource.
SystemData Pulumi.AzureNative.Communication.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"
Version string
Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
LinkedDomains List<string>
List of email Domain resource Ids.
Tags Dictionary<string, string>
Resource tags.
DataLocation string
The location where the communication service stores its data at rest.
HostName string
FQDN of the CommunicationService instance.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ImmutableResourceId string
The immutable resource Id of the communication service.
Location string
The geo-location where the resource lives
Name string
The name of the resource
NotificationHubId string
Resource ID of an Azure Notification Hub linked to this resource.
ProvisioningState string
Provisioning state of the resource.
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"
Version string
Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
LinkedDomains []string
List of email Domain resource Ids.
Tags map[string]string
Resource tags.
dataLocation String
The location where the communication service stores its data at rest.
hostName String
FQDN of the CommunicationService instance.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
immutableResourceId String
The immutable resource Id of the communication service.
location String
The geo-location where the resource lives
name String
The name of the resource
notificationHubId String
Resource ID of an Azure Notification Hub linked to this resource.
provisioningState String
Provisioning state of the resource.
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"
version String
Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
linkedDomains List<String>
List of email Domain resource Ids.
tags Map<String,String>
Resource tags.
dataLocation string
The location where the communication service stores its data at rest.
hostName string
FQDN of the CommunicationService instance.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
immutableResourceId string
The immutable resource Id of the communication service.
location string
The geo-location where the resource lives
name string
The name of the resource
notificationHubId string
Resource ID of an Azure Notification Hub linked to this resource.
provisioningState string
Provisioning state of the resource.
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"
version string
Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
linkedDomains string[]
List of email Domain resource Ids.
tags {[key: string]: string}
Resource tags.
data_location str
The location where the communication service stores its data at rest.
host_name str
FQDN of the CommunicationService instance.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
immutable_resource_id str
The immutable resource Id of the communication service.
location str
The geo-location where the resource lives
name str
The name of the resource
notification_hub_id str
Resource ID of an Azure Notification Hub linked to this resource.
provisioning_state str
Provisioning state of the resource.
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"
version str
Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
linked_domains Sequence[str]
List of email Domain resource Ids.
tags Mapping[str, str]
Resource tags.
dataLocation String
The location where the communication service stores its data at rest.
hostName String
FQDN of the CommunicationService instance.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
immutableResourceId String
The immutable resource Id of the communication service.
location String
The geo-location where the resource lives
name String
The name of the resource
notificationHubId String
Resource ID of an Azure Notification Hub linked to this resource.
provisioningState String
Provisioning state of the resource.
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"
version String
Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
linkedDomains List<String>
List of email Domain resource Ids.
tags Map<String>
Resource tags.

Supporting Types

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi