Freigeben über

ApiRelease interface

  • Referenz
Paket:
@azure/arm-apimanagement

Schnittstelle, die eine ApiRelease darstellt.

Methoden

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

Erstellt eine neue Version für die API.
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

Löscht die angegebene Version in der API.
get(string, string, string, string, ApiReleaseGetOptionalParams)

Gibt die Details einer API-Version zurück.
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

Gibt das Etag einer API-Version zurück.
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Listet alle Versionen einer API auf. Beim Aktuellen Erstellen einer API-Revision wird eine API-Version erstellt. Versionen werden auch verwendet, um ein Rollback auf frühere Überarbeitungen zu erstellen. Die Ergebnisse werden ausgelagert und können durch die Parameter $top und $skip eingeschränkt werden.
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Aktualisiert die Details der Veröffentlichung der API, die durch den Bezeichner angegeben wird.

Details zur Methode

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

Erstellt eine neue Version für die API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

apiId

string

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

releaseId

string

Release-ID innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

parameters
ApiReleaseContract

Erstellen Sie Parameter.

options
ApiReleaseCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiReleaseCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

Löscht die angegebene Version in der API.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

apiId

string

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

releaseId

string

Release-ID innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz 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 bedingungslose Aktualisierung sein.

options
ApiReleaseDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, ApiReleaseGetOptionalParams)

Gibt die Details einer API-Version zurück.

function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

apiId

string

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

releaseId

string

Release-ID innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options
ApiReleaseGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiReleaseGetResponse>

getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

Gibt das Etag einer API-Version zurück.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

apiId

string

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

releaseId

string

Release-ID innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options
ApiReleaseGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Listet alle Versionen einer API auf. Beim Aktuellen Erstellen einer API-Revision wird eine API-Version erstellt. Versionen werden auch verwendet, um ein Rollback auf frühere Überarbeitungen zu erstellen. Die Ergebnisse werden ausgelagert und können durch die Parameter $top und $skip eingeschränkt werden.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

apiId

string

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options
ApiReleaseListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Aktualisiert die Details der Veröffentlichung der API, die durch den Bezeichner angegeben wird.

function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

apiId

string

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

releaseId

string

Release-ID innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz 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 bedingungslose Aktualisierung sein.

parameters
ApiReleaseContract

Parameter für API Release Update.

options
ApiReleaseUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiReleaseUpdateResponse>