ApiRelease interface
Interface die een ApiRelease vertegenwoordigt.
Methoden
| create |
Hiermee maakt u een nieuwe release voor de API. |
| delete(string, string, string, string, string, Api |
Hiermee verwijdert u de opgegeven release in de API. |
| get(string, string, string, string, Api |
Retourneert de details van een API-release. |
| get |
Retourneert de etag van een API-release. |
| list |
Een lijst met alle releases van een API. Er wordt een API-release gemaakt wanneer een API-revisie actueel wordt gemaakt. Releases worden ook gebruikt om terug te draaien naar eerdere revisies. Resultaten worden gepaginad en kunnen worden beperkt door de parameters $top en $skip. |
| update(string, string, string, string, string, Api |
Updates de details van de release van de API die is opgegeven door de id. |
Methodedetails
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Hiermee maakt u een nieuwe release voor de API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- releaseId
-
string
Release-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.
- parameters
- ApiReleaseContract
Parameters maken.
De optiesparameters.
Retouren
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Hiermee verwijdert u de opgegeven release in de API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- releaseId
-
string
Release-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- options
- ApiReleaseDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Retourneert de details van een API-release.
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- releaseId
-
string
Release-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.
- options
- ApiReleaseGetOptionalParams
De optiesparameters.
Retouren
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Retourneert de etag van een API-release.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- releaseId
-
string
Release-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.
De optiesparameters.
Retouren
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
Een lijst met alle releases van een API. Er wordt een API-release gemaakt wanneer een API-revisie actueel wordt gemaakt. Releases worden ook gebruikt om terug te draaien naar eerdere revisies. Resultaten worden gepaginad en kunnen worden beperkt door de parameters $top en $skip.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
De optiesparameters.
Retouren
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Updates de details van de release van de API die is opgegeven door de id.
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- releaseId
-
string
Release-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- parameters
- ApiReleaseContract
API Release Update-parameters.
- options
- ApiReleaseUpdateOptionalParams
De optiesparameters.
Retouren
Promise<ApiReleaseUpdateResponse>