Documentation
¶
Index ¶
- type Service
- type ServiceArgs
- type ServiceArray
- type ServiceArrayInput
- type ServiceArrayOutput
- type ServiceInput
- type ServiceMap
- type ServiceMapInput
- type ServiceMapOutput
- type ServiceOutput
- func (o ServiceOutput) DataLocation() pulumi.StringPtrOutput
- func (ServiceOutput) ElementType() reflect.Type
- func (o ServiceOutput) Name() pulumi.StringOutput
- func (o ServiceOutput) PrimaryConnectionString() pulumi.StringOutput
- func (o ServiceOutput) PrimaryKey() pulumi.StringOutput
- func (o ServiceOutput) ResourceGroupName() pulumi.StringOutput
- func (o ServiceOutput) SecondaryConnectionString() pulumi.StringOutput
- func (o ServiceOutput) SecondaryKey() pulumi.StringOutput
- func (o ServiceOutput) Tags() pulumi.StringMapOutput
- func (o ServiceOutput) ToServiceOutput() ServiceOutput
- func (o ServiceOutput) ToServiceOutputWithContext(ctx context.Context) ServiceOutput
- type ServiceState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Service ¶
type Service struct { pulumi.CustomResourceState // 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` and `United States`. Defaults to `United States`. DataLocation pulumi.StringPtrOutput `pulumi:"dataLocation"` // The name of the Communication Service resource. Changing this forces a new Communication Service to be created. Name pulumi.StringOutput `pulumi:"name"` // The primary connection string of the Communication Service. PrimaryConnectionString pulumi.StringOutput `pulumi:"primaryConnectionString"` // The primary key of the Communication Service. PrimaryKey pulumi.StringOutput `pulumi:"primaryKey"` // The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The secondary connection string of the Communication Service. SecondaryConnectionString pulumi.StringOutput `pulumi:"secondaryConnectionString"` // The secondary key of the Communication Service. SecondaryKey pulumi.StringOutput `pulumi:"secondaryKey"` // A mapping of tags which should be assigned to the Communication Service. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Manages a Communication Service.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/communication" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } _, err = communication.NewService(ctx, "exampleService", &communication.ServiceArgs{ ResourceGroupName: exampleResourceGroup.Name, DataLocation: pulumi.String("United States"), }) if err != nil { return err } return nil }) }
```
## Import
Communication Services can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:communication/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Communication/communicationServices/communicationService1
```
func GetService ¶
func GetService(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServiceState, opts ...pulumi.ResourceOption) (*Service, error)
GetService gets an existing Service resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewService ¶
func NewService(ctx *pulumi.Context, name string, args *ServiceArgs, opts ...pulumi.ResourceOption) (*Service, error)
NewService registers a new resource with the given unique name, arguments, and options.
func (*Service) ElementType ¶
func (*Service) ToServiceOutput ¶
func (i *Service) ToServiceOutput() ServiceOutput
func (*Service) ToServiceOutputWithContext ¶
func (i *Service) ToServiceOutputWithContext(ctx context.Context) ServiceOutput
type ServiceArgs ¶
type ServiceArgs struct { // 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` and `United States`. Defaults to `United States`. DataLocation pulumi.StringPtrInput // The name of the Communication Service resource. Changing this forces a new Communication Service to be created. Name pulumi.StringPtrInput // The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created. ResourceGroupName pulumi.StringInput // A mapping of tags which should be assigned to the Communication Service. Tags pulumi.StringMapInput }
The set of arguments for constructing a Service resource.
func (ServiceArgs) ElementType ¶
func (ServiceArgs) ElementType() reflect.Type
type ServiceArray ¶
type ServiceArray []ServiceInput
func (ServiceArray) ElementType ¶
func (ServiceArray) ElementType() reflect.Type
func (ServiceArray) ToServiceArrayOutput ¶
func (i ServiceArray) ToServiceArrayOutput() ServiceArrayOutput
func (ServiceArray) ToServiceArrayOutputWithContext ¶
func (i ServiceArray) ToServiceArrayOutputWithContext(ctx context.Context) ServiceArrayOutput
type ServiceArrayInput ¶
type ServiceArrayInput interface { pulumi.Input ToServiceArrayOutput() ServiceArrayOutput ToServiceArrayOutputWithContext(context.Context) ServiceArrayOutput }
ServiceArrayInput is an input type that accepts ServiceArray and ServiceArrayOutput values. You can construct a concrete instance of `ServiceArrayInput` via:
ServiceArray{ ServiceArgs{...} }
type ServiceArrayOutput ¶
type ServiceArrayOutput struct{ *pulumi.OutputState }
func (ServiceArrayOutput) ElementType ¶
func (ServiceArrayOutput) ElementType() reflect.Type
func (ServiceArrayOutput) Index ¶
func (o ServiceArrayOutput) Index(i pulumi.IntInput) ServiceOutput
func (ServiceArrayOutput) ToServiceArrayOutput ¶
func (o ServiceArrayOutput) ToServiceArrayOutput() ServiceArrayOutput
func (ServiceArrayOutput) ToServiceArrayOutputWithContext ¶
func (o ServiceArrayOutput) ToServiceArrayOutputWithContext(ctx context.Context) ServiceArrayOutput
type ServiceInput ¶
type ServiceInput interface { pulumi.Input ToServiceOutput() ServiceOutput ToServiceOutputWithContext(ctx context.Context) ServiceOutput }
type ServiceMap ¶
type ServiceMap map[string]ServiceInput
func (ServiceMap) ElementType ¶
func (ServiceMap) ElementType() reflect.Type
func (ServiceMap) ToServiceMapOutput ¶
func (i ServiceMap) ToServiceMapOutput() ServiceMapOutput
func (ServiceMap) ToServiceMapOutputWithContext ¶
func (i ServiceMap) ToServiceMapOutputWithContext(ctx context.Context) ServiceMapOutput
type ServiceMapInput ¶
type ServiceMapInput interface { pulumi.Input ToServiceMapOutput() ServiceMapOutput ToServiceMapOutputWithContext(context.Context) ServiceMapOutput }
ServiceMapInput is an input type that accepts ServiceMap and ServiceMapOutput values. You can construct a concrete instance of `ServiceMapInput` via:
ServiceMap{ "key": ServiceArgs{...} }
type ServiceMapOutput ¶
type ServiceMapOutput struct{ *pulumi.OutputState }
func (ServiceMapOutput) ElementType ¶
func (ServiceMapOutput) ElementType() reflect.Type
func (ServiceMapOutput) MapIndex ¶
func (o ServiceMapOutput) MapIndex(k pulumi.StringInput) ServiceOutput
func (ServiceMapOutput) ToServiceMapOutput ¶
func (o ServiceMapOutput) ToServiceMapOutput() ServiceMapOutput
func (ServiceMapOutput) ToServiceMapOutputWithContext ¶
func (o ServiceMapOutput) ToServiceMapOutputWithContext(ctx context.Context) ServiceMapOutput
type ServiceOutput ¶
type ServiceOutput struct{ *pulumi.OutputState }
func (ServiceOutput) DataLocation ¶ added in v5.5.0
func (o ServiceOutput) DataLocation() pulumi.StringPtrOutput
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` and `United States`. Defaults to `United States`.
func (ServiceOutput) ElementType ¶
func (ServiceOutput) ElementType() reflect.Type
func (ServiceOutput) Name ¶ added in v5.5.0
func (o ServiceOutput) Name() pulumi.StringOutput
The name of the Communication Service resource. Changing this forces a new Communication Service to be created.
func (ServiceOutput) PrimaryConnectionString ¶ added in v5.5.0
func (o ServiceOutput) PrimaryConnectionString() pulumi.StringOutput
The primary connection string of the Communication Service.
func (ServiceOutput) PrimaryKey ¶ added in v5.5.0
func (o ServiceOutput) PrimaryKey() pulumi.StringOutput
The primary key of the Communication Service.
func (ServiceOutput) ResourceGroupName ¶ added in v5.5.0
func (o ServiceOutput) ResourceGroupName() pulumi.StringOutput
The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created.
func (ServiceOutput) SecondaryConnectionString ¶ added in v5.5.0
func (o ServiceOutput) SecondaryConnectionString() pulumi.StringOutput
The secondary connection string of the Communication Service.
func (ServiceOutput) SecondaryKey ¶ added in v5.5.0
func (o ServiceOutput) SecondaryKey() pulumi.StringOutput
The secondary key of the Communication Service.
func (ServiceOutput) Tags ¶ added in v5.5.0
func (o ServiceOutput) Tags() pulumi.StringMapOutput
A mapping of tags which should be assigned to the Communication Service.
func (ServiceOutput) ToServiceOutput ¶
func (o ServiceOutput) ToServiceOutput() ServiceOutput
func (ServiceOutput) ToServiceOutputWithContext ¶
func (o ServiceOutput) ToServiceOutputWithContext(ctx context.Context) ServiceOutput
type ServiceState ¶
type ServiceState struct { // 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` and `United States`. Defaults to `United States`. DataLocation pulumi.StringPtrInput // The name of the Communication Service resource. Changing this forces a new Communication Service to be created. Name pulumi.StringPtrInput // The primary connection string of the Communication Service. PrimaryConnectionString pulumi.StringPtrInput // The primary key of the Communication Service. PrimaryKey pulumi.StringPtrInput // The name of the Resource Group where the Communication Service should exist. Changing this forces a new Communication Service to be created. ResourceGroupName pulumi.StringPtrInput // The secondary connection string of the Communication Service. SecondaryConnectionString pulumi.StringPtrInput // The secondary key of the Communication Service. SecondaryKey pulumi.StringPtrInput // A mapping of tags which should be assigned to the Communication Service. Tags pulumi.StringMapInput }
func (ServiceState) ElementType ¶
func (ServiceState) ElementType() reflect.Type