ApiDiagnostic interface
表示 ApiDiagnostic 的介面。
方法
| create |
為 API 建立新的診斷，或更新現有的診斷。 |
| delete(string, string, string, string, string, Api |
從 API 刪除指定的診斷。 |
| get(string, string, string, string, Api |
取得其識別碼所指定 API 的診斷詳細資料。 |
| get |
取得 Etag 的實體狀態 (Etag) 其識別碼所指定之 API 的診斷版本。 |
| list |
列出 API 的所有診斷。 |
| update(string, string, string, string, string, Diagnostic |
更新其識別碼所指定 API 的診斷詳細資料。 |
方法詳細資料
createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)
為 API 建立新的診斷，或更新現有的診斷。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, parameters: DiagnosticContract, options?: ApiDiagnosticCreateOrUpdateOptionalParams): Promise<ApiDiagnosticCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- diagnosticId
-
string
診斷識別碼。 在目前API 管理服務實例中必須是唯一的。
- parameters
- DiagnosticContract
建立參數。
選項參數。
傳回
Promise<ApiDiagnosticCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)
從 API 刪除指定的診斷。
function delete(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, options?: ApiDiagnosticDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- diagnosticId
-
string
診斷識別碼。 在目前API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, string, ApiDiagnosticGetOptionalParams)
取得其識別碼所指定 API 的診斷詳細資料。
function get(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetOptionalParams): Promise<ApiDiagnosticGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- diagnosticId
-
string
診斷識別碼。 在目前API 管理服務實例中必須是唯一的。
- options
- ApiDiagnosticGetOptionalParams
選項參數。
傳回
Promise<ApiDiagnosticGetResponse>
getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)
取得 Etag 的實體狀態 (Etag) 其識別碼所指定之 API 的診斷版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetEntityTagOptionalParams): Promise<ApiDiagnosticGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- diagnosticId
-
string
診斷識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<ApiDiagnosticGetEntityTagHeaders>
listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)
列出 API 的所有診斷。
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiDiagnosticListByServiceOptionalParams): PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)
更新其識別碼所指定 API 的診斷詳細資料。
function update(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: ApiDiagnosticUpdateOptionalParams): Promise<ApiDiagnosticUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- diagnosticId
-
string
診斷識別碼。 在目前API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
- parameters
- DiagnosticContract
診斷更新參數。
選項參數。
傳回
Promise<ApiDiagnosticUpdateResponse>