Locations - Check Trial Availability

Service:

AVS

API Version:

2023-09-01

Return trial status for subscription by region

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The name of the Azure region.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
name	True	string	The name of the SKU. E.g. P3. It is typically a letter+number code
capacity		integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family		string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
size		string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier		SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Responses

Name	Type	Description
200 OK	Trial	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Locations_CheckTrialAvailability

Locations_CheckTrialAvailabilityWithSku

Locations_CheckTrialAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AVS/locations/eastus/checkTrialAvailability?api-version=2023-09-01

Sample Response

Status code:

200

{
  "status": "TrialAvailable",
  "availableHosts": 4
}

Locations_CheckTrialAvailabilityWithSku

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AVS/locations/eastus/checkTrialAvailability?api-version=2023-09-01

{
  "name": "avs52t"
}

Sample Response

Status code:

200

{
  "status": "TrialAvailable",
  "availableHosts": 4
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Trial	Subscription trial availability
TrialStatus	trial status

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Sku

The resource model definition representing SKU

Name	Type	Description
capacity	integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. E.g. P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name	Type	Description
Basic	string
Free	string
Premium	string
Standard	string

Trial

Subscription trial availability

Name	Type	Description
availableHosts	integer	Number of trial hosts available
status	TrialStatus	Trial status

TrialStatus

trial status

Name	Type	Description
TrialAvailable	string	is available
TrialDisabled	string	is disabled
TrialUsed	string	is used