Api Portal Custom Domains - Create Or Update

Service:: Azure Spring Apps

API-versie:: 2023-12-01

Het aangepaste domein van de API-portal maken of bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
apiPortalName	path	True	string	De naam van de API-portal.
domainName	path	True	string	De naam van het aangepaste domein van de API-portal.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	De naam van de serviceresource.
subscriptionId	path	True	string	Hiermee haalt u de abonnements-id op waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties	ApiPortalCustomDomainProperties	De eigenschappen van aangepast domein voor API-portal

Antwoorden

Name	Type	Description
200 OK	ApiPortalCustomDomainResource	Succes. In het antwoord worden de bijgewerkte configuraties van de Spring Cloud Gateway-route beschreven.
201 Created	ApiPortalCustomDomainResource	Geschapen. Het antwoord beschrijft het nieuwe aangepaste Spring Cloud Gateway-domein en bevat een Azure-AsyncOperation header om een query uit te voeren op het bewerkingsresultaat.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiPortalCustomDomains_CreateOrUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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"
}

Statuscode:: 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"
}

Definities

Name	Description
ApiPortalCustomDomainProperties	De eigenschappen van aangepast domein voor API-portal
ApiPortalCustomDomainResource	Aangepast domein van de API-portal
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

ApiPortalCustomDomainProperties

Object

De eigenschappen van aangepast domein voor API-portal

Name	Type	Description
thumbprint	string	De vingerafdruk van het afhankelijke certificaat.

ApiPortalCustomDomainResource

Object

Aangepast domein van de API-portal

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource.
name	string	De naam van de resource.
properties	ApiPortalCustomDomainProperties	De eigenschappen van aangepast domein voor API-portal
systemData	SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	string	Het type resource.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de service.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

lastModifiedByType

Opsomming

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Waarde	Description
User
Application
ManagedIdentity
Key

SystemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van resourcewijziging (UTC).
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Api Portal Custom Domains - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiPortalCustomDomains_CreateOrUpdate

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ApiPortalCustomDomainProperties

ApiPortalCustomDomainResource

CloudError

CloudErrorBody

createdByType

lastModifiedByType

SystemData