App Service Environments - Update Ase Custom Dns Suffix Configuration

Служба:

App Service

Версия API:

2024-11-01

Обновление настраиваемой конфигурации DNS-суффикса среды службы приложений

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix?api-version=2024-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя среды службы приложений.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Имя группы ресурсов, к которой принадлежит ресурс.
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка с форматом GUID (например, 0000000000-0000-0000-0000-00000000000000000000000000000).
api-version	query	True	string	Версия API

Текст запроса

Имя	Тип	Описание
kind	string	Тип ресурса.
properties.certificateUrl	string	URL-адрес, ссылающийся на секрет сертификата Azure Key Vault, который должен использоваться в качестве сертификата SSL/TLS по умолчанию для сайтов с суффиксом личного домена.
properties.dnsSuffix	string	Суффикс личного домена по умолчанию, используемый для всех сайтов, развернутых в ASE.
properties.keyVaultReferenceIdentity	string	Назначаемое пользователем удостоверение, используемое для разрешения ссылки на сертификат хранилища ключей. Если это не указано, удостоверение ASE, назначаемое системой, будет использоваться при наличии.

Ответы

Имя	Тип	Описание
200 OK	CustomDnsSuffixConfiguration	ХОРОШО.
Other Status Codes	DefaultErrorResponse	Ответ об ошибке службы приложений.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update ASE custom DNS suffix configuration

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix?api-version=2024-11-01

{
  "properties": {
    "dnsSuffix": "contoso.com",
    "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
    "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.CustomDnsSuffixConfigurationInner;

/**
 * Samples for AppServiceEnvironments UpdateAseCustomDnsSuffixConfiguration.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/UpdateAseCustomDnsSuffixConfiguration
     * .json
     */
    /**
     * Sample code: Update ASE custom DNS suffix configuration.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASECustomDNSSuffixConfiguration(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceEnvironments()
            .updateAseCustomDnsSuffixConfigurationWithResponse("test-rg", "test-ase",
                new CustomDnsSuffixConfigurationInner().withDnsSuffix("contoso.com")
                    .withCertificateUrl("https://test-kv.vault.azure.net/secrets/contosocert")
                    .withKeyVaultReferenceIdentity("fakeTokenPlaceholder"),
                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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_ase_custom_dns_suffix_configuration.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_environments.update_ase_custom_dns_suffix_configuration(
        resource_group_name="test-rg",
        name="test-ase",
        custom_dns_suffix_configuration={
            "properties": {
                "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
                "dnsSuffix": "contoso.com",
                "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/UpdateAseCustomDnsSuffixConfiguration.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

Go

package armappservice_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/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/UpdateAseCustomDnsSuffixConfiguration.json
func ExampleEnvironmentsClient_UpdateAseCustomDNSSuffixConfiguration() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().UpdateAseCustomDNSSuffixConfiguration(ctx, "test-rg", "test-ase", armappservice.CustomDNSSuffixConfiguration{
		Properties: &armappservice.CustomDNSSuffixConfigurationProperties{
			CertificateURL:            to.Ptr("https://test-kv.vault.azure.net/secrets/contosocert"),
			DNSSuffix:                 to.Ptr("contoso.com"),
			KeyVaultReferenceIdentity: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.CustomDNSSuffixConfiguration = armappservice.CustomDNSSuffixConfiguration{
	// 	Name: to.Ptr("customDnsSuffix"),
	// 	Type: to.Ptr("Microsoft.Web/hostingEnvironments/configurations/customdnssuffix"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix"),
	// 	Properties: &armappservice.CustomDNSSuffixConfigurationProperties{
	// 		CertificateURL: to.Ptr("https://test-kv.vault.azure.net/secrets/contosocert"),
	// 		DNSSuffix: to.Ptr("contoso.com"),
	// 		KeyVaultReferenceIdentity: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"),
	// 		ProvisioningState: to.Ptr(armappservice.CustomDNSSuffixProvisioningStateSucceeded),
	// 	},
	// }
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Update Custom Dns Suffix configuration of an App Service Environment
 *
 * @summary Update Custom Dns Suffix configuration of an App Service Environment
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/UpdateAseCustomDnsSuffixConfiguration.json
 */
async function updateAseCustomDnsSuffixConfiguration() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const customDnsSuffixConfiguration = {
    certificateUrl: "https://test-kv.vault.azure.net/secrets/contosocert",
    dnsSuffix: "contoso.com",
    keyVaultReferenceIdentity:
      "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceEnvironments.updateAseCustomDnsSuffixConfiguration(
    resourceGroupName,
    name,
    customDnsSuffixConfiguration,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/UpdateAseCustomDnsSuffixConfiguration.json
// this example is just showing the usage of "AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CustomDnsSuffixConfigurationResource created on azure
// for more information of creating CustomDnsSuffixConfigurationResource, please refer to the document of CustomDnsSuffixConfigurationResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
string name = "test-ase";
ResourceIdentifier customDnsSuffixConfigurationResourceId = CustomDnsSuffixConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
CustomDnsSuffixConfigurationResource customDnsSuffixConfiguration = client.GetCustomDnsSuffixConfigurationResource(customDnsSuffixConfigurationResourceId);

// invoke the operation
CustomDnsSuffixConfigurationData data = new CustomDnsSuffixConfigurationData
{
    DnsSuffix = "contoso.com",
    CertificateUri = new Uri("https://test-kv.vault.azure.net/secrets/contosocert"),
    KeyVaultReferenceIdentity = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi",
};
ArmOperation<CustomDnsSuffixConfigurationResource> lro = await customDnsSuffixConfiguration.CreateOrUpdateAsync(WaitUntil.Completed, data);
CustomDnsSuffixConfigurationResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CustomDnsSuffixConfigurationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Пример ответа

Код состояния:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix",
  "name": "customDnsSuffix",
  "type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix",
  "properties": {
    "provisioningState": "Succeeded",
    "provisioningDetails": null,
    "dnsSuffix": "contoso.com",
    "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
    "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
  }
}

Определения

Имя	Описание
CustomDnsSuffixConfiguration	Полное представление конфигурации суффикса личного домена для ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	Ответ об ошибке службы приложений.
Details
Error	Модель ошибок.

CustomDnsSuffixConfiguration

Object

Полное представление конфигурации суффикса личного домена для ASEv3.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
name	string	Имя ресурса.
properties.certificateUrl	string	URL-адрес, ссылающийся на секрет сертификата Azure Key Vault, который должен использоваться в качестве сертификата SSL/TLS по умолчанию для сайтов с суффиксом личного домена.
properties.dnsSuffix	string	Суффикс личного домена по умолчанию, используемый для всех сайтов, развернутых в ASE.
properties.keyVaultReferenceIdentity	string	Назначаемое пользователем удостоверение, используемое для разрешения ссылки на сертификат хранилища ключей. Если это не указано, удостоверение ASE, назначаемое системой, будет использоваться при наличии.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Тип ресурса.

CustomDnsSuffixProvisioningState

Перечисление

Значение	Описание
Degraded
Failed
InProgress
Succeeded

DefaultErrorResponse

Object

Ответ об ошибке службы приложений.

Имя	Тип	Описание
error	Error	Модель ошибок.

Details

Object

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

Error

Object

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
details	Details[]	Подробные ошибки.
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.