Freigeben über


ApiPortals interface

Schnittstelle, die ein ApiPortals darstellt.

Methoden

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

Erstellen Sie das Standard-API-Portal, oder aktualisieren Sie das vorhandene API-Portal.

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

Erstellen Sie das Standard-API-Portal, oder aktualisieren Sie das vorhandene API-Portal.

beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)

Löschen Sie das Standard-API-Portal.

beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)

Löschen Sie das Standard-API-Portal.

get(string, string, string, ApiPortalsGetOptionalParams)

Rufen Sie das API-Portal und die zugehörigen Eigenschaften ab.

list(string, string, ApiPortalsListOptionalParams)

Verarbeitet Anforderungen, um alle Ressourcen in einem Dienst aufzulisten.

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

Überprüfen Sie, ob die Domänen gültig sind und nicht verwendet werden.

Details zur Methode

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

Erstellen Sie das Standard-API-Portal, oder aktualisieren Sie das vorhandene API-Portal.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

apiPortalName

string

Der Name des API-Portals.

apiPortalResource
ApiPortalResource

Das API-Portal für den Erstellungs- oder Aktualisierungsvorgang

options
ApiPortalsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

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

Erstellen Sie das Standard-API-Portal, oder aktualisieren Sie das vorhandene API-Portal.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

apiPortalName

string

Der Name des API-Portals.

apiPortalResource
ApiPortalResource

Das API-Portal für den Erstellungs- oder Aktualisierungsvorgang

options
ApiPortalsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)

Löschen Sie das Standard-API-Portal.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

apiPortalName

string

Der Name des API-Portals.

options
ApiPortalsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)

Löschen Sie das Standard-API-Portal.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

apiPortalName

string

Der Name des API-Portals.

options
ApiPortalsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, ApiPortalsGetOptionalParams)

Rufen Sie das API-Portal und die zugehörigen Eigenschaften ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

apiPortalName

string

Der Name des API-Portals.

options
ApiPortalsGetOptionalParams

Die Optionsparameter.

Gibt zurück

list(string, string, ApiPortalsListOptionalParams)

Verarbeitet Anforderungen, um alle Ressourcen in einem Dienst aufzulisten.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

options
ApiPortalsListOptionalParams

Die Optionsparameter.

Gibt zurück

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

Überprüfen Sie, ob die Domänen gültig sind und nicht verwendet werden.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serviceName

string

Der Name der Dienstressource.

apiPortalName

string

Der Name des API-Portals.

validatePayload
CustomDomainValidatePayload

Zu überprüfende benutzerdefinierte Domänennutzlast

options
ApiPortalsValidateDomainOptionalParams

Die Optionsparameter.

Gibt zurück