ApiPortals interface
Interfaccia che rappresenta un ApiPortals.
Metodi
| begin |
Creare il portale API predefinito o aggiornare il portale API esistente. |
| begin |
Creare il portale API predefinito o aggiornare il portale API esistente. |
| begin |
Eliminare il portale API predefinito. |
| begin |
Eliminare il portale API predefinito. |
| get(string, string, string, Api |
Ottenere il portale API e le relative proprietà. |
| list(string, string, Api |
Gestisce le richieste per elencare tutte le risorse in un servizio. |
| validate |
Controllare che i domini siano validi e non in uso. |
Dettagli metodo
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Creare il portale API predefinito o aggiornare il portale API esistente.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- apiPortalName
-
string
Nome del portale API.
- apiPortalResource
- ApiPortalResource
Portale API per l'operazione di creazione o aggiornamento
Parametri delle opzioni.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Creare il portale API predefinito o aggiornare il portale API esistente.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- apiPortalName
-
string
Nome del portale API.
- apiPortalResource
- ApiPortalResource
Portale API per l'operazione di creazione o aggiornamento
Parametri delle opzioni.
Restituisce
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Eliminare il portale API predefinito.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- apiPortalName
-
string
Nome del portale API.
- options
- ApiPortalsDeleteOptionalParams
Parametri delle opzioni.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Eliminare il portale API predefinito.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- apiPortalName
-
string
Nome del portale API.
- options
- ApiPortalsDeleteOptionalParams
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Ottenere il portale API e le relative proprietà.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- apiPortalName
-
string
Nome del portale API.
- options
- ApiPortalsGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Gestisce le richieste per elencare tutte le risorse in un servizio.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- options
- ApiPortalsListOptionalParams
Parametri delle opzioni.
Restituisce
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Controllare che i domini siano validi e non in uso.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
- serviceName
-
string
Nome della risorsa servizio.
- apiPortalName
-
string
Nome del portale API.
- validatePayload
- CustomDomainValidatePayload
Payload di dominio personalizzato da convalidare
Parametri delle opzioni.
Restituisce
Promise<CustomDomainValidateResult>