CustomDomains | @azure/arm-appplatform

Interface representing a CustomDomains.

Hierarchy

CustomDomains

Implemented by

CustomDomainsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomDomainsCreateOrUpdateResponse>, CustomDomainsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/customDomains.ts:66
Create or update custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- domainResource: CustomDomainResource
  
  Parameters for the create or update operation
- Optional options: CustomDomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CustomDomainsCreateOrUpdateResponse>, CustomDomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsCreateOrUpdateOptionalParams): Promise<CustomDomainsCreateOrUpdateResponse>

- Defined in operationsInterfaces/customDomains.ts:89
Create or update custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- domainResource: CustomDomainResource
  
  Parameters for the create or update operation
- Optional options: CustomDomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CustomDomainsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/customDomains.ts:106
Delete the custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- Optional options: CustomDomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/customDomains.ts:122
Delete the custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- Optional options: CustomDomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomDomainsUpdateResponse>, CustomDomainsUpdateResponse>>

- Defined in operationsInterfaces/customDomains.ts:139
Update custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- domainResource: CustomDomainResource
  
  Parameters for the create or update operation
- Optional options: CustomDomainsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CustomDomainsUpdateResponse>, CustomDomainsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsUpdateOptionalParams): Promise<CustomDomainsUpdateResponse>

- Defined in operationsInterfaces/customDomains.ts:162
Update custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- domainResource: CustomDomainResource
  
  Parameters for the create or update operation
- Optional options: CustomDomainsUpdateOptionalParams
  
  The options parameters.
Returns Promise<CustomDomainsUpdateResponse>

get

get(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsGetOptionalParams): Promise<CustomDomainsGetResponse>

- Defined in operationsInterfaces/customDomains.ts:49
Get the custom domain of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- domainName: string
  
  The name of the custom domain resource.
- Optional options: CustomDomainsGetOptionalParams
  
  The options parameters.
Returns Promise<CustomDomainsGetResponse>

list

list(resourceGroupName: string, serviceName: string, appName: string, options?: CustomDomainsListOptionalParams): PagedAsyncIterableIterator<CustomDomainResource>

- Defined in operationsInterfaces/customDomains.ts:34
List the custom domains of one lifecycle application.

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.
- appName: string
  
  The name of the App resource.
- Optional options: CustomDomainsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CustomDomainResource>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CustomDomainsCreateOrUpdateResponse>, CustomDomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsCreateOrUpdateOptionalParams

Returns Promise<CustomDomainsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

Optional options: CustomDomainsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

Optional options: CustomDomainsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CustomDomainsUpdateResponse>, CustomDomainsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsUpdateOptionalParams

Returns Promise<CustomDomainsUpdateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

Optional options: CustomDomainsGetOptionalParams

Returns Promise<CustomDomainsGetResponse>

list

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: CustomDomainsListOptionalParams

Returns PagedAsyncIterableIterator<CustomDomainResource>