ApiPortals interface
Gränssnitt som representerar en ApiPortals.
Metoder
| begin |
Skapa standard-API-portalen eller uppdatera den befintliga API-portalen. |
| begin |
Skapa standard-API-portalen eller uppdatera den befintliga API-portalen. |
| begin |
Ta bort standard-API-portalen. |
| begin |
Ta bort standard-API-portalen. |
| get(string, string, string, Api |
Hämta API-portalen och dess egenskaper. |
| list(string, string, Api |
Hanterar begäranden om att visa en lista över alla resurser i en tjänst. |
| validate |
Kontrollera att domänerna är giltiga och inte används. |
Metodinformation
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Skapa standard-API-portalen eller uppdatera den befintliga API-portalen.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- apiPortalName
-
string
Namnet på API-portalen.
- apiPortalResource
- ApiPortalResource
API-portalen för åtgärden skapa eller uppdatera
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Skapa standard-API-portalen eller uppdatera den befintliga API-portalen.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- apiPortalName
-
string
Namnet på API-portalen.
- apiPortalResource
- ApiPortalResource
API-portalen för åtgärden skapa eller uppdatera
Alternativparametrarna.
Returer
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Ta bort standard-API-portalen.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- apiPortalName
-
string
Namnet på API-portalen.
- options
- ApiPortalsDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Ta bort standard-API-portalen.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- apiPortalName
-
string
Namnet på API-portalen.
- options
- ApiPortalsDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Hämta API-portalen och dess egenskaper.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- apiPortalName
-
string
Namnet på API-portalen.
- options
- ApiPortalsGetOptionalParams
Alternativparametrarna.
Returer
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Hanterar begäranden om att visa en lista över alla resurser i en tjänst.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- options
- ApiPortalsListOptionalParams
Alternativparametrarna.
Returer
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Kontrollera att domänerna är giltiga och inte används.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
- serviceName
-
string
Namnet på tjänstresursen.
- apiPortalName
-
string
Namnet på API-portalen.
- validatePayload
- CustomDomainValidatePayload
Nyttolast för anpassad domän som ska verifieras
Alternativparametrarna.
Returer
Promise<CustomDomainValidateResult>
