다음을 통해 공유


Api interface

API를 나타내는 인터페이스입니다.

메서드

beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

API Management 서비스 인스턴스의 지정된 기존 API를 새로 만들거나 업데이트합니다.

beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

API Management 서비스 인스턴스의 지정된 기존 API를 새로 만들거나 업데이트합니다.

delete(string, string, string, string, ApiDeleteOptionalParams)

API Management 서비스 인스턴스의 지정된 API를 삭제합니다.

get(string, string, string, ApiGetOptionalParams)

식별자가 지정한 API의 세부 정보를 가져옵니다.

getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)

식별자에 의해 지정된 API의 엔터티 상태(Etag) 버전을 가져옵니다.

listByService(string, string, ApiListByServiceOptionalParams)

API Management 서비스 인스턴스의 모든 API를 나열합니다.

listByTags(string, string, ApiListByTagsOptionalParams)

태그와 연결된 API의 컬렉션을 나열합니다.

update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)

API Management 서비스 instance 지정된 API를 업데이트.

메서드 세부 정보

beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

API Management 서비스 인스턴스의 지정된 기존 API를 새로 만들거나 업데이트합니다.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

apiId

string

API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.

parameters
ApiCreateOrUpdateParameter

매개 변수를 만들거나 업데이트합니다.

options
ApiCreateOrUpdateOptionalParams

옵션 매개 변수입니다.

반환

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

API Management 서비스 인스턴스의 지정된 기존 API를 새로 만들거나 업데이트합니다.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<ApiCreateOrUpdateResponse>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

apiId

string

API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.

parameters
ApiCreateOrUpdateParameter

매개 변수를 만들거나 업데이트합니다.

options
ApiCreateOrUpdateOptionalParams

옵션 매개 변수입니다.

반환

delete(string, string, string, string, ApiDeleteOptionalParams)

API Management 서비스 인스턴스의 지정된 API를 삭제합니다.

function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): Promise<void>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

apiId

string

API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.

ifMatch

string

엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 조건부 업데이트의 경우 *여야 합니다.

options
ApiDeleteOptionalParams

옵션 매개 변수입니다.

반환

Promise<void>

get(string, string, string, ApiGetOptionalParams)

식별자가 지정한 API의 세부 정보를 가져옵니다.

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetOptionalParams): Promise<ApiGetResponse>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

apiId

string

API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.

options
ApiGetOptionalParams

옵션 매개 변수입니다.

반환

Promise<ApiGetResponse>

getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)

식별자에 의해 지정된 API의 엔터티 상태(Etag) 버전을 가져옵니다.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetEntityTagOptionalParams): Promise<ApiGetEntityTagHeaders>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

apiId

string

API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.

options
ApiGetEntityTagOptionalParams

옵션 매개 변수입니다.

반환

listByService(string, string, ApiListByServiceOptionalParams)

API Management 서비스 인스턴스의 모든 API를 나열합니다.

function listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

options
ApiListByServiceOptionalParams

옵션 매개 변수입니다.

반환

listByTags(string, string, ApiListByTagsOptionalParams)

태그와 연결된 API의 컬렉션을 나열합니다.

function listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

options
ApiListByTagsOptionalParams

옵션 매개 변수입니다.

반환

update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)

API Management 서비스 instance 지정된 API를 업데이트.

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: ApiUpdateOptionalParams): Promise<ApiUpdateResponse>

매개 변수

resourceGroupName

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName

string

API Management 서비스의 이름입니다.

apiId

string

API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.

ifMatch

string

엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 조건부 업데이트의 경우 *여야 합니다.

parameters
ApiUpdateContract

API 업데이트 계약 매개 변수입니다.

options
ApiUpdateOptionalParams

옵션 매개 변수입니다.

반환