1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. CertificateBinding

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.appservice.CertificateBinding

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages an App Service Certificate Binding.

    Create CertificateBinding Resource

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

    Constructor syntax

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

@overload
def CertificateBinding(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       certificate_id: Optional[str] = None,
                       hostname_binding_id: Optional[str] = None,
                       ssl_state: Optional[str] = None)
    func NewCertificateBinding(ctx *Context, name string, args CertificateBindingArgs, opts ...ResourceOption) (*CertificateBinding, error)
    public CertificateBinding(string name, CertificateBindingArgs args, CustomResourceOptions? opts = null)
    public CertificateBinding(String name, CertificateBindingArgs args)
public CertificateBinding(String name, CertificateBindingArgs args, CustomResourceOptions options)

    type: azure:appservice:CertificateBinding
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 CertificateBindingArgs
    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 CertificateBindingArgs
    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 CertificateBindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CertificateBindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CertificateBindingArgs
    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 certificateBindingResource = new Azure.AppService.CertificateBinding("certificateBindingResource", new()
{
    CertificateId = "string",
    HostnameBindingId = "string",
    SslState = "string",
});

    example, err := appservice.NewCertificateBinding(ctx, "certificateBindingResource", &appservice.CertificateBindingArgs{
	CertificateId:     pulumi.String("string"),
	HostnameBindingId: pulumi.String("string"),
	SslState:          pulumi.String("string"),
})

    var certificateBindingResource = new CertificateBinding("certificateBindingResource", CertificateBindingArgs.builder()
    .certificateId("string")
    .hostnameBindingId("string")
    .sslState("string")
    .build());

    certificate_binding_resource = azure.appservice.CertificateBinding("certificateBindingResource",
    certificate_id="string",
    hostname_binding_id="string",
    ssl_state="string")

    const certificateBindingResource = new azure.appservice.CertificateBinding("certificateBindingResource", {
    certificateId: "string",
    hostnameBindingId: "string",
    sslState: "string",
});

    type: azure:appservice:CertificateBinding
properties:
    certificateId: string
    hostnameBindingId: string
    sslState: string

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

    CertificateId string
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    HostnameBindingId string
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    SslState string
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    CertificateId string
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    HostnameBindingId string
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    SslState string
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    certificateId String
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostnameBindingId String
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    sslState String
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    certificateId string
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostnameBindingId string
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    sslState string
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    certificate_id str
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostname_binding_id str
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    ssl_state str
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    certificateId String
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostnameBindingId String
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    sslState String
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.

    Outputs

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

    AppServiceName string
    The name of the App Service to which the certificate was bound.
    Hostname string
    The hostname of the bound certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    Thumbprint string
    The certificate thumbprint.
    AppServiceName string
    The name of the App Service to which the certificate was bound.
    Hostname string
    The hostname of the bound certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    Thumbprint string
    The certificate thumbprint.
    appServiceName String
    The name of the App Service to which the certificate was bound.
    hostname String
    The hostname of the bound certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    thumbprint String
    The certificate thumbprint.
    appServiceName string
    The name of the App Service to which the certificate was bound.
    hostname string
    The hostname of the bound certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    thumbprint string
    The certificate thumbprint.
    app_service_name str
    The name of the App Service to which the certificate was bound.
    hostname str
    The hostname of the bound certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    thumbprint str
    The certificate thumbprint.
    appServiceName String
    The name of the App Service to which the certificate was bound.
    hostname String
    The hostname of the bound certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    thumbprint String
    The certificate thumbprint.

    Look up Existing CertificateBinding Resource

    Get an existing CertificateBinding 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?: CertificateBindingState, opts?: CustomResourceOptions): CertificateBinding
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_service_name: Optional[str] = None,
        certificate_id: Optional[str] = None,
        hostname: Optional[str] = None,
        hostname_binding_id: Optional[str] = None,
        ssl_state: Optional[str] = None,
        thumbprint: Optional[str] = None) -> CertificateBinding
    func GetCertificateBinding(ctx *Context, name string, id IDInput, state *CertificateBindingState, opts ...ResourceOption) (*CertificateBinding, error)
    public static CertificateBinding Get(string name, Input<string> id, CertificateBindingState? state, CustomResourceOptions? opts = null)
    public static CertificateBinding get(String name, Output<String> id, CertificateBindingState state, CustomResourceOptions options)
    resources:  _:    type: azure:appservice:CertificateBinding    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:
    AppServiceName string
    The name of the App Service to which the certificate was bound.
    CertificateId string
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    Hostname string
    The hostname of the bound certificate.
    HostnameBindingId string
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    SslState string
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    Thumbprint string
    The certificate thumbprint.
    AppServiceName string
    The name of the App Service to which the certificate was bound.
    CertificateId string
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    Hostname string
    The hostname of the bound certificate.
    HostnameBindingId string
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    SslState string
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    Thumbprint string
    The certificate thumbprint.
    appServiceName String
    The name of the App Service to which the certificate was bound.
    certificateId String
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostname String
    The hostname of the bound certificate.
    hostnameBindingId String
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    sslState String
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    thumbprint String
    The certificate thumbprint.
    appServiceName string
    The name of the App Service to which the certificate was bound.
    certificateId string
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostname string
    The hostname of the bound certificate.
    hostnameBindingId string
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    sslState string
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    thumbprint string
    The certificate thumbprint.
    app_service_name str
    The name of the App Service to which the certificate was bound.
    certificate_id str
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostname str
    The hostname of the bound certificate.
    hostname_binding_id str
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    ssl_state str
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    thumbprint str
    The certificate thumbprint.
    appServiceName String
    The name of the App Service to which the certificate was bound.
    certificateId String
    The ID of the certificate to bind to the custom domain. Changing this forces a new App Service Certificate Binding to be created.
    hostname String
    The hostname of the bound certificate.
    hostnameBindingId String
    The ID of the Custom Domain/Hostname Binding. Changing this forces a new App Service Certificate Binding to be created.
    sslState String
    The type of certificate binding. Allowed values are IpBasedEnabled or SniEnabled. Changing this forces a new App Service Certificate Binding to be created.
    thumbprint String
    The certificate thumbprint.

    Import

    App Service Certificate Bindings can be imported using the hostname_binding_id and the app_service_certificate_id , e.g.

     $ pulumi import azure:appservice/certificateBinding:CertificateBinding example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Web/sites/instance1/hostNameBindings/mywebsite.com|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Web/certificates/mywebsite.com"

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.