你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ApiDiagnostic interface
表示 ApiDiagnostic 的接口。
方法
| create |
为 API 创建新诊断，或更新现有诊断。 |
| delete(string, string, string, string, string, Api |
从 API 中删除指定的诊断。 |
| get(string, string, string, string, Api |
获取由标识符指定的 API 的诊断的详细信息。 |
| get |
获取实体状态 (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 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
选项参数。
返回
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) 由标识符指定的 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 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
- parameters
- DiagnosticContract
诊断更新参数。
选项参数。
返回
Promise<ApiDiagnosticUpdateResponse>