Freigeben über

ApiDiagnostic interface

  • Referenz
Paket:
@azure/arm-apimanagement

Schnittstelle, die eine ApiDiagnostic darstellt.

Methoden

createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)

Erstellt eine neue Diagnose für eine API oder aktualisiert eine bereits vorhandene
delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)

Löscht die angegebene Diagnose aus einer API
get(string, string, string, string, ApiDiagnosticGetOptionalParams)

Ruft die Details der Diagnose für eine API ab, die durch ihren Bezeichner angegeben wird.
getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) der Diagnose für eine API ab, die durch den Bezeichner angegeben wird.
listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)

Listet alle Diagnosen einer API auf
update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)

Updates die Details der Diagnose für eine API, die durch ihren Bezeichner angegeben wird.

Details zur Methode

createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)

Erstellt eine neue Diagnose für eine API oder aktualisiert eine bereits vorhandene

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, parameters: DiagnosticContract, options?: ApiDiagnosticCreateOrUpdateOptionalParams): Promise<ApiDiagnosticCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

diagnosticId

string

Diagnosebezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

parameters
DiagnosticContract

Erstellen Sie Parameter.

options
ApiDiagnosticCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDiagnosticCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)

Löscht die angegebene Diagnose aus einer API

function delete(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, options?: ApiDiagnosticDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

diagnosticId

string

Diagnosebezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

options
ApiDiagnosticDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, ApiDiagnosticGetOptionalParams)

Ruft die Details der Diagnose für eine API ab, die durch ihren Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetOptionalParams): Promise<ApiDiagnosticGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

diagnosticId

string

Diagnosebezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options
ApiDiagnosticGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDiagnosticGetResponse>

getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) der Diagnose für eine API ab, die durch den Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetEntityTagOptionalParams): Promise<ApiDiagnosticGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

diagnosticId

string

Diagnosebezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options
ApiDiagnosticGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDiagnosticGetEntityTagHeaders>

listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)

Listet alle Diagnosen einer API auf

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiDiagnosticListByServiceOptionalParams): PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options
ApiDiagnosticListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>

update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)

Updates die Details der Diagnose für eine API, die durch ihren Bezeichner angegeben wird.

function update(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: ApiDiagnosticUpdateOptionalParams): Promise<ApiDiagnosticUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

diagnosticId

string

Diagnosebezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

parameters
DiagnosticContract

Diagnoseupdateparameter.

options
ApiDiagnosticUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDiagnosticUpdateResponse>