你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Documentation interface
表示文档的接口。
方法
| create |
创建新的文档或更新现有文档。 |
| delete(string, string, string, string, Documentation |
从 API 中删除指定的文档。 |
| get(string, string, string, Documentation |
获取由其标识符指定的文档的详细信息。 |
| get |
按标识符获取文档) 版本的实体状态 (Etag。 |
| list |
列出 API 管理服务实例的所有文档。 |
| 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 管理服务的名称。
- documentationId
-
string
文档标识符。 在当前API 管理服务实例中必须是唯一的。
- 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 管理服务的名称。
- documentationId
-
string
文档标识符。 在当前API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
选项参数。
返回
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
获取由其标识符指定的文档的详细信息。
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- documentationId
-
string
文档标识符。 在当前API 管理服务实例中必须是唯一的。
- 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 管理服务的名称。
- documentationId
-
string
文档标识符。 在当前API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
列出 API 管理服务实例的所有文档。
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
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 管理服务的名称。
- documentationId
-
string
文档标识符。 在当前API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
- parameters
- DocumentationUpdateContract
文档 更新参数。
选项参数。
返回
Promise<DocumentationUpdateResponse>