ApiPortals interface
ApiPortals를 나타내는 인터페이스입니다.
메서드
| begin |
기본 API 포털을 만들거나 기존 API 포털을 업데이트합니다. |
| begin |
기본 API 포털을 만들거나 기존 API 포털을 업데이트합니다. |
| begin |
기본 API 포털을 삭제합니다. |
| begin |
기본 API 포털을 삭제합니다. |
| get(string, string, string, Api |
API 포털 및 해당 속성을 가져옵니다. |
| list(string, string, Api |
서비스의 모든 리소스를 나열하는 요청을 처리합니다. |
| validate |
도메인이 유효하고 사용되지 않는지 확인합니다. |
메서드 세부 정보
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
기본 API 포털을 만들거나 기존 API 포털을 업데이트합니다.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- apiPortalName
-
string
API 포털의 이름입니다.
- apiPortalResource
- ApiPortalResource
만들기 또는 업데이트 작업을 위한 API 포털
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
기본 API 포털을 만들거나 기존 API 포털을 업데이트합니다.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- apiPortalName
-
string
API 포털의 이름입니다.
- apiPortalResource
- ApiPortalResource
만들기 또는 업데이트 작업을 위한 API 포털
옵션 매개 변수입니다.
반환
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
기본 API 포털을 삭제합니다.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- apiPortalName
-
string
API 포털의 이름입니다.
- options
- ApiPortalsDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
기본 API 포털을 삭제합니다.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- apiPortalName
-
string
API 포털의 이름입니다.
- options
- ApiPortalsDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
API 포털 및 해당 속성을 가져옵니다.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- apiPortalName
-
string
API 포털의 이름입니다.
- options
- ApiPortalsGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
서비스의 모든 리소스를 나열하는 요청을 처리합니다.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- options
- ApiPortalsListOptionalParams
옵션 매개 변수입니다.
반환
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
도메인이 유효하고 사용되지 않는지 확인합니다.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>매개 변수
- resourceGroupName
-
string
리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
- serviceName
-
string
서비스 리소스의 이름입니다.
- apiPortalName
-
string
API 포털의 이름입니다.
- validatePayload
- CustomDomainValidatePayload
유효성을 검사할 사용자 지정 도메인 페이로드
옵션 매개 변수입니다.
반환
Promise<CustomDomainValidateResult>