openapi-directory/api/azure.com/portal.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Allows creation and deletion of Azure Shared Dashboards.","title":"portal","version":"2019-01-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"name":"portalClient"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/portal.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"portal","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Portal/operations":{"get":{"description":"The Microsoft Portal operations API.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Describe the result of a successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceProviderOperationList"},"examples":{"List the portal operations":{"$ref":"#/components/examples/List_the_portal_operations"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards":{"get":{"description":"Gets all the dashboards within a subscription.","operationId":"Dashboards_ListBySubscription","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns an array of dashboards.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardListResult"},"examples":{"List all custom resource providers on the subscription":{"$ref":"#/components/examples/List_all_custom_resource_providers_on_the_subscription"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Dashboard"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards":{"get":{"description":"Gets all the Dashboards within a resource group.","operationId":"Dashboards_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns an array of Dashboards.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardListResult"},"examples":{"List all custom resource providers on the resourceGroup":{"$ref":"#/components/examples/List_all_custom_resource_providers_on_the_resourceGroup"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Dashboard"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}":{"delete":{"description":"Deletes the Dashboard.","operationId":"Dashboards_Delete","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/DashboardNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition."},"204":{"description":"OK resource was not found."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Dashboard"]},"get":{"description":"Gets the Dashboard.","operationId":"Dashboards_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/DashboardNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"examples":{"Get a Dashboard":{"$ref":"#/components/examples/Get_a_Dashboard"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Dashboard"]},"patch":{"description":"Updates an existing Dashboard.","operationId":"Dashboards_Update","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/DashboardNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchableDashboard"}}},"description":"The updatable fields of a Dashboard.","required":true},"responses":{"200":{"description":"OK response definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"examples":{"Update a Dashboard":{"$ref":"#/components/examples/Update_a_Dashboard"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Dashboard"]},"put":{"description":"Creates or updates a Dashboard.","operationId":"Dashboards_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/DashboardNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}},"description":"The parameters required to create or update a dashboard.","required":true},"responses":{"200":{"description":"Resource already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"examples":{"Create or update a Dashboard":{"$ref":"#/components/examples/Create_or_update_a_Dashboard"}}}}},"201":{"description":"Created response definition. Resource has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"examples":{"Create or update a Dashboard":{"$ref":"#/components/examples/Create_or_update_a_Dashboard"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Dashboard"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_the_portal_operations":{"value":{"value":[{"display":{"description":"Reads the dashboards for the subscription.","operation":"Get Dashboard","provider":"Microsoft Portal","resource":"Dashboards"},"isDataAction":"false","name":"Microsoft.Portal/dashboards/read"},{"display":{"description":"Add or modify dashboard to a subscription.","operation":"Set Dashboard","provider":"Microsoft Portal","resource":"Dashboards"},"isDataAction":"false","name":"Microsoft.Portal/dashboards/write"},{"display":{"description":"Removes the dashboard from the subscription.","operation":"Delete Dashboard","provider":"Microsoft Portal","resource":"Dashboards"},"isDataAction":"false","name":"Microsoft.Portal/dashboards/delete"},{"display":{"description":"Registers the subscription for the portal resource provider and enables shared dashboards.","operation":"Registers the Portal Resource Provider","provider":"Microsoft Portal","resource":"Portal Resource Provider"},"isDataAction":"false","name":"Microsoft.Portal/register/action"}]}},"List_all_custom_resource_providers_on_the_subscription":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard","location":"eastus","name":"testDashboard","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"aValue","anotherKey":"anotherValue"},"type":"Microsoft.Portal/dashboards"},{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard2","location":"eastus","name":"testDashboard2","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"aValue","anotherKey":"anotherValue"},"type":"Microsoft.Portal/dashboards"}]}},"List_all_custom_resource_providers_on_the_resourceGroup":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard","location":"eastus","name":"testDashboard","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"aValue","anotherKey":"anotherValue"},"type":"Microsoft.Portal/dashboards"},{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard2","location":"eastus","name":"testDashboard2","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"aValue","anotherKey":"anotherValue"},"type":"Microsoft.Portal/dashboards"}]}},"Get_a_Dashboard":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard","location":"eastus","name":"testDashboard","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"aValue","anotherKey":"anotherValue"},"type":"Microsoft.Portal/dashboards"}},"Update_a_Dashboard":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard","location":"eastus","name":"testDashboard","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"bValue","anotherKey":"anotherValue2"},"type":"Microsoft.Portal/dashboards"}},"Create_or_update_a_Dashboard":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard","location":"eastus","name":"testDashboard","properties":{"lenses":{"aLens":{"order":1,"parts":{"aPart":{"position":{"colSpan":3,"rowSpan":4,"x":1,"y":2}},"bPart":{"position":{"colSpan":6,"rowSpan":6,"x":5,"y":5}}}},"bLens":{"order":2,"parts":{}}},"metadata":{"metadata":{"ColSpan":2,"RowSpan":1,"X":4,"Y":3}}},"tags":{"aKey":"aValue","anotherKey":"anotherValue"},"type":"Microsoft.Portal/dashboards"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to be used with the HTTP request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List the portal operations":{"value":"2019-01-01-preview"},"List all custom resource providers on the subscription":{"value":"2019-01-01-preview"},"List all custom resource providers on the resourceGroup":{"value":"2019-01-01-preview"},"Delete a Dashboard":{"value":"2019-01-01-preview"},"Get a Dashboard":{"value":"2019-01-01-preview"},"Update a Dashboard":{"value":"2019-01-01-preview"},"Create or update a Dashboard":{"value":"2019-01-01-preview"}}},"DashboardNameParameter":{"description":"The name of the dashboard.","in":"path","name":"dashboardName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":3,"maxLength":64},"examples":{"Delete a Dashboard":{"value":"testDashboard"},"Get a Dashboard":{"value":"testDashboard"},"Update a Dashboard":{"value":"testDashboard"},"Create or update a Dashboard":{"value":"testDashboard"}}},"ResourceGroupNameParameter":{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List all custom resource providers on the resourceGroup":{"value":"testRG"},"Delete a Dashboard":{"value":"testRG"},"Get a Dashboard":{"value":"testRG"},"Update a Dashboard":{"value":"testRG"},"Create or update a Dashboard":{"value":"testRG"}}},"SubscriptionIdParameter":{"description":"The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all custom resource providers on the subscription":{"value":"00000000-0000-0000-0000-000000000000"},"List all custom resource providers on the resourceGroup":{"value":"00000000-0000-0000-0000-000000000000"},"Delete a Dashboard":{"value":"00000000-0000-0000-0000-000000000000"},"Get a Dashboard":{"value":"00000000-0000-0000-0000-000000000000"},"Update a Dashboard":{"value":"00000000-0000-0000-0000-000000000000"},"Create or update a Dashboard":{"value":"00000000-0000-0000-0000-000000000000"}}}},"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":{"Dashboard":{"description":"The shared dashboard resource definition.","properties":{"id":{"description":"Resource Id","readOnly":true,"type":"string"},"location":{"description":"Resource location","type":"string","x-ms-mutability":["read","create"]},"name":{"description":"Resource name","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/DashboardProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"},"type":{"description":"Resource type","readOnly":true,"type":"string"}},"required":["location"],"type":"object","x-ms-azure-resource":true,"x-ms-client-flatten":true},"DashboardLens":{"description":"A dashboard lens.","properties":{"metadata":{"additionalProperties":{"type":"object"},"description":"The dashboard len's metadata.","type":"object"},"order":{"description":"The lens order.","type":"integer"},"parts":{"additionalProperties":{"$ref":"#/components/schemas/DashboardParts"},"description":"The dashboard parts.","type":"object"}},"required":["order","parts"],"type":"object"},"DashboardListResult":{"description":"List of dashboards.","properties":{"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"value":{"description":"The array of custom resource provider manifests.","items":{"$ref":"#/components/schemas/Dashboard"},"type":"array"}},"type":"object"},"DashboardParts":{"description":"A dashboard part.","properties":{"metadata":{"additionalProperties":{"type":"object"},"description":"The dashboard part's metadata.","type":"object"},"position":{"description":"The dashboard's part position.","properties":{"colSpan":{"description":"The dashboard's part column span.","type":"number"},"metadata":{"additionalProperties":{"type":"object"},"description":"The dashboard part's metadata.","type":"object"},"rowSpan":{"description":"The dashboard's part row span.","type":"number"},"x":{"description":"The dashboard's part x coordinate.","type":"number"},"y":{"description":"The dashboard's part y coordinate.","type":"number"}},"required":["x","y","rowSpan","colSpan"],"type":"object"}},"required":["position"],"type":"object"},"DashboardProperties":{"description":"The shared dashboard properties.","properties":{"lenses":{"additionalProperties":{"$ref":"#/components/schemas/DashboardLens"},"description":"The dashboard lenses.","type":"object"},"metadata":{"additionalProperties":{"type":"object"},"description":"The dashboard metadata.","type":"object"}},"type":"object"},"ErrorDefinition":{"description":"Error definition.","properties":{"code":{"description":"Service specific error code which serves as the substatus for the HTTP error code.","readOnly":true,"type":"string"},"details":{"description":"Internal error details.","items":{"$ref":"#/components/schemas/ErrorDefinition"},"readOnly":true,"type":"array"},"message":{"description":"Description of the error.","readOnly":true,"type":"string"}},"type":"object"},"ErrorResponse":{"description":"Error response.","properties":{"error":{"$ref":"#/components/schemas/ErrorDefinition"}},"type":"object"},"PatchableDashboard":{"description":"The shared dashboard resource definition.","properties":{"properties":{"$ref":"#/components/schemas/DashboardProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"}},"type":"object","x-ms-azure-resource":true,"x-ms-client-flatten":true},"ResourceProviderOperation":{"description":"Supported operations of this resource provider.","properties":{"display":{"description":"Display metadata associated with the operation.","properties":{"description":{"description":"Description of this operation.","type":"string"},"operation":{"description":"Type of operation: get, read, delete, etc.","type":"string"},"provider":{"description":"Resource provider: Microsoft Custom Providers.","type":"string"},"resource":{"description":"Resource on which the operation is performed.","type":"string"}}},"isDataAction":{"description":"Indicates whether the operation applies to data-plane.","type":"string"},"name":{"description":"Operation name, in format of {provider}/{resource}/{operation}","type":"string"}},"readOnly":true,"type":"object"},"ResourceProviderOperationList":{"description":"Results of the request to list operations.","properties":{"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"value":{"description":"List of operations supported by this resource provider.","items":{"$ref":"#/components/schemas/ResourceProviderOperation"},"type":"array"}},"readOnly":true,"type":"object"}}}}