Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. communication
  5. CommunicationService
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.communication.CommunicationService

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

A class representing a CommunicationService resource. API Version: 2020-08-20.

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",
    });

});
Copy
package main

import (
	communication "github.com/pulumi/pulumi-azure-native-sdk/communication"
	"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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
resources:
  communicationService:
    type: azure-native:communication:CommunicationService
    properties:
      communicationServiceName: MyCommunicationResource
      dataLocation: United States
      location: Global
      resourceGroupName: MyResourceGroup
Copy

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,
                         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 This property is required. string
The unique name of the resource.
args This property is required. CommunicationServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. CommunicationServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CommunicationServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := communication.NewCommunicationService(ctx, "communicationServiceResource", &communication.CommunicationServiceArgs{
	DataLocation:             "string",
	ResourceGroupName:        "string",
	CommunicationServiceName: "string",
	Location:                 "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var communicationServiceResource = new CommunicationService("communicationServiceResource", CommunicationServiceArgs.builder()
    .dataLocation("string")
    .resourceGroupName("string")
    .communicationServiceName("string")
    .location("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
communication_service_resource = azure_native.communication.CommunicationService("communicationServiceResource",
    data_location=string,
    resource_group_name=string,
    communication_service_name=string,
    location=string,
    tags={
        string: string,
    })
Copy
const communicationServiceResource = new azure_native.communication.CommunicationService("communicationServiceResource", {
    dataLocation: "string",
    resourceGroupName: "string",
    communicationServiceName: "string",
    location: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:communication:CommunicationService
properties:
    communicationServiceName: string
    dataLocation: string
    location: string
    resourceGroupName: string
    tags:
        string: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
The location where the communication service stores its data at rest.
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 Changes to this property will trigger replacement. string
The name of the CommunicationService resource.
Location Changes to this property will trigger replacement. string
The Azure location where the CommunicationService is running.
Tags Dictionary<string, string>
Tags of the service which is a list of key value pairs that describe the resource.
DataLocation
This property is required.
Changes to this property will trigger replacement.
string
The location where the communication service stores its data at rest.
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 Changes to this property will trigger replacement. string
The name of the CommunicationService resource.
Location Changes to this property will trigger replacement. string
The Azure location where the CommunicationService is running.
Tags map[string]string
Tags of the service which is a list of key value pairs that describe the resource.
dataLocation
This property is required.
Changes to this property will trigger replacement.
String
The location where the communication service stores its data at rest.
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 Changes to this property will trigger replacement. String
The name of the CommunicationService resource.
location Changes to this property will trigger replacement. String
The Azure location where the CommunicationService is running.
tags Map<String,String>
Tags of the service which is a list of key value pairs that describe the resource.
dataLocation
This property is required.
Changes to this property will trigger replacement.
string
The location where the communication service stores its data at rest.
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 Changes to this property will trigger replacement. string
The name of the CommunicationService resource.
location Changes to this property will trigger replacement. string
The Azure location where the CommunicationService is running.
tags {[key: string]: string}
Tags of the service which is a list of key value pairs that describe the resource.
data_location
This property is required.
Changes to this property will trigger replacement.
str
The location where the communication service stores its data at rest.
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.
communication_service_name Changes to this property will trigger replacement. str
The name of the CommunicationService resource.
location Changes to this property will trigger replacement. str
The Azure location where the CommunicationService is running.
tags Mapping[str, str]
Tags of the service which is a list of key value pairs that describe the resource.
dataLocation
This property is required.
Changes to this property will trigger replacement.
String
The location where the communication service stores its data at rest.
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 Changes to this property will trigger replacement. String
The name of the CommunicationService resource.
location Changes to this property will trigger replacement. String
The Azure location where the CommunicationService is running.
tags Map<String>
Tags of the service which is a list of key value pairs that describe the resource.

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.
ImmutableResourceId string
The immutable resource Id of the communication service.
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
Metadata pertaining to creation and last modification of the resource.
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.
ImmutableResourceId string
The immutable resource Id of the communication service.
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
Metadata pertaining to creation and last modification of the resource.
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.
immutableResourceId String
The immutable resource Id of the communication service.
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
Metadata pertaining to creation and last modification of the resource.
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.
immutableResourceId string
The immutable resource Id of the communication service.
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
Metadata pertaining to creation and last modification of the resource.
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_id str
The immutable resource Id of the communication service.
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
Metadata pertaining to creation and last modification of the resource.
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.
immutableResourceId String
The immutable resource Id of the communication service.
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
Metadata pertaining to creation and last modification of the resource.
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.
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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:communication:CommunicationService MyCommunicationResource /subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native