@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api SubscriptionClient
@base https://management.azure.com
@version 2019-06-01
@auth OAuth2
@common_fields {api-version: any # The API version to use for the operation.}
@endpoints 7
@toc providers(2), subscriptions(4), tenants(1)

@group providers
@endpoint GET /providers/Microsoft.Resources/operations
@desc Lists all of the available Microsoft.Resources REST API operations.
@returns(200) OK. The request has succeeded.

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/locations
@desc Gets all available geo-locations.
@required {subscriptionId: any # The ID of the target subscription.}
@returns(200) OK - Returns an array of locations.

@endpoint GET /subscriptions/{subscriptionId}
@desc Gets details about a specified subscription.
@required {subscriptionId: any # The ID of the target subscription.}
@returns(200) OK - Returns information about the subscription.

@endpoint GET /subscriptions
@desc Gets all subscriptions for a tenant.
@returns(200) OK - Returns an array of subscriptions.

@endgroup

@group tenants
@endpoint GET /tenants
@desc Gets the tenants for your account.
@returns(200) OK - Returns an array of tenants.

@endgroup

@group subscriptions
@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Resources/checkZonePeers/
@desc Compares a subscriptions logical zone mapping
@required {subscriptionId: any # The ID of the target subscription., parameters: map # Parameters for checking zone peers.}
@returns(200) OK - Returns information about the logical availability zone mapping between subscriptions.

@endgroup

@group providers
@endpoint POST /providers/Microsoft.Resources/checkResourceName
@desc Checks resource name validity
@optional {Resource Name Definition: any # Resource object with values for resource name and resource type}
@returns(200) OK - Returns status as allowed or not.

@endgroup

@end