ApiWiki interface
ApiWiki를 나타내는 인터페이스입니다.
메서드
| create |
API에 대한 새 Wiki를 만들거나 기존 Wiki를 업데이트합니다. |
| delete(string, string, string, string, Api |
API에서 지정된 Wiki를 삭제합니다. |
| get(string, string, string, Api |
식별자가 지정한 API에 대한 Wiki의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 API에 대한 Wiki의 Etag(엔터티 상태) 버전을 가져옵니다. |
| update(string, string, string, string, Wiki |
식별자가 지정한 API에 대한 Wiki의 세부 정보를 업데이트합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)
API에 대한 새 Wiki를 만들거나 기존 Wiki를 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- WikiContract
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<ApiWikiCreateOrUpdateResponse>
delete(string, string, string, string, ApiWikiDeleteOptionalParams)
API에서 지정된 Wiki를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiWikiDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- ApiWikiDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, ApiWikiGetOptionalParams)
식별자가 지정한 API에 대한 Wiki의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- options
- ApiWikiGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiWikiGetResponse>
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)
식별자가 지정한 API에 대한 Wiki의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<ApiWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)
식별자가 지정한 API에 대한 Wiki의 세부 정보를 업데이트합니다.
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- WikiUpdateContract
Wiki 업데이트 매개 변수입니다.
- options
- ApiWikiUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiWikiUpdateResponse>