Documentation interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující dokumentaci.

Metody

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Vytvoří novou dokumentaci nebo aktualizuje existující dokumentaci.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Odstraní zadanou dokumentaci z rozhraní API.
get(string, string, string, DocumentationGetOptionalParams)	Získá podrobnosti dokumentace určené jeho identifikátor.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Získá stav entity (Etag) verze dokumentace podle jeho identifikátoru.
listByService(string, string, DocumentationListByServiceOptionalParams)	Vypíše veškerou dokumentaci k instanci služby Gestione API.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Aktualizace podrobnosti dokumentace k rozhraní API určenému jeho identifikátorem.

Podrobnosti metody

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Vytvoří novou dokumentaci nebo aktualizuje existující dokumentaci.

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

documentationId

string

Identifikátor dokumentace. Musí být jedinečný v aktuální instanci služby Gestione API.

parameters

DocumentationContract

Vytvořte parametry.

options

DocumentationCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

Odstraní zadanou dokumentaci z rozhraní API.

function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

documentationId

string

Identifikátor dokumentace. Musí být jedinečný v aktuální instanci služby Gestione API.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro nepodmíněnou aktualizaci.

options

DocumentationDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Získá podrobnosti dokumentace určené jeho identifikátor.

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

documentationId

string

Identifikátor dokumentace. Musí být jedinečný v aktuální instanci služby Gestione API.

options

DocumentationGetOptionalParams

Parametry možností.

Návraty

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Získá stav entity (Etag) verze dokumentace podle jeho identifikátoru.

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

documentationId

string

Identifikátor dokumentace. Musí být jedinečný v aktuální instanci služby Gestione API.

options

DocumentationGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Vypíše veškerou dokumentaci k instanci služby Gestione API.

function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

options

DocumentationListByServiceOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Aktualizace podrobnosti dokumentace k rozhraní API určenému jeho identifikátorem.

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

documentationId

string

Identifikátor dokumentace. Musí být jedinečný v aktuální instanci služby Gestione API.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro nepodmíněnou aktualizaci.

parameters

DocumentationUpdateContract

Dokumentace – Parametry aktualizace.

options

DocumentationUpdateOptionalParams

Parametry možností.

Návraty

Promise<DocumentationUpdateResponse>