ApiPortals interface

Interface representing a ApiPortals.

Methods

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

Create the default API portal or update the existing API portal.

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

Create the default API portal or update the existing API portal.

beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)

Delete the default API portal.

beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)

Delete the default API portal.

get(string, string, string, ApiPortalsGetOptionalParams)

Get the API portal and its properties.

list(string, string, ApiPortalsListOptionalParams)

Handles requests to list all resources in a Service.

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

Check the domains are valid as well as not in use.

Method Details

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

Create the default API portal or update the existing API portal.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

apiPortalName

string

The name of API portal.

apiPortalResource
ApiPortalResource

The API portal for the create or update operation

options
ApiPortalsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

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

Create the default API portal or update the existing API portal.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

apiPortalName

string

The name of API portal.

apiPortalResource
ApiPortalResource

The API portal for the create or update operation

options
ApiPortalsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)

Delete the default API portal.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

apiPortalName

string

The name of API portal.

options
ApiPortalsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)

Delete the default API portal.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

apiPortalName

string

The name of API portal.

options
ApiPortalsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ApiPortalsGetOptionalParams)

Get the API portal and its properties.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

apiPortalName

string

The name of API portal.

options
ApiPortalsGetOptionalParams

The options parameters.

Returns

list(string, string, ApiPortalsListOptionalParams)

Handles requests to list all resources in a Service.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

options
ApiPortalsListOptionalParams

The options parameters.

Returns

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

Check the domains are valid as well as not in use.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

apiPortalName

string

The name of API portal.

validatePayload
CustomDomainValidatePayload

Custom domain payload to be validated

options
ApiPortalsValidateDomainOptionalParams

The options parameters.

Returns