ApiWiki interface
Rozhraní představující ApiWiki.
Metody
create |
Vytvoří nový wikiweb pro rozhraní API nebo aktualizuje existující. |
delete(string, string, string, string, Api |
Odstraní zadaný wikiweb z rozhraní API. |
get(string, string, string, Api |
Získá podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem. |
get |
Získá stav entity (Etag) verze wikiwebu pro rozhraní API určené jeho identifikátorem. |
update(string, string, string, string, Wiki |
Aktualizace podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem. |
Podrobnosti metody
createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)
Vytvoří nový wikiweb pro rozhraní API nebo aktualizuje existující.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>
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.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- parameters
- WikiContract
Vytvořte parametry.
Parametry možností
Návraty
Promise<ApiWikiCreateOrUpdateResponse>
delete(string, string, string, string, ApiWikiDeleteOptionalParams)
Odstraní zadaný wikiweb z rozhraní API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiWikiDeleteOptionalParams): 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.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- 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 bezpodmínečnou aktualizaci.
- options
- ApiWikiDeleteOptionalParams
Parametry možností
Návraty
Promise<void>
get(string, string, string, ApiWikiGetOptionalParams)
Získá podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem.
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>
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.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- options
- ApiWikiGetOptionalParams
Parametry možností
Návraty
Promise<ApiWikiGetResponse>
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)
Získá stav entity (Etag) verze wikiwebu pro rozhraní API určené jeho identifikátorem.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>
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.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
Parametry možností
Návraty
Promise<ApiWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)
Aktualizace podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem.
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>
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.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby Gestione API musí být jedinečná.
- 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 bezpodmínečnou aktualizaci.
- parameters
- WikiUpdateContract
Parametry aktualizace wikiwebu
- options
- ApiWikiUpdateOptionalParams
Parametry možností
Návraty
Promise<ApiWikiUpdateResponse>