Service interface

Interface representing a Service.

Methods

listAvailableSkusByResourceGroup(string, string, AvailableSkuRequest, ServiceListAvailableSkusByResourceGroupOptionalParams)

This method provides the list of available skus for the given subscription, resource group and location.

regionConfiguration(string, RegionConfigurationRequest, ServiceRegionConfigurationOptionalParams)

This API provides configuration details specific to given region/location at Subscription level.

regionConfigurationByResourceGroup(string, string, RegionConfigurationRequest, ServiceRegionConfigurationByResourceGroupOptionalParams)

This API provides configuration details specific to given region/location at Resource group level.

validateAddress(string, ValidateAddress, ServiceValidateAddressOptionalParams)

[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.

validateInputs(string, ValidationRequestUnion, ServiceValidateInputsOptionalParams)

This method does all necessary pre-job creation validation under subscription.

validateInputsByResourceGroup(string, string, ValidationRequestUnion, ServiceValidateInputsByResourceGroupOptionalParams)

This method does all necessary pre-job creation validation under resource group.

Method Details

listAvailableSkusByResourceGroup(string, string, AvailableSkuRequest, ServiceListAvailableSkusByResourceGroupOptionalParams)

This method provides the list of available skus for the given subscription, resource group and location.

function listAvailableSkusByResourceGroup(resourceGroupName: string, location: string, availableSkuRequest: AvailableSkuRequest, options?: ServiceListAvailableSkusByResourceGroupOptionalParams): PagedAsyncIterableIterator<SkuInformation, SkuInformation[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name

location

string

The location of the resource

availableSkuRequest
AvailableSkuRequest

Filters for showing the available skus.

Returns

PagedAsyncIterableIterator<SkuInformation, SkuInformation[], PageSettings>

regionConfiguration(string, RegionConfigurationRequest, ServiceRegionConfigurationOptionalParams)

This API provides configuration details specific to given region/location at Subscription level.

function regionConfiguration(location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationOptionalParams): Promise<RegionConfigurationResponse>

Parameters

location

string

The location of the resource

regionConfigurationRequest
RegionConfigurationRequest

Request body to get the configuration for the region.

options
ServiceRegionConfigurationOptionalParams

The options parameters.

Returns

regionConfigurationByResourceGroup(string, string, RegionConfigurationRequest, ServiceRegionConfigurationByResourceGroupOptionalParams)

This API provides configuration details specific to given region/location at Resource group level.

function regionConfigurationByResourceGroup(resourceGroupName: string, location: string, regionConfigurationRequest: RegionConfigurationRequest, options?: ServiceRegionConfigurationByResourceGroupOptionalParams): Promise<RegionConfigurationResponse>

Parameters

resourceGroupName

string

The Resource Group Name

location

string

The location of the resource

regionConfigurationRequest
RegionConfigurationRequest

Request body to get the configuration for the region at resource group level.

Returns

validateAddress(string, ValidateAddress, ServiceValidateAddressOptionalParams)

[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.

function validateAddress(location: string, validateAddress: ValidateAddress, options?: ServiceValidateAddressOptionalParams): Promise<AddressValidationOutput>

Parameters

location

string

The location of the resource

validateAddress
ValidateAddress

Shipping address of the customer.

options
ServiceValidateAddressOptionalParams

The options parameters.

Returns

validateInputs(string, ValidationRequestUnion, ServiceValidateInputsOptionalParams)

This method does all necessary pre-job creation validation under subscription.

function validateInputs(location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsOptionalParams): Promise<ValidationResponse>

Parameters

location

string

The location of the resource

validationRequest
ValidationRequestUnion

Inputs of the customer.

options
ServiceValidateInputsOptionalParams

The options parameters.

Returns

validateInputsByResourceGroup(string, string, ValidationRequestUnion, ServiceValidateInputsByResourceGroupOptionalParams)

This method does all necessary pre-job creation validation under resource group.

function validateInputsByResourceGroup(resourceGroupName: string, location: string, validationRequest: ValidationRequestUnion, options?: ServiceValidateInputsByResourceGroupOptionalParams): Promise<ValidationResponse>

Parameters

resourceGroupName

string

The Resource Group Name

location

string

The location of the resource

validationRequest
ValidationRequestUnion

Inputs of the customer.

options
ServiceValidateInputsByResourceGroupOptionalParams

The options parameters.

Returns