Documentation interface
Interface die een documentatie vertegenwoordigt.
Methoden
| create |
Hiermee maakt u een nieuwe documentatie of werkt u een bestaande documentatie bij. |
| delete(string, string, string, string, Documentation |
Hiermee verwijdert u de opgegeven documentatie uit een API. |
| get(string, string, string, Documentation |
Hiermee haalt u de details op van de documentatie die is opgegeven door de id. |
| get |
Hiermee wordt de versie van de entiteitsstatus (Etag) van de documentatie op basis van de id ervan. |
| list |
Een lijst met alle documentatie van het API Management service-exemplaar. |
| update(string, string, string, string, Documentation |
Updates de details van de documentatie voor een API die is opgegeven door de id. |
Methodedetails
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
Hiermee maakt u een nieuwe documentatie of werkt u een bestaande documentatie bij.
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- documentationId
-
string
Documentatie-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- parameters
- DocumentationContract
Parameters maken.
De optiesparameters.
Retouren
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
Hiermee verwijdert u de opgegeven documentatie uit een API.
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- documentationId
-
string
Documentatie-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 het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
Hiermee haalt u de details op van de documentatie die is opgegeven door de id.
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- documentationId
-
string
Documentatie-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- options
- DocumentationGetOptionalParams
De optiesparameters.
Retouren
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
Hiermee wordt de versie van de entiteitsstatus (Etag) van de documentatie op basis van de id ervan.
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- documentationId
-
string
Documentatie-id. Moet uniek zijn in het huidige API Management service-exemplaar.
De optiesparameters.
Retouren
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
Een lijst met alle documentatie van het API Management service-exemplaar.
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
Updates de details van de documentatie voor een API die is opgegeven door de id.
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- documentationId
-
string
Documentatie-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 het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- parameters
- DocumentationUpdateContract
Documentatie Updateparameters.
De optiesparameters.
Retouren
Promise<DocumentationUpdateResponse>