Freigeben über

ApiRelease interface

  • Referenz
Paket:
@azure/arm-apimanagement

Schnittstelle, die eine ApiRelease darstellt.

Methoden

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

Erstellt ein neues Release 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 Releases einer API auf. Ein API-Release wird erstellt, wenn Sie eine API-Revision zur aktuellen machen. Releases werden auch für einen Rollback zu früheren Revisionen verwendet. Die Ergebnisse werden seitenweise ausgegeben und können mit den Parametern $top und $skip eingeschränkt werden.
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Updates die Details der Veröffentlichung der API, die durch ihren Bezeichner angegeben wird.

Details zur Methode

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

Erstellt ein neues Release 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. 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.

releaseId

string

Freigabebezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance 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. 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.

releaseId

string

Freigabebezeichner innerhalb einer API. 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 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. 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.

releaseId

string

Freigabebezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance 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. 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.

releaseId

string

Freigabebezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance eindeutig sein.

options
ApiReleaseGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Listet alle Releases einer API auf. Ein API-Release wird erstellt, wenn Sie eine API-Revision zur aktuellen machen. Releases werden auch für einen Rollback zu früheren Revisionen verwendet. Die Ergebnisse werden seitenweise ausgegeben und können mit den Parametern $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. 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
ApiReleaseListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

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

Updates die Details der Veröffentlichung der API, die durch ihren 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. 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.

releaseId

string

Freigabebezeichner innerhalb einer API. 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 bedingungslose Aktualisierung sein.

parameters
ApiReleaseContract

API Release Update-Parameter.

options
ApiReleaseUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiReleaseUpdateResponse>