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.
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
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",
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:
- Data
Location This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the resource group. The name is case insensitive.
- Communication
Service Name Changes to this property will trigger replacement.
- The name of the CommunicationService resource.
- Linked
Domains List<string> - List of email Domain resource Ids.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Data
Location This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the resource group. The name is case insensitive.
- Communication
Service Name Changes to this property will trigger replacement.
- The name of the CommunicationService resource.
- Linked
Domains []string - List of email Domain resource Ids.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- data
Location This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the resource group. The name is case insensitive.
- communication
Service Name Changes to this property will trigger replacement.
- The name of the CommunicationService resource.
- linked
Domains List<String> - List of email Domain resource Ids.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- data
Location This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the resource group. The name is case insensitive.
- communication
Service Name Changes to this property will trigger replacement.
- The name of the CommunicationService resource.
- linked
Domains string[] - List of email Domain resource Ids.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- data_
location This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the resource group. The name is case insensitive.
- communication_
service_ name Changes to this property will trigger replacement.
- The name of the CommunicationService resource.
- linked_
domains Sequence[str] - List of email Domain resource Ids.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- data
Location This property is required. Changes to this property will trigger replacement.
- 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.
- The name of the resource group. The name is case insensitive.
- communication
Service Name Changes to this property will trigger replacement.
- The name of the CommunicationService resource.
- linked
Domains List<String> - List of email Domain resource Ids.
- location
Changes to this property will trigger replacement.
- 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:
- Host
Name string - FQDN of the CommunicationService instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable
Resource stringId - The immutable resource Id of the communication service.
- Name string
- The name of the resource
- Notification
Hub stringId - Resource ID of an Azure Notification Hub linked to this resource.
- Provisioning
State string - Provisioning state of the resource.
- System
Data 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.
- Host
Name string - FQDN of the CommunicationService instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable
Resource stringId - The immutable resource Id of the communication service.
- Name string
- The name of the resource
- Notification
Hub stringId - Resource ID of an Azure Notification Hub linked to this resource.
- Provisioning
State string - Provisioning state of the resource.
- System
Data 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 String - FQDN of the CommunicationService instance.
- id String
- The provider-assigned unique ID for this managed resource.
- immutable
Resource StringId - The immutable resource Id of the communication service.
- name String
- The name of the resource
- notification
Hub StringId - Resource ID of an Azure Notification Hub linked to this resource.
- provisioning
State String - Provisioning state of the resource.
- system
Data 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 string - FQDN of the CommunicationService instance.
- id string
- The provider-assigned unique ID for this managed resource.
- immutable
Resource stringId - The immutable resource Id of the communication service.
- name string
- The name of the resource
- notification
Hub stringId - Resource ID of an Azure Notification Hub linked to this resource.
- provisioning
State string - Provisioning state of the resource.
- system
Data 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.
- host
Name String - FQDN of the CommunicationService instance.
- id String
- The provider-assigned unique ID for this managed resource.
- immutable
Resource StringId - The immutable resource Id of the communication service.
- name String
- The name of the resource
- notification
Hub StringId - Resource ID of an Azure Notification Hub linked to this resource.
- provisioning
State String - Provisioning state of the resource.
- system
Data 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified 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.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified 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