ApiPortalCustomDomains | @azure/arm-appplatform

Interface representing a ApiPortalCustomDomains.

Hierarchy

ApiPortalCustomDomains

Implemented by

ApiPortalCustomDomainsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, apiPortalCustomDomainResource: ApiPortalCustomDomainResource, options?: ApiPortalCustomDomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ApiPortalCustomDomainsCreateOrUpdateResponse>, ApiPortalCustomDomainsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/apiPortalCustomDomains.ts:64
Create or update the API portal custom domain.

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.
- domainName: string
  
  The name of the API portal custom domain.
- apiPortalCustomDomainResource: ApiPortalCustomDomainResource
  
  The API portal custom domain for the create or update operation
- Optional options: ApiPortalCustomDomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiPortalCustomDomainsCreateOrUpdateResponse>, ApiPortalCustomDomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, apiPortalCustomDomainResource: ApiPortalCustomDomainResource, options?: ApiPortalCustomDomainsCreateOrUpdateOptionalParams): Promise<ApiPortalCustomDomainsCreateOrUpdateResponse>

- Defined in operationsInterfaces/apiPortalCustomDomains.ts:87
Create or update the API portal custom domain.

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.
- domainName: string
  
  The name of the API portal custom domain.
- apiPortalCustomDomainResource: ApiPortalCustomDomainResource
  
  The API portal custom domain for the create or update operation
- Optional options: ApiPortalCustomDomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiPortalCustomDomainsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/apiPortalCustomDomains.ts:104
Delete the API portal custom domain.

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.
- domainName: string
  
  The name of the API portal custom domain.
- Optional options: ApiPortalCustomDomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/apiPortalCustomDomains.ts:120
Delete the API portal custom domain.

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.
- domainName: string
  
  The name of the API portal custom domain.
- Optional options: ApiPortalCustomDomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, apiPortalName: string, domainName: string, options?: ApiPortalCustomDomainsGetOptionalParams): Promise<ApiPortalCustomDomainsGetResponse>

- Defined in operationsInterfaces/apiPortalCustomDomains.ts:47
Get the API portal custom domain.

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.
- domainName: string
  
  The name of the API portal custom domain.
- Optional options: ApiPortalCustomDomainsGetOptionalParams
  
  The options parameters.
Returns Promise<ApiPortalCustomDomainsGetResponse>

list

list(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalCustomDomainsListOptionalParams): PagedAsyncIterableIterator<ApiPortalCustomDomainResource>

- Defined in operationsInterfaces/apiPortalCustomDomains.ts:32
Handle requests to list all API portal custom domains.

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: ApiPortalCustomDomainsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiPortalCustomDomainResource>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

domainName: string

apiPortalCustomDomainResource: ApiPortalCustomDomainResource

Optional options: ApiPortalCustomDomainsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiPortalCustomDomainsCreateOrUpdateResponse>, ApiPortalCustomDomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

domainName: string

apiPortalCustomDomainResource: ApiPortalCustomDomainResource

Optional options: ApiPortalCustomDomainsCreateOrUpdateOptionalParams

Returns Promise<ApiPortalCustomDomainsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

domainName: string

Optional options: ApiPortalCustomDomainsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

domainName: string

Optional options: ApiPortalCustomDomainsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

domainName: string

Optional options: ApiPortalCustomDomainsGetOptionalParams

Returns Promise<ApiPortalCustomDomainsGetResponse>

list

Parameters

resourceGroupName: string

serviceName: string

apiPortalName: string

Optional options: ApiPortalCustomDomainsListOptionalParams

Returns PagedAsyncIterableIterator<ApiPortalCustomDomainResource>