Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. communication
  5. Service

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.communication.Service

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Communication Service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.communication.Service("example", {
    name: "example-communicationservice",
    resourceGroupName: example.name,
    dataLocation: "United States",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.communication.Service("example",
    name="example-communicationservice",
    resource_group_name=example.name,
    data_location="United States")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/communication"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = communication.NewService(ctx, "example", &communication.ServiceArgs{
			Name:              pulumi.String("example-communicationservice"),
			ResourceGroupName: example.Name,
			DataLocation:      pulumi.String("United States"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.Communication.Service("example", new()
    {
        Name = "example-communicationservice",
        ResourceGroupName = example.Name,
        DataLocation = "United States",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.communication.Service;
import com.pulumi.azure.communication.ServiceArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-communicationservice")
            .resourceGroupName(example.name())
            .dataLocation("United States")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:communication:Service
    name: example
    properties:
      name: example-communicationservice
      resourceGroupName: ${example.name}
      dataLocation: United States

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            data_location: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: azure:communication:Service
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 ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 azureServiceResource = new Azure.Communication.Service("azureServiceResource", new()
{
    ResourceGroupName = "string",
    DataLocation = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := communication.NewService(ctx, "azureServiceResource", &communication.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	DataLocation:      pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azureServiceResource = new Service("azureServiceResource", ServiceArgs.builder()
    .resourceGroupName("string")
    .dataLocation("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    azure_service_resource = azure.communication.Service("azureServiceResource",
    resource_group_name="string",
    data_location="string",
    name="string",
    tags={
        "string": "string",
    })

    const azureServiceResource = new azure.communication.Service("azureServiceResource", {
    resourceGroupName: "string",
    dataLocation: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:communication:Service
properties:
    dataLocation: string
    name: string
    resourceGroupName: string
    tags:
        string: string

    Service 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 Service resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    DataLocation string
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    Name string
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Communication Service.
    ResourceGroupName string
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    DataLocation string
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    Name string
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Communication Service.
    resourceGroupName String
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    dataLocation String
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name String
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Communication Service.
    resourceGroupName string
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    dataLocation string
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name string
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Communication Service.
    resource_group_name str
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    data_location str
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name str
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Communication Service.
    resourceGroupName String
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    dataLocation String
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name String
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Communication Service.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryConnectionString string
    The primary connection string of the Communication Service.
    PrimaryKey string
    The primary key of the Communication Service.
    SecondaryConnectionString string
    The secondary connection string of the Communication Service.
    SecondaryKey string
    The secondary key of the Communication Service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryConnectionString string
    The primary connection string of the Communication Service.
    PrimaryKey string
    The primary key of the Communication Service.
    SecondaryConnectionString string
    The secondary connection string of the Communication Service.
    SecondaryKey string
    The secondary key of the Communication Service.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryConnectionString String
    The primary connection string of the Communication Service.
    primaryKey String
    The primary key of the Communication Service.
    secondaryConnectionString String
    The secondary connection string of the Communication Service.
    secondaryKey String
    The secondary key of the Communication Service.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryConnectionString string
    The primary connection string of the Communication Service.
    primaryKey string
    The primary key of the Communication Service.
    secondaryConnectionString string
    The secondary connection string of the Communication Service.
    secondaryKey string
    The secondary key of the Communication Service.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_connection_string str
    The primary connection string of the Communication Service.
    primary_key str
    The primary key of the Communication Service.
    secondary_connection_string str
    The secondary connection string of the Communication Service.
    secondary_key str
    The secondary key of the Communication Service.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryConnectionString String
    The primary connection string of the Communication Service.
    primaryKey String
    The primary key of the Communication Service.
    secondaryConnectionString String
    The secondary connection string of the Communication Service.
    secondaryKey String
    The secondary key of the Communication Service.

    Look up Existing Service Resource

    Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_location: Optional[str] = None,
        name: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        primary_key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        secondary_key: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataLocation string
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    Name string
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    PrimaryConnectionString string
    The primary connection string of the Communication Service.
    PrimaryKey string
    The primary key of the Communication Service.
    ResourceGroupName string
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    SecondaryConnectionString string
    The secondary connection string of the Communication Service.
    SecondaryKey string
    The secondary key of the Communication Service.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Communication Service.
    DataLocation string
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    Name string
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    PrimaryConnectionString string
    The primary connection string of the Communication Service.
    PrimaryKey string
    The primary key of the Communication Service.
    ResourceGroupName string
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    SecondaryConnectionString string
    The secondary connection string of the Communication Service.
    SecondaryKey string
    The secondary key of the Communication Service.
    Tags map[string]string
    A mapping of tags which should be assigned to the Communication Service.
    dataLocation String
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name String
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    primaryConnectionString String
    The primary connection string of the Communication Service.
    primaryKey String
    The primary key of the Communication Service.
    resourceGroupName String
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    secondaryConnectionString String
    The secondary connection string of the Communication Service.
    secondaryKey String
    The secondary key of the Communication Service.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Communication Service.
    dataLocation string
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name string
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    primaryConnectionString string
    The primary connection string of the Communication Service.
    primaryKey string
    The primary key of the Communication Service.
    resourceGroupName string
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    secondaryConnectionString string
    The secondary connection string of the Communication Service.
    secondaryKey string
    The secondary key of the Communication Service.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Communication Service.
    data_location str
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name str
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    primary_connection_string str
    The primary connection string of the Communication Service.
    primary_key str
    The primary key of the Communication Service.
    resource_group_name str
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    secondary_connection_string str
    The secondary connection string of the Communication Service.
    secondary_key str
    The secondary key of the Communication Service.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Communication Service.
    dataLocation String
    The location where the Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK, usgov and United States. Defaults to United States. Changing this forces a new Communication Service to be created.
    name String
    The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
    primaryConnectionString String
    The primary connection string of the Communication Service.
    primaryKey String
    The primary key of the Communication Service.
    resourceGroupName String
    The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
    secondaryConnectionString String
    The secondary connection string of the Communication Service.
    secondaryKey String
    The secondary key of the Communication Service.
    tags Map<String>
    A mapping of tags which should be assigned to the Communication Service.

    Import

    Communication Services can be imported using the resource id, e.g.

    $ pulumi import azure:communication/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Communication/communicationServices/communicationService1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure