Package version:

Interface ApiPortals

Interface representing a ApiPortals.

Hierarchy

ApiPortals

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get list validateDomain

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ApiPortalResource>, ApiPortalResource>>
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<ApiPortalResource>, ApiPortalResource>>
- Defined in operationsInterfaces/apiPortals.ts:62

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>
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<ApiPortalResource>
- Defined in operationsInterfaces/apiPortals.ts:83

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/apiPortals.ts:98

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/apiPortals.ts:112

get

get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>
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<ApiPortalResource>
- Defined in operationsInterfaces/apiPortals.ts:47

list

list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource>
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>
- Defined in operationsInterfaces/apiPortals.ts:34

validateDomain

validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>
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<CustomDomainValidateResult>
- Defined in operationsInterfaces/apiPortals.ts:127

Interface ApiPortals

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

apiPortalResource: ApiPortalResource

Optional options: ApiPortalsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiPortalResource>, ApiPortalResource>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

apiPortalResource: ApiPortalResource

Optional options: ApiPortalsCreateOrUpdateOptionalParams

Returns Promise<ApiPortalResource>

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<ApiPortalResource>

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<CustomDomainValidateResult>

Settings

Member Visibility

Theme

`Optional` options: ApiPortalsCreateOrUpdateOptionalParams

`Optional` options: ApiPortalsCreateOrUpdateOptionalParams

`Optional` options: ApiPortalsDeleteOptionalParams

`Optional` options: ApiPortalsDeleteOptionalParams

`Optional` options: ApiPortalsGetOptionalParams

`Optional` options: ApiPortalsListOptionalParams

`Optional` options: ApiPortalsValidateDomainOptionalParams