ApiPortals interface

Balíček:

@azure/arm-appplatform

Rozhraní představující rozhraní ApiPortals

Metody

beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)	Vytvořte výchozí portál rozhraní API nebo aktualizujte existující portál rozhraní API.
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)	Vytvořte výchozí portál rozhraní API nebo aktualizujte existující portál rozhraní API.
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)	Odstraňte výchozí portál rozhraní API.
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)	Odstraňte výchozí portál rozhraní API.
get(string, string, string, ApiPortalsGetOptionalParams)	Získejte portál rozhraní API a jeho vlastnosti.
list(string, string, ApiPortalsListOptionalParams)	Zpracovává žádosti o výpis všech prostředků ve službě.
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)	Zkontrolujte, jestli jsou domény platné a nepoužívají se.

Podrobnosti metody

beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)

Vytvořte výchozí portál rozhraní API nebo aktualizujte existující portál rozhraní API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

apiPortalName

string

Název portálu rozhraní API.

apiPortalResource

ApiPortalResource

Portál rozhraní API pro operaci vytvoření nebo aktualizace

options

ApiPortalsCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>

beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)

Vytvořte výchozí portál rozhraní API nebo aktualizujte existující portál rozhraní API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

apiPortalName

string

Název portálu rozhraní API.

apiPortalResource

ApiPortalResource

Portál rozhraní API pro operaci vytvoření nebo aktualizace

options

ApiPortalsCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiPortalResource>

beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)

Odstraňte výchozí portál rozhraní API.

function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

apiPortalName

string

Název portálu rozhraní API.

options

ApiPortalsDeleteOptionalParams

Parametry možností.

Návraty

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)

Odstraňte výchozí portál rozhraní API.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

apiPortalName

string

Název portálu rozhraní API.

options

ApiPortalsDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, ApiPortalsGetOptionalParams)

Získejte portál rozhraní API a jeho vlastnosti.

function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

apiPortalName

string

Název portálu rozhraní API.

options

ApiPortalsGetOptionalParams

Parametry možností.

Návraty

Promise<ApiPortalResource>

list(string, string, ApiPortalsListOptionalParams)

Zpracovává žádosti o výpis všech prostředků ve službě.

function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

options

ApiPortalsListOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>

validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)

Zkontrolujte, jestli jsou domény platné a nepoužívají se.

function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serviceName

string

Název prostředku služby.

apiPortalName

string

Název portálu rozhraní API.

validatePayload

CustomDomainValidatePayload

Datová část vlastní domény, která se má ověřit

options

ApiPortalsValidateDomainOptionalParams

Parametry možností.

Návraty

Promise<CustomDomainValidateResult>