azure-native.communication.CommunicationService
Explore with Pulumi AI
A class representing a CommunicationService resource.
Uses Azure REST API version 2023-03-31. In version 1.x of the Azure Native provider, it used API version 2020-08-20.
Other available API versions: 2023-04-01, 2023-04-01-preview, 2023-06-01-preview, 2024-09-01-preview.
Example Usage
Create or update resource
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var communicationService = new AzureNative.Communication.CommunicationService("communicationService", new()
    {
        CommunicationServiceName = "MyCommunicationResource",
        DataLocation = "United States",
        Location = "Global",
        ResourceGroupName = "MyResourceGroup",
    });
});
package main
import (
	communication "github.com/pulumi/pulumi-azure-native-sdk/communication/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := communication.NewCommunicationService(ctx, "communicationService", &communication.CommunicationServiceArgs{
			CommunicationServiceName: pulumi.String("MyCommunicationResource"),
			DataLocation:             pulumi.String("United States"),
			Location:                 pulumi.String("Global"),
			ResourceGroupName:        pulumi.String("MyResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.communication.CommunicationService;
import com.pulumi.azurenative.communication.CommunicationServiceArgs;
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 communicationService = new CommunicationService("communicationService", CommunicationServiceArgs.builder()
            .communicationServiceName("MyCommunicationResource")
            .dataLocation("United States")
            .location("Global")
            .resourceGroupName("MyResourceGroup")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const communicationService = new azure_native.communication.CommunicationService("communicationService", {
    communicationServiceName: "MyCommunicationResource",
    dataLocation: "United States",
    location: "Global",
    resourceGroupName: "MyResourceGroup",
});
import pulumi
import pulumi_azure_native as azure_native
communication_service = azure_native.communication.CommunicationService("communicationService",
    communication_service_name="MyCommunicationResource",
    data_location="United States",
    location="Global",
    resource_group_name="MyResourceGroup")
resources:
  communicationService:
    type: azure-native:communication:CommunicationService
    properties:
      communicationServiceName: MyCommunicationResource
      dataLocation: United States
      location: Global
      resourceGroupName: MyResourceGroup
Create CommunicationService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CommunicationService(name: string, args: CommunicationServiceArgs, opts?: CustomResourceOptions);@overload
def CommunicationService(resource_name: str,
                         args: CommunicationServiceArgs,
                         opts: Optional[ResourceOptions] = None)
@overload
def CommunicationService(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         data_location: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         communication_service_name: Optional[str] = None,
                         linked_domains: Optional[Sequence[str]] = None,
                         location: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)func NewCommunicationService(ctx *Context, name string, args CommunicationServiceArgs, opts ...ResourceOption) (*CommunicationService, error)public CommunicationService(string name, CommunicationServiceArgs args, CustomResourceOptions? opts = null)
public CommunicationService(String name, CommunicationServiceArgs args)
public CommunicationService(String name, CommunicationServiceArgs args, CustomResourceOptions options)
type: azure-native:communication:CommunicationService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CommunicationServiceArgs
- 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 CommunicationServiceArgs
- 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 CommunicationServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CommunicationServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CommunicationServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var communicationServiceResource = new AzureNative.Communication.CommunicationService("communicationServiceResource", new()
{
    DataLocation = "string",
    ResourceGroupName = "string",
    CommunicationServiceName = "string",
    LinkedDomains = new[]
    {
        "string",
    },
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
example, err := communication.NewCommunicationService(ctx, "communicationServiceResource", &communication.CommunicationServiceArgs{
	DataLocation:             pulumi.String("string"),
	ResourceGroupName:        pulumi.String("string"),
	CommunicationServiceName: pulumi.String("string"),
	LinkedDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var communicationServiceResource = new CommunicationService("communicationServiceResource", CommunicationServiceArgs.builder()
    .dataLocation("string")
    .resourceGroupName("string")
    .communicationServiceName("string")
    .linkedDomains("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .build());
communication_service_resource = azure_native.communication.CommunicationService("communicationServiceResource",
    data_location="string",
    resource_group_name="string",
    communication_service_name="string",
    linked_domains=["string"],
    location="string",
    tags={
        "string": "string",
    })
const communicationServiceResource = new azure_native.communication.CommunicationService("communicationServiceResource", {
    dataLocation: "string",
    resourceGroupName: "string",
    communicationServiceName: "string",
    linkedDomains: ["string"],
    location: "string",
    tags: {
        string: "string",
    },
});
type: azure-native:communication:CommunicationService
properties:
    communicationServiceName: string
    dataLocation: string
    linkedDomains:
        - string
    location: string
    resourceGroupName: string
    tags:
        string: string
CommunicationService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CommunicationService resource accepts the following input properties:
- DataLocation string
- The location where the communication service stores its data at rest.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- CommunicationService stringName 
- The name of the CommunicationService resource.
- LinkedDomains List<string>
- List of email Domain resource Ids.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- DataLocation string
- The location where the communication service stores its data at rest.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- CommunicationService stringName 
- The name of the CommunicationService resource.
- LinkedDomains []string
- List of email Domain resource Ids.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- dataLocation String
- The location where the communication service stores its data at rest.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- communicationService StringName 
- The name of the CommunicationService resource.
- linkedDomains List<String>
- List of email Domain resource Ids.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- dataLocation string
- The location where the communication service stores its data at rest.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- communicationService stringName 
- The name of the CommunicationService resource.
- linkedDomains string[]
- List of email Domain resource Ids.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- data_location str
- The location where the communication service stores its data at rest.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- communication_service_ strname 
- The name of the CommunicationService resource.
- linked_domains Sequence[str]
- List of email Domain resource Ids.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- dataLocation String
- The location where the communication service stores its data at rest.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- communicationService StringName 
- The name of the CommunicationService resource.
- linkedDomains List<String>
- List of email Domain resource Ids.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the CommunicationService resource produces the following output properties:
- HostName string
- FQDN of the CommunicationService instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- ImmutableResource stringId 
- The immutable resource Id of the communication service.
- Name string
- The name of the resource
- NotificationHub stringId 
- Resource ID of an Azure Notification Hub linked to this resource.
- ProvisioningState string
- Provisioning state of the resource.
- SystemData Pulumi.Azure Native. Communication. 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"
- Version string
- Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
- HostName string
- FQDN of the CommunicationService instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- ImmutableResource stringId 
- The immutable resource Id of the communication service.
- Name string
- The name of the resource
- NotificationHub stringId 
- Resource ID of an Azure Notification Hub linked to this resource.
- ProvisioningState string
- Provisioning state of the resource.
- SystemData 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"
- Version string
- Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
- hostName String
- FQDN of the CommunicationService instance.
- id String
- The provider-assigned unique ID for this managed resource.
- immutableResource StringId 
- The immutable resource Id of the communication service.
- name String
- The name of the resource
- notificationHub StringId 
- Resource ID of an Azure Notification Hub linked to this resource.
- provisioningState String
- Provisioning state of the resource.
- systemData 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"
- version String
- Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
- hostName string
- FQDN of the CommunicationService instance.
- id string
- The provider-assigned unique ID for this managed resource.
- immutableResource stringId 
- The immutable resource Id of the communication service.
- name string
- The name of the resource
- notificationHub stringId 
- Resource ID of an Azure Notification Hub linked to this resource.
- provisioningState string
- Provisioning state of the resource.
- systemData 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"
- version string
- Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
- host_name str
- FQDN of the CommunicationService instance.
- id str
- The provider-assigned unique ID for this managed resource.
- immutable_resource_ strid 
- The immutable resource Id of the communication service.
- name str
- The name of the resource
- notification_hub_ strid 
- Resource ID of an Azure Notification Hub linked to this resource.
- provisioning_state str
- Provisioning state of the resource.
- 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"
- version str
- Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
- hostName String
- FQDN of the CommunicationService instance.
- id String
- The provider-assigned unique ID for this managed resource.
- immutableResource StringId 
- The immutable resource Id of the communication service.
- name String
- The name of the resource
- notificationHub StringId 
- 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.
Supporting Types
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified 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.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:communication:CommunicationService MyCommunicationResource /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0