Documentation interface
Schnittstelle, die eine Dokumentation darstellt.
Methoden
| create |
Erstellt eine neue Dokumentation oder aktualisiert eine vorhandene Dokumentation. |
| delete(string, string, string, string, Documentation |
Löscht die angegebene Dokumentation aus einer API. |
| get(string, string, string, Documentation |
Ruft die Details der Dokumentation ab, die durch den Bezeichner angegeben wird. |
| get |
Ruft die Entitätsstatusversion (Etag) der Dokumentation anhand ihres Bezeichners ab. |
| list |
Listet alle Dokumentationen des API Management-Diensts instance auf. |
| update(string, string, string, string, Documentation |
Updates die Details der Dokumentation für eine API, die durch ihren Bezeichner angegeben wird. |
Details zur Methode
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
Erstellt eine neue Dokumentation oder aktualisiert eine vorhandene Dokumentation.
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>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.
- documentationId
-
string
Dokumentationsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- parameters
- DocumentationContract
Erstellen Sie Parameter.
Die Optionsparameter.
Gibt zurück
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
Löscht die angegebene Dokumentation aus einer API.
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): 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.
- documentationId
-
string
Dokumentationsbezeichner. 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 die bedingungslose Aktualisierung sein.
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
Ruft die Details der Dokumentation ab, die durch den Bezeichner angegeben wird.
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>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.
- documentationId
-
string
Dokumentationsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- DocumentationGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion (Etag) der Dokumentation anhand ihres Bezeichners ab.
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>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.
- documentationId
-
string
Dokumentationsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
Listet alle Dokumentationen des API Management-Diensts instance auf.
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], 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.
Die Optionsparameter.
Gibt zurück
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
Updates die Details der Dokumentation für eine API, die durch ihren Bezeichner angegeben wird.
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>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.
- documentationId
-
string
Dokumentationsbezeichner. 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 die bedingungslose Aktualisierung sein.
- parameters
- DocumentationUpdateContract
Dokumentation Updateparameter.
Die Optionsparameter.
Gibt zurück
Promise<DocumentationUpdateResponse>