azure-native.appplatform.ApiPortalCustomDomain

Explore with Pulumi AI

Custom domain of the API portal API Version: 2022-01-01-preview.

Example Usage

ApiPortalCustomDomains_CreateOrUpdate

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var apiPortalCustomDomain = new AzureNative.AppPlatform.ApiPortalCustomDomain("apiPortalCustomDomain", new()
    {
        ApiPortalName = "default",
        DomainName = "myDomainName",
        Properties = new AzureNative.AppPlatform.Inputs.ApiPortalCustomDomainPropertiesArgs
        {
            Thumbprint = "*",
        },
        ResourceGroupName = "myResourceGroup",
        ServiceName = "myservice",
    });

});
package main

import (
	appplatform "github.com/pulumi/pulumi-azure-native/sdk/go/azure/appplatform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appplatform.NewApiPortalCustomDomain(ctx, "apiPortalCustomDomain", &appplatform.ApiPortalCustomDomainArgs{
			ApiPortalName: pulumi.String("default"),
			DomainName:    pulumi.String("myDomainName"),
			Properties: &appplatform.ApiPortalCustomDomainPropertiesArgs{
				Thumbprint: pulumi.String("*"),
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ServiceName:       pulumi.String("myservice"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.appplatform.ApiPortalCustomDomain;
import com.pulumi.azurenative.appplatform.ApiPortalCustomDomainArgs;
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 apiPortalCustomDomain = new ApiPortalCustomDomain("apiPortalCustomDomain", ApiPortalCustomDomainArgs.builder()        
            .apiPortalName("default")
            .domainName("myDomainName")
            .properties(Map.of("thumbprint", "*"))
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

api_portal_custom_domain = azure_native.appplatform.ApiPortalCustomDomain("apiPortalCustomDomain",
    api_portal_name="default",
    domain_name="myDomainName",
    properties=azure_native.appplatform.ApiPortalCustomDomainPropertiesArgs(
        thumbprint="*",
    ),
    resource_group_name="myResourceGroup",
    service_name="myservice")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiPortalCustomDomain = new azure_native.appplatform.ApiPortalCustomDomain("apiPortalCustomDomain", {
    apiPortalName: "default",
    domainName: "myDomainName",
    properties: {
        thumbprint: "*",
    },
    resourceGroupName: "myResourceGroup",
    serviceName: "myservice",
});
resources:
  apiPortalCustomDomain:
    type: azure-native:appplatform:ApiPortalCustomDomain
    properties:
      apiPortalName: default
      domainName: myDomainName
      properties:
        thumbprint: '*'
      resourceGroupName: myResourceGroup
      serviceName: myservice

Create ApiPortalCustomDomain Resource

new ApiPortalCustomDomain(name: string, args: ApiPortalCustomDomainArgs, opts?: CustomResourceOptions);
@overload
def ApiPortalCustomDomain(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          api_portal_name: Optional[str] = None,
                          domain_name: Optional[str] = None,
                          properties: Optional[ApiPortalCustomDomainPropertiesArgs] = None,
                          resource_group_name: Optional[str] = None,
                          service_name: Optional[str] = None)
@overload
def ApiPortalCustomDomain(resource_name: str,
                          args: ApiPortalCustomDomainArgs,
                          opts: Optional[ResourceOptions] = None)
func NewApiPortalCustomDomain(ctx *Context, name string, args ApiPortalCustomDomainArgs, opts ...ResourceOption) (*ApiPortalCustomDomain, error)
public ApiPortalCustomDomain(string name, ApiPortalCustomDomainArgs args, CustomResourceOptions? opts = null)
public ApiPortalCustomDomain(String name, ApiPortalCustomDomainArgs args)
public ApiPortalCustomDomain(String name, ApiPortalCustomDomainArgs args, CustomResourceOptions options)
type: azure-native:appplatform:ApiPortalCustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

ApiPortalCustomDomain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ApiPortalCustomDomain resource accepts the following input properties:

ApiPortalName string

The name of API portal.

ResourceGroupName string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

ServiceName string

The name of the Service resource.

DomainName string

The name of the API portal custom domain.

Properties Pulumi.AzureNative.AppPlatform.Inputs.ApiPortalCustomDomainPropertiesArgs

The properties of custom domain for API portal

ApiPortalName string

The name of API portal.

ResourceGroupName string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

ServiceName string

The name of the Service resource.

DomainName string

The name of the API portal custom domain.

Properties ApiPortalCustomDomainPropertiesArgs

The properties of custom domain for API portal

apiPortalName String

The name of API portal.

resourceGroupName String

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName String

The name of the Service resource.

domainName String

The name of the API portal custom domain.

properties ApiPortalCustomDomainPropertiesArgs

The properties of custom domain for API portal

apiPortalName string

The name of API portal.

resourceGroupName string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName string

The name of the Service resource.

domainName string

The name of the API portal custom domain.

properties ApiPortalCustomDomainPropertiesArgs

The properties of custom domain for API portal

api_portal_name str

The name of API portal.

resource_group_name str

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name str

The name of the Service resource.

domain_name str

The name of the API portal custom domain.

properties ApiPortalCustomDomainPropertiesArgs

The properties of custom domain for API portal

apiPortalName String

The name of API portal.

resourceGroupName String

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName String

The name of the Service resource.

domainName String

The name of the API portal custom domain.

properties Property Map

The properties of custom domain for API portal

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource.

SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource.

SystemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource.

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the resource.

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type string

The type of the resource.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the resource.

system_data SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type str

The type of the resource.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource.

systemData Property Map

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

Supporting Types

ApiPortalCustomDomainProperties

Thumbprint string

The thumbprint of bound certificate.

Thumbprint string

The thumbprint of bound certificate.

thumbprint String

The thumbprint of bound certificate.

thumbprint string

The thumbprint of bound certificate.

thumbprint str

The thumbprint of bound certificate.

thumbprint String

The thumbprint of bound certificate.

ApiPortalCustomDomainPropertiesResponse

Thumbprint string

The thumbprint of bound certificate.

Thumbprint string

The thumbprint of bound certificate.

thumbprint String

The thumbprint of bound certificate.

thumbprint string

The thumbprint of bound certificate.

thumbprint str

The thumbprint of bound certificate.

thumbprint String

The thumbprint of bound certificate.

SystemDataResponse

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

createdAt string

The timestamp of resource creation (UTC).

createdBy string

The identity that created the resource.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

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_type str

The type of identity that created the resource.

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

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:appplatform:ApiPortalCustomDomain myDomainName /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName 

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0