ApiRelease interface
Gränssnitt som representerar en ApiRelease.
Metoder
| create |
Skapar en ny version för API:et. |
| delete(string, string, string, string, string, Api |
Tar bort den angivna versionen i API:et. |
| get(string, string, string, string, Api |
Returnerar information om en API-version. |
| get |
Returnerar etag för en API-version. |
| list |
Visar en lista över alla versioner av ett API. En API-version skapas när en API Revision görs aktuell. Versioner används också för att återställa till tidigare revisioner. Resultaten kommer att paged och kan begränsas av parametrarna $top och $skip. |
| update(string, string, string, string, string, Api |
Uppdateringar information om den version av API:et som anges av dess identifierare. |
Metodinformation
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Skapar en ny version för API:et.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- releaseId
-
string
Versionsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- parameters
- ApiReleaseContract
Skapa parametrar.
Alternativparametrarna.
Returer
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Tar bort den angivna versionen i API:et.
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- releaseId
-
string
Versionsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- options
- ApiReleaseDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Returnerar information om en API-version.
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- releaseId
-
string
Versionsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- ApiReleaseGetOptionalParams
Alternativparametrarna.
Returer
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Returnerar etag för en API-version.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- releaseId
-
string
Versionsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
Visar en lista över alla versioner av ett API. En API-version skapas när en API Revision görs aktuell. Versioner används också för att återställa till tidigare revisioner. Resultaten kommer att paged och kan begränsas av parametrarna $top och $skip.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Uppdateringar information om den version av API:et som anges av dess identifierare.
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- releaseId
-
string
Versionsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- parameters
- ApiReleaseContract
Uppdateringsparametrar för API-version.
- options
- ApiReleaseUpdateOptionalParams
Alternativparametrarna.
Returer
Promise<ApiReleaseUpdateResponse>