ApiWiki interface
Interface die een ApiWiki vertegenwoordigt.
Methoden
| create |
Hiermee maakt u een nieuwe wiki voor een API of werkt u een bestaande wiki bij. |
| delete(string, string, string, string, Api |
Hiermee verwijdert u de opgegeven wiki uit een API. |
| get(string, string, string, Api |
Hiermee haalt u de details van de Wiki op voor een API die is opgegeven door de id. |
| get |
Haalt de versie van de entiteitsstatus (Etag) van de Wiki op voor een API die is opgegeven door de id. |
| update(string, string, string, string, Wiki |
Updates de details van de Wiki voor een API die is opgegeven door de id. |
Methodedetails
createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)
Hiermee maakt u een nieuwe wiki voor een API of werkt u een bestaande wiki bij.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>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.
- parameters
- WikiContract
Parameters maken.
De optiesparameters.
Retouren
Promise<ApiWikiCreateOrUpdateResponse>
delete(string, string, string, string, ApiWikiDeleteOptionalParams)
Hiermee verwijdert u de opgegeven wiki uit een API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiWikiDeleteOptionalParams): 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.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- options
- ApiWikiDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, ApiWikiGetOptionalParams)
Hiermee haalt u de details van de Wiki op voor een API die is opgegeven door de id.
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>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.
- options
- ApiWikiGetOptionalParams
De optiesparameters.
Retouren
Promise<ApiWikiGetResponse>
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)
Haalt de versie van de entiteitsstatus (Etag) van de Wiki op voor een API die is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>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
Promise<ApiWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)
Updates de details van de Wiki voor een API die is opgegeven door de id.
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>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.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- parameters
- WikiUpdateContract
Wiki Update-parameters.
- options
- ApiWikiUpdateOptionalParams
De optiesparameters.
Retouren
Promise<ApiWikiUpdateResponse>