你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Api Portal Custom Domains - Create Or Update

服务:: Azure Spring Apps

API 版本:: 2023-12-01

创建或更新 API 门户自定义域。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
apiPortalName	path	True	string	API 门户的名称。
domainName	path	True	string	API 门户自定义域的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	服务资源的名称。
subscriptionId	path	True	string	获取唯一标识 azure 订阅Microsoft的订阅 ID。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
properties	ApiPortalCustomDomainProperties	API 门户的自定义域的属性

响应

名称	类型	说明
200 OK	ApiPortalCustomDomainResource	成功。响应描述更新的 Spring Cloud 网关路由配置。
201 Created	ApiPortalCustomDomainResource	创建。响应描述新创建的 Spring Cloud Gateway 自定义域，并包含用于查询作结果的 Azure-AsyncOperation 标头。
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiPortalCustomDomains_CreateOrUpdate

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName?api-version=2023-12-01

{
  "properties": {
    "thumbprint": "*"
  }
}


import com.azure.resourcemanager.appplatform.fluent.models.ApiPortalCustomDomainResourceInner;
import com.azure.resourcemanager.appplatform.models.ApiPortalCustomDomainProperties;

/**
 * Samples for ApiPortalCustomDomains CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * ApiPortalCustomDomains_CreateOrUpdate.json
     */
    /**
     * Sample code: ApiPortalCustomDomains_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void apiPortalCustomDomainsCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getApiPortalCustomDomains().createOrUpdate(
            "myResourceGroup", "myservice", "default", "myDomainName", new ApiPortalCustomDomainResourceInner()
                .withProperties(new ApiPortalCustomDomainProperties().withThumbprint("*")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python api_portal_custom_domains_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_portal_custom_domains.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        api_portal_name="default",
        domain_name="myDomainName",
        api_portal_custom_domain_resource={"properties": {"thumbprint": "*"}},
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_CreateOrUpdate.json
func ExampleAPIPortalCustomDomainsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAPIPortalCustomDomainsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "myDomainName", armappplatform.APIPortalCustomDomainResource{
		Properties: &armappplatform.APIPortalCustomDomainProperties{
			Thumbprint: to.Ptr("*"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.APIPortalCustomDomainResource = armappplatform.APIPortalCustomDomainResource{
	// 	Name: to.Ptr("myDomainName"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals/domains"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName"),
	// 	SystemData: &armappplatform.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 		CreatedBy: to.Ptr("sample-user"),
	// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("sample-user"),
	// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 	},
	// 	Properties: &armappplatform.APIPortalCustomDomainProperties{
	// 		Thumbprint: to.Ptr("*"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update the API portal custom domain.
 *
 * @summary Create or update the API portal custom domain.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_CreateOrUpdate.json
 */
async function apiPortalCustomDomainsCreateOrUpdate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const apiPortalName = "default";
  const domainName = "myDomainName";
  const apiPortalCustomDomainResource = {
    properties: { thumbprint: "*" },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.apiPortalCustomDomains.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    apiPortalName,
    domainName,
    apiPortalCustomDomainResource,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "properties": {
    "thumbprint": "*"
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apiPortals/domains",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName",
  "name": "myDomainName"
}

状态代码:: 201

{
  "properties": {
    "thumbprint": "*"
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apiPortals/domains",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName",
  "name": "myDomainName"
}

定义

名称	说明
ApiPortalCustomDomainProperties	API 门户的自定义域的属性
ApiPortalCustomDomainResource	API 门户的自定义域
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
createdByType	创建资源的标识的类型。
lastModifiedByType	上次修改资源的标识的类型。
SystemData	与创建和上次修改资源相关的元数据。

ApiPortalCustomDomainProperties

对象

API 门户的自定义域的属性

名称	类型	说明
thumbprint	string	绑定证书的指纹。

ApiPortalCustomDomainResource

对象

API 门户的自定义域

名称	类型	说明
id	string	资源的完全限定资源 ID。
name	string	资源的名称。
properties	ApiPortalCustomDomainProperties	API 门户的自定义域的属性
systemData	SystemData	与创建和上次修改资源相关的元数据。
type	string	资源的类型。

CloudError

对象

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	服务的错误响应。

CloudErrorBody

对象

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

lastModifiedByType

枚举

上次修改资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

SystemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源修改的时间戳（UTC）。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	lastModifiedByType	上次修改资源的标识的类型。

通过

Api Portal Custom Domains - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

ApiPortalCustomDomains_CreateOrUpdate

示例请求

示例响应

定义

ApiPortalCustomDomainProperties

ApiPortalCustomDomainResource

CloudError

CloudErrorBody

createdByType

lastModifiedByType

SystemData