Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. SmsSign
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.SmsSign

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a sms sign

    Example Usage

    Create a sms sign instance

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

const example = new tencentcloud.SmsSign("example", {
    documentType: 4,
    international: 0,
    proofImage: "your_proof_image",
    signName: "tf_example_sms_sign",
    signPurpose: 0,
    signType: 1,
});
// 1：APP,  DocumentType can be chosen（0，1，2，3，4）

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.SmsSign("example",
    document_type=4,
    international=0,
    proof_image="your_proof_image",
    sign_name="tf_example_sms_sign",
    sign_purpose=0,
    sign_type=1)
# 1：APP,  DocumentType can be chosen（0，1，2，3，4）

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewSmsSign(ctx, "example", &tencentcloud.SmsSignArgs{
			DocumentType:  pulumi.Float64(4),
			International: pulumi.Float64(0),
			ProofImage:    pulumi.String("your_proof_image"),
			SignName:      pulumi.String("tf_example_sms_sign"),
			SignPurpose:   pulumi.Float64(0),
			SignType:      pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.SmsSign("example", new()
    {
        DocumentType = 4,
        International = 0,
        ProofImage = "your_proof_image",
        SignName = "tf_example_sms_sign",
        SignPurpose = 0,
        SignType = 1,
    });

    // 1：APP,  DocumentType can be chosen（0，1，2，3，4）
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.SmsSign;
import com.pulumi.tencentcloud.SmsSignArgs;
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 SmsSign("example", SmsSignArgs.builder()
            .documentType(4)
            .international(0)
            .proofImage("your_proof_image")
            .signName("tf_example_sms_sign")
            .signPurpose(0)
            .signType(1)
            .build());

        // 1：APP,  DocumentType can be chosen（0，1，2，3，4）
    }
}

    resources:
  example:
    type: tencentcloud:SmsSign
    properties:
      documentType: 4
      # Screenshot of application background management (personally developed APP)
      international: 0
      # Mainland China SMS
      proofImage: your_proof_image
      signName: tf_example_sms_sign
      signPurpose: 0
      # personal use
      signType: 1

    Create SmsSign Resource

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

    Constructor syntax

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

@overload
def SmsSign(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            document_type: Optional[float] = None,
            international: Optional[float] = None,
            proof_image: Optional[str] = None,
            sign_name: Optional[str] = None,
            sign_purpose: Optional[float] = None,
            sign_type: Optional[float] = None,
            commission_image: Optional[str] = None,
            remark: Optional[str] = None,
            sms_sign_id: Optional[str] = None)
    func NewSmsSign(ctx *Context, name string, args SmsSignArgs, opts ...ResourceOption) (*SmsSign, error)
    public SmsSign(string name, SmsSignArgs args, CustomResourceOptions? opts = null)
    public SmsSign(String name, SmsSignArgs args)
public SmsSign(String name, SmsSignArgs args, CustomResourceOptions options)

    type: tencentcloud:SmsSign
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 SmsSignArgs
    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 SmsSignArgs
    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 SmsSignArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmsSignArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmsSignArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DocumentType double
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    International double
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    ProofImage string
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    SignName string
    Sms sign name, unique.
    SignPurpose double
    Signature purpose: 0: for personal use; 1: for others.
    SignType double
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    CommissionImage string
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    Remark string
    Signature application remarks.
    SmsSignId string
    ID of the resource.
    DocumentType float64
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    International float64
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    ProofImage string
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    SignName string
    Sms sign name, unique.
    SignPurpose float64
    Signature purpose: 0: for personal use; 1: for others.
    SignType float64
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    CommissionImage string
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    Remark string
    Signature application remarks.
    SmsSignId string
    ID of the resource.
    documentType Double
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international Double
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proofImage String
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    signName String
    Sms sign name, unique.
    signPurpose Double
    Signature purpose: 0: for personal use; 1: for others.
    signType Double
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    commissionImage String
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    remark String
    Signature application remarks.
    smsSignId String
    ID of the resource.
    documentType number
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international number
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proofImage string
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    signName string
    Sms sign name, unique.
    signPurpose number
    Signature purpose: 0: for personal use; 1: for others.
    signType number
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    commissionImage string
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    remark string
    Signature application remarks.
    smsSignId string
    ID of the resource.
    document_type float
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international float
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proof_image str
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    sign_name str
    Sms sign name, unique.
    sign_purpose float
    Signature purpose: 0: for personal use; 1: for others.
    sign_type float
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    commission_image str
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    remark str
    Signature application remarks.
    sms_sign_id str
    ID of the resource.
    documentType Number
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international Number
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proofImage String
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    signName String
    Sms sign name, unique.
    signPurpose Number
    Signature purpose: 0: for personal use; 1: for others.
    signType Number
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    commissionImage String
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    remark String
    Signature application remarks.
    smsSignId String
    ID of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SmsSign Resource

    Get an existing SmsSign 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?: SmsSignState, opts?: CustomResourceOptions): SmsSign
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        commission_image: Optional[str] = None,
        document_type: Optional[float] = None,
        international: Optional[float] = None,
        proof_image: Optional[str] = None,
        remark: Optional[str] = None,
        sign_name: Optional[str] = None,
        sign_purpose: Optional[float] = None,
        sign_type: Optional[float] = None,
        sms_sign_id: Optional[str] = None) -> SmsSign
    func GetSmsSign(ctx *Context, name string, id IDInput, state *SmsSignState, opts ...ResourceOption) (*SmsSign, error)
    public static SmsSign Get(string name, Input<string> id, SmsSignState? state, CustomResourceOptions? opts = null)
    public static SmsSign get(String name, Output<String> id, SmsSignState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:SmsSign    get:      id: ${id}
    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:
    CommissionImage string
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    DocumentType double
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    International double
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    ProofImage string
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    Remark string
    Signature application remarks.
    SignName string
    Sms sign name, unique.
    SignPurpose double
    Signature purpose: 0: for personal use; 1: for others.
    SignType double
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    SmsSignId string
    ID of the resource.
    CommissionImage string
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    DocumentType float64
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    International float64
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    ProofImage string
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    Remark string
    Signature application remarks.
    SignName string
    Sms sign name, unique.
    SignPurpose float64
    Signature purpose: 0: for personal use; 1: for others.
    SignType float64
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    SmsSignId string
    ID of the resource.
    commissionImage String
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    documentType Double
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international Double
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proofImage String
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    remark String
    Signature application remarks.
    signName String
    Sms sign name, unique.
    signPurpose Double
    Signature purpose: 0: for personal use; 1: for others.
    signType Double
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    smsSignId String
    ID of the resource.
    commissionImage string
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    documentType number
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international number
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proofImage string
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    remark string
    Signature application remarks.
    signName string
    Sms sign name, unique.
    signPurpose number
    Signature purpose: 0: for personal use; 1: for others.
    signType number
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    smsSignId string
    ID of the resource.
    commission_image str
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    document_type float
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international float
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proof_image str
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    remark str
    Signature application remarks.
    sign_name str
    Sms sign name, unique.
    sign_purpose float
    Signature purpose: 0: for personal use; 1: for others.
    sign_type float
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    sms_sign_id str
    ID of the resource.
    commissionImage String
    Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
    documentType Number
    DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
    international Number
    Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
    proofImage String
    You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
    remark String
    Signature application remarks.
    signName String
    Sms sign name, unique.
    signPurpose Number
    Signature purpose: 0: for personal use; 1: for others.
    signType Number
    Sms sign type: 0, 1, 2, 3, 4, 5, 6.
    smsSignId String
    ID of the resource.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud