Documentation interface
설명서를 나타내는 인터페이스입니다.
메서드
| create |
새 설명서를 만들거나 기존 설명서를 업데이트합니다. |
| delete(string, string, string, string, Documentation |
API에서 지정된 설명서를 삭제합니다. |
| get(string, string, string, Documentation |
식별자가 지정한 설명서의 세부 정보를 가져옵니다. |
| get |
식별자를 통해 설명서의 엔터티 상태(Etag) 버전을 가져옵니다. |
| list |
API Management 서비스 인스턴스의 모든 설명서를 나열합니다. |
| update(string, string, string, string, Documentation |
식별자가 지정한 API에 대한 설명서의 세부 정보를 업데이트. |
메서드 세부 정보
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
새 설명서를 만들거나 기존 설명서를 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- documentationId
-
string
설명서 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- parameters
- DocumentationContract
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
API에서 지정된 설명서를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- documentationId
-
string
설명서 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
식별자가 지정한 설명서의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- documentationId
-
string
설명서 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- DocumentationGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
식별자를 통해 설명서의 엔터티 상태(Etag) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- documentationId
-
string
설명서 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
API Management 서비스 인스턴스의 모든 설명서를 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
식별자가 지정한 API에 대한 설명서의 세부 정보를 업데이트.
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- documentationId
-
string
설명서 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- DocumentationUpdateContract
설명서 업데이트 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<DocumentationUpdateResponse>