Documentation interface
代表文件的介面。
方法
方法詳細資料
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 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
選項參數。
傳回
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 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- DocumentationUpdateContract
檔更新參數。
選項參數。
傳回
Promise<DocumentationUpdateResponse>