Documentation interface
Interfaccia che rappresenta una documentazione.
Metodi
| create |
Crea una nuova documentazione o aggiorna una esistente. |
| delete(string, string, string, string, Documentation |
Elimina la documentazione specificata da un'API. |
| get(string, string, string, Documentation |
Ottiene i dettagli della documentazione specificata dall'identificatore. |
| get |
Ottiene la versione dello stato dell'entità (Etag) della documentazione in base al relativo identificatore. |
| list |
Elenca tutte le documentazioni dell'istanza del servizio Gestione API. |
| update(string, string, string, string, Documentation |
Aggiornamenti i dettagli della documentazione per un'API specificata dall'identificatore. |
Dettagli metodo
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
Crea una nuova documentazione o aggiorna una esistente.
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- documentationId
-
string
Identificatore della documentazione. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- parameters
- DocumentationContract
Creare parametri.
Parametri delle opzioni.
Restituisce
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
Elimina la documentazione specificata da un'API.
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- documentationId
-
string
Identificatore della documentazione. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
Ottiene i dettagli della documentazione specificata dall'identificatore.
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- documentationId
-
string
Identificatore della documentazione. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- options
- DocumentationGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) della documentazione in base al relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- documentationId
-
string
Identificatore della documentazione. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
Elenca tutte le documentazioni dell'istanza del servizio Gestione API.
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
Parametri delle opzioni.
Restituisce
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
Aggiornamenti i dettagli della documentazione per un'API specificata dall'identificatore.
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- documentationId
-
string
Identificatore della documentazione. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
- parameters
- DocumentationUpdateContract
Parametri di aggiornamento della documentazione.
Parametri delle opzioni.
Restituisce
Promise<DocumentationUpdateResponse>