ApiDefinitions interface
ApiDefinitions를 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
API 사양을 내보냅니다.
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
API 사양을 내보냅니다.
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
API 사양을 가져옵니다.
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
- body
- ApiSpecImportRequest
작업 요청의 내용
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
API 사양을 가져옵니다.
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
- body
- ApiSpecImportRequest
작업 요청의 내용
옵션 매개 변수입니다.
반환
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
새 API 정의를 만들거나 기존 API 정의를 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
- resource
- ApiDefinition
리소스 만들기 매개 변수.
옵션 매개 변수입니다.
반환
Promise<ApiDefinitionsCreateOrUpdateResponse>
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)
지정된 API 정의를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)
API 정의의 세부 정보를 반환합니다.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
- options
- ApiDefinitionsGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiDefinitionsGetResponse>
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)
지정된 API 정의가 있는지 확인합니다.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- definitionName
-
string
API 정의의 이름입니다.
- options
- ApiDefinitionsHeadOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiDefinitionsHeadResponse>
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)
API 정의 컬렉션을 반환합니다.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
Azure API Center 서비스의 이름입니다.
- workspaceName
-
string
작업 영역의 이름
- apiName
-
string
API 이름입니다.
- versionName
-
string
API 버전의 이름입니다.
- options
- ApiDefinitionsListOptionalParams
옵션 매개 변수입니다.