Gateway Custom Domains - List

서비스:: Azure Spring Apps

API 버전:: 2023-12-01

모든 Spring Cloud Gateway 사용자 지정 도메인을 나열하는 요청을 처리합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains?api-version=2023-12-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
gatewayName	path	True	string pattern: ^[a-z][a-z0-9]*$	Spring Cloud Gateway의 이름입니다.
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 버전입니다.

응답

Name	형식	Description
200 OK	GatewayCustomDomainResourceCollection	성공. 응답은 Spring Cloud Gateway 사용자 지정 도메인 목록을 설명합니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

GatewayCustomDomains_List

샘플 요청

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


/**
 * Samples for GatewayCustomDomains List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * GatewayCustomDomains_List.json
     */
    /**
     * Sample code: GatewayCustomDomains_List.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void gatewayCustomDomainsList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getGatewayCustomDomains().list("myResourceGroup", "myservice",
            "default", 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 gateway_custom_domains_list.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.gateway_custom_domains.list(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        gateway_name="default",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayCustomDomains_List.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/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/GatewayCustomDomains_List.json
func ExampleGatewayCustomDomainsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewGatewayCustomDomainsClient().NewListPager("myResourceGroup", "myservice", "default", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.GatewayCustomDomainResourceCollection = armappplatform.GatewayCustomDomainResourceCollection{
		// 	Value: []*armappplatform.GatewayCustomDomainResource{
		// 		{
		// 			Name: to.Ptr("myDomain"),
		// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/domains"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomain"),
		// 			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.GatewayCustomDomainProperties{
		// 				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 Handle requests to list all Spring Cloud Gateway custom domains.
 *
 * @summary Handle requests to list all Spring Cloud Gateway custom domains.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayCustomDomains_List.json
 */
async function gatewayCustomDomainsList() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const gatewayName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.gatewayCustomDomains.list(
    resourceGroupName,
    serviceName,
    gatewayName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "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/gateways/domains",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomain",
      "name": "myDomain"
    }
  ]
}

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
createdByType	리소스를 만든 ID의 형식입니다.
GatewayCustomDomainProperties	Spring Cloud Gateway에 대한 사용자 지정 도메인의 속성
GatewayCustomDomainResource	Spring Cloud Gateway의 사용자 지정 도메인
GatewayCustomDomainResourceCollection	Spring Cloud Gateway 사용자 지정 도메인 리소스 배열 및 다음 집합에 대한 가능한 링크가 포함된 개체
lastModifiedByType	리소스를 마지막으로 수정한 ID의 형식입니다.
SystemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

CloudError

Object

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	서비스의 오류 응답입니다.

CloudErrorBody

Object

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정적이며 프로그래밍 방식으로 사용할 수 있습니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류가 발생한 속성의 이름입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

GatewayCustomDomainProperties

Object

Spring Cloud Gateway에 대한 사용자 지정 도메인의 속성

Name	형식	Description
thumbprint	string	바인딩된 인증서의 지문입니다.

GatewayCustomDomainResource

Object

Spring Cloud Gateway의 사용자 지정 도메인

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다.
name	string	리소스의 이름입니다.
properties	GatewayCustomDomainProperties	Spring Cloud Gateway에 대한 사용자 지정 도메인의 속성
systemData	SystemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
type	string	리소스의 형식입니다.

GatewayCustomDomainResourceCollection

Object

Spring Cloud Gateway 사용자 지정 도메인 리소스 배열 및 다음 집합에 대한 가능한 링크가 포함된 개체

Name	형식	Description
nextLink	string	URL 클라이언트는 다음 페이지(서버 쪽 페이징당)를 가져오는 데 사용해야 합니다. 지금은 null이며 나중에 사용할 수 있게 추가되었습니다.
value	GatewayCustomDomainResource[]	Spring Cloud Gateway 사용자 지정 도메인 리소스 컬렉션

lastModifiedByType

열거형

리소스를 마지막으로 수정한 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

SystemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 수정의 타임스탬프(UTC)입니다.
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	lastModifiedByType	리소스를 마지막으로 수정한 ID의 형식입니다.

다음을 통해 공유

Gateway Custom Domains - List

URI 매개 변수

응답

보안

azure_auth

범위

예제

GatewayCustomDomains_List

샘플 요청

샘플 응답

정의

CloudError

CloudErrorBody

createdByType

GatewayCustomDomainProperties

GatewayCustomDomainResource

GatewayCustomDomainResourceCollection

lastModifiedByType

SystemData