Api Portal Custom Domains - Create Or Update

Serviço:: Azure Spring Apps

Versão API:: 2023-12-01

Crie ou atualize o domínio personalizado do portal da API.

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
apiPortalName	path	True	string	O nome do portal da API.
domainName	path	True	string	O nome do domínio personalizado do portal da API.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	O nome do recurso de serviço.
subscriptionId	path	True	string	Obtém a ID da assinatura que identifica exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Órgão do Pedido

Nome	Tipo	Descrição
properties	ApiPortalCustomDomainProperties	As propriedades do domínio personalizado para o portal da API

Respostas

Nome	Tipo	Descrição
200 OK	ApiPortalCustomDomainResource	Sucesso. A resposta descreve as configurações de rota atualizadas do Spring Cloud Gateway.
201 Created	ApiPortalCustomDomainResource	Criado. A resposta descreve o novo domínio personalizado criado do Spring Cloud Gateway e contém um cabeçalho Azure-AsyncOperation para consultar o resultado da operação.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiPortalCustomDomains_CreateOrUpdate

Pedido de exemplo

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

Resposta de exemplo

Código de estado:: 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"
}

Código de estado:: 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"
}

Definições

Nome	Descrição
ApiPortalCustomDomainProperties	As propriedades do domínio personalizado para o portal da API
ApiPortalCustomDomainResource	Domínio personalizado do portal da API
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
createdByType	O tipo de identidade que criou o recurso.
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
SystemData	Metadados referentes à criação e última modificação do recurso.

ApiPortalCustomDomainProperties

Objetivo

As propriedades do domínio personalizado para o portal da API

Nome	Tipo	Descrição
thumbprint	string	A impressão digital do certificado encadernado.

ApiPortalCustomDomainResource

Objetivo

Domínio personalizado do portal da API

Nome	Tipo	Descrição
id	string	ID do recurso totalmente qualificado para o recurso.
name	string	O nome do recurso.
properties	ApiPortalCustomDomainProperties	As propriedades do domínio personalizado para o portal da API
systemData	SystemData	Metadados referentes à criação e última modificação do recurso.
type	string	O tipo do recurso.

CloudError

Objetivo

Uma resposta de erro do serviço.

Nome	Tipo	Descrição
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Objetivo

Uma resposta de erro do serviço.

Nome	Tipo	Descrição
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

lastModifiedByType

Enumeração

O tipo de identidade que modificou o recurso pela última vez.

Valor	Descrição
User
Application
ManagedIdentity
Key

SystemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da modificação do recurso (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Api Portal Custom Domains - Create Or Update

Parâmetros URI

Órgão do Pedido

Respostas

Segurança

azure_auth

Alcances

Exemplos

ApiPortalCustomDomains_CreateOrUpdate

Pedido de exemplo

Resposta de exemplo

Definições

ApiPortalCustomDomainProperties

ApiPortalCustomDomainResource

CloudError

CloudErrorBody

createdByType

lastModifiedByType

SystemData