openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 23.2 kB
JSON
{"openapi":"3.0.0","info":{"description":"The Admin Subscriptions Management Client.","title":"SubscriptionsManagementClient","version":"2015-11-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-Plan","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/plans":{"get":{"description":"List all plans across all subscriptions.","operationId":"Plans_ListAll","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get the list of plans.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Get the list of plans.":{"value":"2015-11-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanList"},"examples":{"Get the list of plans.":{"$ref":"#/components/examples/Get_the_list_of_plans."}}}}}},"tags":["Plans"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans":{"get":{"description":"Get the list of plans under a resource group.","operationId":"Plans_List","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get the list of plans under a resource group.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the list of plans under a resource group.":{"value":"plans"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Get the list of plans under a resource group.":{"value":"2015-11-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanList"},"examples":{"Get the list of plans under a resource group.":{"$ref":"#/components/examples/Get_the_list_of_plans_under_a_resource_group."}}}}}},"tags":["Plans"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}":{"delete":{"description":"Delete the specified plan.","operationId":"Plans_Delete","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete the specified plan.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete the specified plan.":{"value":"plans"}}},{"description":"Name of the plan.","in":"path","name":"plan","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete the specified plan.":{"value":"testplan"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Delete the specified plan.":{"value":"2015-11-01"}}}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"}},"tags":["Plans"]},"get":{"description":"Get the specified plan.","operationId":"Plans_Get","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get the specified plan.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the specified plan.":{"value":"plans"}}},{"description":"Name of the plan.","in":"path","name":"plan","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the specified plan.":{"value":"testplan"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Get the specified plan.":{"value":"2015-11-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"},"examples":{"Get the specified plan.":{"$ref":"#/components/examples/Get_the_specified_plan."}}}}}},"tags":["Plans"]},"put":{"description":"Create or update the plan.","operationId":"Plans_CreateOrUpdate","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update the plan.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update the plan.":{"value":"plans"}}},{"description":"Name of the plan.","in":"path","name":"plan","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update the plan.":{"value":"testplan"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Create or update the plan.":{"value":"2015-11-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"}}},"description":"New plan.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"},"examples":{"Create or update the plan.":{"$ref":"#/components/examples/Create_or_update_the_plan."}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"},"examples":{"Create or update the plan.":{"$ref":"#/components/examples/Create_or_update_the_plan."}}}}}},"tags":["Plans"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/metricDefinitions":{"get":{"description":"Get the metric definitions of the specified plan.","operationId":"Plans_ListMetricDefinitions","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get the metric definitions of the specified plan.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the metric definitions of the specified plan.":{"value":"plans"}}},{"description":"Name of the plan.","in":"path","name":"plan","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the metric definitions of the specified plan.":{"value":"testplan"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Get the metric definitions of the specified plan.":{"value":"2015-11-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"List of metric definitions.","properties":{"nextLink":{"description":"Continuation token","type":"string"},"value":{"description":"Array of metric definitions.","items":{"description":"Metric Definition","properties":{"metricAvailabilities":{"description":"List of metric definitions.","items":{"description":"Metric Definition","properties":{"retention":{"description":"the retention. Metrics may be queried for this interval.","type":"string"},"timeGrain":{"description":"The time grain. Metrics will be available for this time grain.","type":"string"}},"type":"object"},"type":"array"},"name":{"description":"Metric definition name.","type":"string"},"primaryAggregationType":{"description":"The primary aggregation type for resource metric.","enum":["None","Average","Total","Minimum","Maximum","Last"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"MetricPrimaryAggregationType","values":[{"description":"No aggregation applied to resource.","name":"None","value":"None"},{"description":"The average aggregation type.","name":"Average","value":"Average"},{"description":"The total aggregation type.","name":"Total","value":"Total"},{"description":"The minimum aggregation type.","name":"Minimum","value":"Minimum"},{"description":"The maximum aggregation type.","name":"Maximum","value":"Maximum"},{"description":"The last aggregation type.","name":"Last","value":"Last"}]}},"unit":{"description":"The resource metric unit.","enum":["Count","Bytes","Seconds","CountPerSecond","BytesPerSecond"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"MetricUnit","values":[{"description":"The count.","name":"Count","value":"Count"},{"description":"The bytes.","name":"Bytes","value":"Bytes"},{"description":"The seconds.","name":"Seconds","value":"Seconds"},{"description":"The count per second.","name":"CountPerSecond","value":"CountPerSecond"},{"description":"The bytes per second.","name":"BytesPerSecond","value":"BytesPerSecond"}]}}},"type":"object"},"type":"array"}}},"examples":{"Get the metric definitions of the specified plan.":{"$ref":"#/components/examples/Get_the_metric_definitions_of_the_specified_plan."}}}}}},"tags":["Plans"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/metrics":{"get":{"description":"Get the metrics of the specified plan.","operationId":"Plans_ListMetrics","parameters":[{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get the metrics of the specified plan.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the metrics of the specified plan.":{"value":"plans"}}},{"description":"Name of the plan.","in":"path","name":"plan","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the metrics of the specified plan.":{"value":"testplan"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2015-11-01"},"examples":{"Get the metrics of the specified plan.":{"value":"2015-11-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"List of metrics.","properties":{"nextLink":{"description":"Continuation token","type":"string"},"value":{"description":"List of metrics.","items":{"description":"The resource metric set that represents the metrics for a particular resource.","properties":{"endTime":{"description":"End time of the metric.","format":"date-time","type":"string"},"metricUnit":{"description":"The resource metric unit.","enum":["Count","Bytes","Seconds","CountPerSecond","BytesPerSecond"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"MetricUnit","values":[{"description":"The count.","name":"Count","value":"Count"},{"description":"The bytes.","name":"Bytes","value":"Bytes"},{"description":"The seconds.","name":"Seconds","value":"Seconds"},{"description":"The count per second.","name":"CountPerSecond","value":"CountPerSecond"},{"description":"The bytes per second.","name":"BytesPerSecond","value":"BytesPerSecond"}]}},"metricValues":{"description":"List of metric values.","items":{"description":"Metric value","properties":{"average":{"description":"Average value for metric sample period.","format":"double","type":"number"},"count":{"description":"Number of measurements for metric sample period.","type":"integer"},"maximum":{"description":"Maximum value for metric sample period.","format":"double","type":"number"},"minimum":{"description":"Minimum value for metric sample period.","format":"double","type":"number"},"properties":{"additionalProperties":{"type":"string"},"description":"Extended properties.","type":"object","x-ms-client-name":"extendedProperties"},"timeStamp":{"description":"Timestamp of when the metric value was collected.","format":"date-time","type":"string"},"total":{"description":"Total value for metric sample period.","format":"double","type":"number"}},"type":"object"},"type":"array"},"startTime":{"description":"Start time of the metric.","format":"date-time","type":"string"},"timeGrain":{"description":"Timespan of the metric.","type":"string"}},"type":"object"},"type":"array"}}},"examples":{"Get the metrics of the specified plan.":{"$ref":"#/components/examples/Get_the_metrics_of_the_specified_plan."}}}}}},"tags":["Plans"]}}},"servers":[{"url":"https://adminmanagement.local.azurestack.external"}],"components":{"examples":{"Get_the_list_of_plans.":{"value":{"value":[{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/balaplan","location":"local","name":"balaplan","properties":{"displayName":"balaplan","name":"balaplan","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Compute.Admin/locations/local/quotas/Default Quota"],"subscriptionCount":0},"type":"Microsoft.Subscriptions.Admin/plans"},{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007subscrrg352/providers/Microsoft.Subscriptions.Admin/plans/cnur8007tenantplan352","location":"local","name":"cnur8007tenantplan352","properties":{"displayName":"cnur8007tenantplan352","name":"cnur8007tenantplan352","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Compute.Admin/locations/local/quotas/ascanarycomputequota","/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.KeyVault.Admin/locations/local/quotas/Unlimited","/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Network.Admin/locations/local/quotas/ascanarynetworkquota","/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Storage.Admin/locations/local/quotas/ascanarystoragequota"],"subscriptionCount":0},"tags":{},"type":"Microsoft.Subscriptions.Admin/plans"},{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007resellersubscrrg352/providers/Microsoft.Subscriptions.Admin/plans/cnur8007subsvcplan352","location":"local","name":"cnur8007subsvcplan352","properties":{"displayName":"cnur8007subsvcplan352","name":"cnur8007subsvcplan352","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"tags":{},"type":"Microsoft.Subscriptions.Admin/plans"},{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/TestRG-c895f7cb-18e0-41b4-a4e9-c29131dbbc48/providers/Microsoft.Subscriptions.Admin/plans/TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94","location":"local","name":"TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94","properties":{"displayName":"TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94","name":"TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"tags":{},"type":"Microsoft.Subscriptions.Admin/plans"},{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/balaplan2","location":"local","name":"balaplan2","properties":{"displayName":"balaplan2","name":"balaplan2","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"type":"Microsoft.Subscriptions.Admin/plans"},{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/bala2","location":"local","name":"bala2","properties":{"displayName":"bala2","name":"bala2","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"tags":{},"type":"Microsoft.Subscriptions.Admin/plans"},{"id":"/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/bala3","location":"local","name":"bala3","properties":{"displayName":"bala2","name":"bala3","quotaIds":["/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"tags":{},"type":"Microsoft.Subscriptions.Admin/plans"}]}},"Get_the_list_of_plans_under_a_resource_group.":{"value":{"value":[{"id":"/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan","location":"local","name":"testplan","properties":{"displayName":"TestPlan","name":"testplan","quotaIds":["/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Compute.Admin/locations/local/quotas/Default Quota","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.KeyVault.Admin/locations/local/quotas/Unlimited","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Network.Admin/locations/local/quotas/Default Quota","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Storage.Admin/locations/local/quotas/Default Quota","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"type":"Microsoft.Subscriptions.Admin/plans"}]}},"Get_the_specified_plan.":{"value":{"id":"/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan","location":"local","name":"testplan","properties":{"displayName":"TestPlan","name":"testplan","quotaIds":["/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Compute.Admin/locations/local/quotas/Default Quota","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.KeyVault.Admin/locations/local/quotas/Unlimited","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Network.Admin/locations/local/quotas/Default Quota","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Storage.Admin/locations/local/quotas/Default Quota","/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"type":"Microsoft.Subscriptions.Admin/plans"}},"Create_or_update_the_plan.":{"value":{"id":"/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/testrg/providers/Microsoft.Subscriptions.Admin/plans/testplans","location":"local","name":"testplans","properties":{"description":"test plan","displayName":"testplans","name":"testplans","quotaIds":["/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota"],"subscriptionCount":0},"type":"Microsoft.Subscriptions.Admin/plans"}},"Get_the_metric_definitions_of_the_specified_plan.":{"value":{"value":[]}},"Get_the_metrics_of_the_specified_plan.":{"value":{"value":[]}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Plan":{"allOf":[{"description":"Base Resource Object","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource","type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key-value pairs.","readOnly":true,"type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"A plan represents a package of quotas and capabilities that are offered tenants. A tenant can acquire this plan through an offer to upgrade his access to underlying cloud services.","properties":{"properties":{"$ref":"#/components/schemas/PlanProperties"}},"type":"object"},"PlanList":{"description":"List of plans","properties":{"nextLink":{"description":"Continuation token","type":"string"},"value":{"description":"Array of plans.","items":{"$ref":"#/components/schemas/Plan"},"type":"array"}}},"PlanProperties":{"description":"Properties of a plan.","properties":{"description":{"description":"Description of the plan.","type":"string"},"displayName":{"description":"Display name.","type":"string"},"externalReferenceId":{"description":"External reference identifier.","type":"string"},"name":{"description":"Name of the plan.","type":"string"},"quotaIds":{"description":"Quota identifiers under the plan.","items":{"type":"string"},"type":"array"},"skuIds":{"description":"SKU identifiers.","items":{"type":"string"},"type":"array"},"subscriptionCount":{"description":"Subscription count.","type":"integer"}},"type":"object"}}}}