ApiPortalsImpl | @azure/arm-appplatform

Class containing ApiPortals operations.

Hierarchy

ApiPortalsImpl

Implements

ApiPortals

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiPortalsImpl(client: AppPlatformManagementClient): ApiPortalsImpl

- Defined in operations/apiPortals.ts:36
Initialize a new instance of the class ApiPortals class.

Parameters
- client: AppPlatformManagementClient
  
  Reference to the service client
Returns ApiPortalsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ApiPortalsCreateOrUpdateResponse>, ApiPortalsCreateOrUpdateResponse>>

Implementation of ApiPortals.beginCreateOrUpdate
- Defined in operations/apiPortals.ts:135
Create the default API portal or update the existing API portal.

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
- Optional options: ApiPortalsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiPortalsCreateOrUpdateResponse>, ApiPortalsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of ApiPortals.beginCreateOrUpdateAndWait
- Defined in operations/apiPortals.ts:214
Create the default API portal or update the existing API portal.

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
- Optional options: ApiPortalsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiPortalsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of ApiPortals.beginDelete
- Defined in operations/apiPortals.ts:239
Delete the default API portal.

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.
- Optional options: ApiPortalsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of ApiPortals.beginDeleteAndWait
- Defined in operations/apiPortals.ts:305
Delete the default API portal.

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.
- Optional options: ApiPortalsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of ApiPortals.get
- Defined in operations/apiPortals.ts:114
Get the API portal and its properties.

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.
- Optional options: ApiPortalsGetOptionalParams
  
  The options parameters.
Returns Promise<ApiPortalsGetResponse>

list

list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource>

Implementation of ApiPortals.list
- Defined in operations/apiPortals.ts:53
Handles requests to list all resources in a Service.

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.
- Optional options: ApiPortalsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiPortalResource>

validateDomain

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

Implementation of ApiPortals.validateDomain
- Defined in operations/apiPortals.ts:347
Check the domains are valid as well as not in use.

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
- Optional options: ApiPortalsValidateDomainOptionalParams
  
  The options parameters.
Returns Promise<ApiPortalsValidateDomainResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: AppPlatformManagementClient

Returns ApiPortalsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

apiPortalResource: ApiPortalResource

Optional options: ApiPortalsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiPortalsCreateOrUpdateResponse>, ApiPortalsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

apiPortalResource: ApiPortalResource

Optional options: ApiPortalsCreateOrUpdateOptionalParams

Returns Promise<ApiPortalsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

Optional options: ApiPortalsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

Optional options: ApiPortalsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

Optional options: ApiPortalsGetOptionalParams

Returns Promise<ApiPortalsGetResponse>

list

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiPortalsListOptionalParams

Returns PagedAsyncIterableIterator<ApiPortalResource>

validateDomain

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

validatePayload: CustomDomainValidatePayload

Optional options: ApiPortalsValidateDomainOptionalParams

Returns Promise<ApiPortalsValidateDomainResponse>