service

Creates, updates, deletes, gets or lists a service resource.

Overview

Name	service
Type	Resource
Id	azure.data_box.service

Fields

The following fields are returned by SELECT queries:

list_available_skus_by_resource_group

Name	Datatype	Description
apiVersions	array	Api versions that support this Sku.
capacity	object	Capacity of the Sku.
costs	array	Cost of the Sku.
countriesWithinCommerceBoundary	array	List of all the Countries in the SKU specific commerce boundary.
dataLocationToServiceLocationMap	array	The map of data location to service location.
disabledReason	string	Reason why the Sku is disabled. Known values are: "None", "Country", "Region", "Feature", "OfferType", and "NoSubscriptionInfo".
disabledReasonMessage	string	Message for why the Sku is disabled.
enabled	boolean	The sku is enabled or not.
requiredFeature	string	Required feature to access the sku.
sku	object	The Sku.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_available_skus_by_resource_group	select	resource_group_name, location, subscription_id		This method provides the list of available skus for the given subscription, resource group and location.
validate_address	exec	location, subscription_id, validationType, shippingAddress, deviceType		[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.
validate_inputs_by_resource_group	exec	resource_group_name, location, subscription_id, validationCategory, individualRequestDetails		This method does all necessary pre-job creation validation under resource group.
validate_inputs	exec	location, subscription_id, validationCategory, individualRequestDetails		This method does all necessary pre-job creation validation under subscription.
region_configuration	exec	location, subscription_id		This API provides configuration details specific to given region/location at Subscription level.
region_configuration_by_resource_group	exec	resource_group_name, location, subscription_id		This API provides configuration details specific to given region/location at Resource group level.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location	string	The location of the resource. Required.
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string

SELECT examples

list_available_skus_by_resource_group

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

SELECT
apiVersions,
capacity,
costs,
countriesWithinCommerceBoundary,
dataLocationToServiceLocationMap,
disabledReason,
disabledReasonMessage,
enabled,
requiredFeature,
sku
FROM azure.data_box.service
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

validate_address

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

EXEC azure.data_box.service.validate_address 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"validationType": "{{ validationType }}", 
"shippingAddress": "{{ shippingAddress }}", 
"deviceType": "{{ deviceType }}", 
"transportPreferences": "{{ transportPreferences }}", 
"model": "{{ model }}"
}'
;

validate_inputs_by_resource_group

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

EXEC azure.data_box.service.validate_inputs_by_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"validationCategory": "{{ validationCategory }}", 
"individualRequestDetails": "{{ individualRequestDetails }}"
}'
;

validate_inputs

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

EXEC azure.data_box.service.validate_inputs 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"validationCategory": "{{ validationCategory }}", 
"individualRequestDetails": "{{ individualRequestDetails }}"
}'
;

region_configuration

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

EXEC azure.data_box.service.region_configuration 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"scheduleAvailabilityRequest": "{{ scheduleAvailabilityRequest }}", 
"transportAvailabilityRequest": "{{ transportAvailabilityRequest }}", 
"datacenterAddressRequest": "{{ datacenterAddressRequest }}", 
"deviceCapabilityRequest": "{{ deviceCapabilityRequest }}"
}'
;

region_configuration_by_resource_group

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

EXEC azure.data_box.service.region_configuration_by_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"scheduleAvailabilityRequest": "{{ scheduleAvailabilityRequest }}", 
"transportAvailabilityRequest": "{{ transportAvailabilityRequest }}", 
"datacenterAddressRequest": "{{ datacenterAddressRequest }}", 
"deviceCapabilityRequest": "{{ deviceCapabilityRequest }}"
}'
;