Custom Domains - Create Or Update

サービス:: Azure Spring Apps

API バージョン:: 2023-12-01

1 つのライフサイクルアプリケーションのカスタムドメインを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
appName	path	True	string	アプリリソースの名前。
domainName	path	True	string	カスタムドメインリソースの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	サービスリソースの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション ID を取得します。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties	CustomDomainProperties	カスタムドメインリソースのプロパティ。

応答

名前	型	説明
200 OK	CustomDomainResource	成功。応答では、更新された既存のカスタムドメインについて説明します。
201 Created	CustomDomainResource	作成。応答は、新しいカスタムドメインを記述し、操作の結果を照会するための Azure-AsyncOperation ヘッダーを含みます。
202 Accepted	CustomDomainResource	受け入れられる。応答は、終了しているカスタムドメインが更新中であることを示し、操作の結果を照会するための Location ヘッダーが含まれています。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

CustomDomains_CreateOrUpdate

要求のサンプル

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

{
  "properties": {
    "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133",
    "certName": "mycert"
  }
}


import com.azure.resourcemanager.appplatform.fluent.models.CustomDomainResourceInner;
import com.azure.resourcemanager.appplatform.models.CustomDomainProperties;

/**
 * Samples for CustomDomains CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * CustomDomains_CreateOrUpdate.json
     */
    /**
     * Sample code: CustomDomains_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void customDomainsCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getCustomDomains().createOrUpdate("myResourceGroup",
            "myservice", "myapp", "mydomain.com",
            new CustomDomainResourceInner().withProperties(new CustomDomainProperties()
                .withThumbprint("934367bf1c97033f877db0f15cb1b586957d3133").withCertName("mycert")),
            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 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.custom_domains.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        app_name="myapp",
        domain_name="mydomain.com",
        domain_resource={
            "properties": {"certName": "mycert", "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_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/CustomDomains_CreateOrUpdate.json
func ExampleCustomDomainsClient_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.NewCustomDomainsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydomain.com", armappplatform.CustomDomainResource{
		Properties: &armappplatform.CustomDomainProperties{
			CertName:   to.Ptr("mycert"),
			Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
		},
	}, 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.CustomDomainResource = armappplatform.CustomDomainResource{
	// 	Name: to.Ptr("mydomain.com"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/domains"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com"),
	// 	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.CustomDomainProperties{
	// 		AppName: to.Ptr("myapp"),
	// 		CertName: to.Ptr("mycert"),
	// 		Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
	// 	},
	// }
}

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 custom domain of one lifecycle application.
 *
 * @summary Create or update custom domain of one lifecycle application.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_CreateOrUpdate.json
 */
async function customDomainsCreateOrUpdate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const appName = "myapp";
  const domainName = "mydomain.com";
  const domainResource = {
    properties: {
      certName: "mycert",
      thumbprint: "934367bf1c97033f877db0f15cb1b586957d3133",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.customDomains.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    appName,
    domainName,
    domainResource,
  );
  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": "934367bf1c97033f877db0f15cb1b586957d3133",
    "appName": "myapp",
    "certName": "mycert"
  },
  "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/apps/domains",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com",
  "name": "mydomain.com"
}

状態コード:: 201

{
  "properties": {
    "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133",
    "appName": "myapp",
    "certName": "mycert"
  },
  "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/apps/domains",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com",
  "name": "mydomain.com"
}

状態コード:: 202

{
  "properties": {
    "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133",
    "appName": "myapp",
    "certName": "mycert"
  },
  "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/apps/domains",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com",
  "name": "mydomain.com"
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
createdByType	リソースを作成した ID の種類。
CustomDomainProperties	アプリリソースペイロードのカスタムドメイン。
CustomDomainResource	カスタムドメインリソースペイロード。
CustomDomainResourceProvisioningState	ドメインのプロビジョニング状態
lastModifiedByType	リソースを最後に変更した ID の種類。
SystemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	サービスからのエラー応答。

CloudErrorBody

Object

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

CustomDomainProperties

Object

アプリリソースペイロードのカスタムドメイン。

名前	型	説明
appName	string	ドメインのアプリ名。
certName	string	ドメインのバインドされた証明書名。
provisioningState	CustomDomainResourceProvisioningState	ドメインのプロビジョニング状態
thumbprint	string	バインドされた証明書の拇印。

CustomDomainResource

Object

カスタムドメインリソースペイロード。

名前	型	説明
id	string	リソースの完全修飾リソース ID。
name	string	リソースの名前。
properties	CustomDomainProperties	カスタムドメインリソースのプロパティ。
systemData	SystemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの種類。

CustomDomainResourceProvisioningState

列挙

ドメインのプロビジョニング状態

値	説明
Creating
Deleting
Failed
Succeeded
Updating

lastModifiedByType

列挙

リソースを最後に変更した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

SystemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソース変更のタイムスタンプ (UTC)。
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	lastModifiedByType	リソースを最後に変更した ID の種類。

次の方法で共有

Custom Domains - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

CustomDomains_CreateOrUpdate

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

createdByType

CustomDomainProperties

CustomDomainResource

CustomDomainResourceProvisioningState

lastModifiedByType

SystemData