Package version:

Interface CustomDomains

Interface representing a CustomDomains.

Hierarchy

CustomDomains

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get list

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomDomainResource>, CustomDomainResource>>
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<CustomDomainResource>, CustomDomainResource>>
- Defined in operationsInterfaces/customDomains.ts:66

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsCreateOrUpdateOptionalParams): Promise<CustomDomainResource>
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<CustomDomainResource>
- Defined in operationsInterfaces/customDomains.ts:89

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/customDomains.ts:106

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/customDomains.ts:122

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomDomainResource>, CustomDomainResource>>
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<CustomDomainResource>, CustomDomainResource>>
- Defined in operationsInterfaces/customDomains.ts:139

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsUpdateOptionalParams): Promise<CustomDomainResource>
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<CustomDomainResource>
- Defined in operationsInterfaces/customDomains.ts:162

get

get(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsGetOptionalParams): Promise<CustomDomainResource>
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<CustomDomainResource>
- Defined in operationsInterfaces/customDomains.ts:49

list

list(resourceGroupName: string, serviceName: string, appName: string, options?: CustomDomainsListOptionalParams): PagedAsyncIterableIterator<CustomDomainResource>
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>
- Defined in operationsInterfaces/customDomains.ts:34

Interface CustomDomains

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CustomDomainResource>, CustomDomainResource>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsCreateOrUpdateOptionalParams

Returns Promise<CustomDomainResource>

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<CustomDomainResource>, CustomDomainResource>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

domainResource: CustomDomainResource

Optional options: CustomDomainsUpdateOptionalParams

Returns Promise<CustomDomainResource>

get

Parameters

resourceGroupName: string

serviceName: string

appName: string

domainName: string

Optional options: CustomDomainsGetOptionalParams

Returns Promise<CustomDomainResource>

list

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: CustomDomainsListOptionalParams

Returns PagedAsyncIterableIterator<CustomDomainResource>

Settings

Member Visibility

Theme

`Optional` options: CustomDomainsCreateOrUpdateOptionalParams

`Optional` options: CustomDomainsCreateOrUpdateOptionalParams

`Optional` options: CustomDomainsDeleteOptionalParams

`Optional` options: CustomDomainsDeleteOptionalParams

`Optional` options: CustomDomainsUpdateOptionalParams

`Optional` options: CustomDomainsUpdateOptionalParams

`Optional` options: CustomDomainsGetOptionalParams

`Optional` options: CustomDomainsListOptionalParams