openapi-directory/api/azure.com/web-ResourceHealthMetadata.json

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

{"openapi":"3.0.0","info":{"title":"ResourceHealthMetadata API Client","version":"2018-02-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/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"web-ResourceHealthMetadata","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata":{"get":{"description":"List all ResourceHealthMetadata for all sites in the subscription.","operationId":"ResourceHealthMetadata_List","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceHealthMetadataCollection"},"examples":{"List ResourceHealthMetadata for a subscription":{"$ref":"#/components/examples/List_ResourceHealthMetadata_for_a_subscription"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"List all ResourceHealthMetadata for all sites in the subscription.","tags":["ResourceHealthMetadata"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata":{"get":{"description":"List all ResourceHealthMetadata for all sites in the resource group in the subscription.","operationId":"ResourceHealthMetadata_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceHealthMetadataCollection"},"examples":{"List ResourceHealthMetadata for a resource group":{"$ref":"#/components/examples/List_ResourceHealthMetadata_for_a_resource_group"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"List all ResourceHealthMetadata for all sites in the resource group in the subscription.","tags":["ResourceHealthMetadata"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata":{"get":{"description":"Gets the category of ResourceHealthMetadata to use for the given site as a collection","operationId":"ResourceHealthMetadata_ListBySite","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of web app.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"List ResourceHealthMetadata for a site":{"value":"newsiteinnewASE-NCUS"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceHealthMetadataCollection"},"examples":{"List ResourceHealthMetadata for a site":{"$ref":"#/components/examples/List_ResourceHealthMetadata_for_a_site"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets the category of ResourceHealthMetadata to use for the given site as a collection","tags":["ResourceHealthMetadata"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default":{"get":{"description":"Gets the category of ResourceHealthMetadata to use for the given site","operationId":"ResourceHealthMetadata_GetBySite","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of web app","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Get ResourceHealthMetadata":{"value":"newsiteinnewASE-NCUS"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceHealthMetadata"},"examples":{"Get ResourceHealthMetadata":{"$ref":"#/components/examples/Get_ResourceHealthMetadata"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets the category of ResourceHealthMetadata to use for the given site","tags":["ResourceHealthMetadata"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata":{"get":{"description":"Gets the category of ResourceHealthMetadata to use for the given site as a collection","operationId":"ResourceHealthMetadata_ListBySiteSlot","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of web app.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"List ResourceHealthMetadata for a site":{"value":"newsiteinnewASE-NCUS"}}},{"description":"Name of web app slot. If not specified then will default to production slot.","in":"path","name":"slot","required":true,"schema":{"type":"string"},"examples":{"List ResourceHealthMetadata for a site":{"value":"Production"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceHealthMetadataCollection"},"examples":{"List ResourceHealthMetadata for a site":{"$ref":"#/components/examples/List_ResourceHealthMetadata_for_a_site"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets the category of ResourceHealthMetadata to use for the given site as a collection","tags":["ResourceHealthMetadata"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default":{"get":{"description":"Gets the category of ResourceHealthMetadata to use for the given site","operationId":"ResourceHealthMetadata_GetBySiteSlot","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of web app","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Get ResourceHealthMetadata":{"value":"newsiteinnewASE-NCUS"}}},{"description":"Name of web app slot. If not specified then will default to production slot.","in":"path","name":"slot","required":true,"schema":{"type":"string"},"examples":{"Get ResourceHealthMetadata":{"value":"Production"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceHealthMetadata"},"examples":{"Get ResourceHealthMetadata":{"$ref":"#/components/examples/Get_ResourceHealthMetadata"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Gets the category of ResourceHealthMetadata to use for the given site","tags":["ResourceHealthMetadata"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_ResourceHealthMetadata_for_a_subscription":{"value":{"nextLink":"","value":[{"id":"/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default","name":"default","properties":{"category":"Shared","signalAvailability":true},"type":"Microsoft.Web/sites/resourceHealthMetadata"}]}},"List_ResourceHealthMetadata_for_a_resource_group":{"value":{"nextLink":"","value":[{"id":"/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default","name":"default","properties":{"category":"Shared","signalAvailability":true},"type":"Microsoft.Web/sites/resourceHealthMetadata"}]}},"List_ResourceHealthMetadata_for_a_site":{"value":{"nextLink":"","value":[{"id":"/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default","name":"default","properties":{"category":"Shared","signalAvailability":true},"type":"Microsoft.Web/sites/resourceHealthMetadata"}]}},"Get_ResourceHealthMetadata":{"value":{"id":"/subscriptions/4adb32ad-8327-4cbb-b775-b84b4465bb38/resourceGroups/Default-Web-NorthCentralUS/providers/Microsoft.Web/sites/newsiteinnewASE-NCUS/resourceHealthMetadata/default","name":"default","properties":{"category":"Shared","signalAvailability":true},"type":"Microsoft.Web/sites/resourceHealthMetadata"}}},"parameters":{"apiVersionParameter":{"description":"API Version","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List ResourceHealthMetadata for a subscription":{"value":"2018-02-01"},"List ResourceHealthMetadata for a resource group":{"value":"2018-02-01"},"List ResourceHealthMetadata for a site":{"value":"2018-02-01"},"Get ResourceHealthMetadata":{"value":"2018-02-01"}}},"resourceGroupNameParameter":{"description":"Name of the resource group to which the resource belongs.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+[^\\.]$"},"examples":{"List ResourceHealthMetadata for a resource group":{"value":"Default-Web-NorthCentralUS"},"List ResourceHealthMetadata for a site":{"value":"Default-Web-NorthCentralUS"},"Get ResourceHealthMetadata":{"value":"Default-Web-NorthCentralUS"}}},"subscriptionIdParameter":{"description":"Your 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 ResourceHealthMetadata for a subscription":{"value":"4adb32ad-8327-4cbb-b775-b84b4465bb38"},"List ResourceHealthMetadata for a resource group":{"value":"4adb32ad-8327-4cbb-b775-b84b4465bb38"},"List ResourceHealthMetadata for a site":{"value":"4adb32ad-8327-4cbb-b775-b84b4465bb38"},"Get ResourceHealthMetadata":{"value":"4adb32ad-8327-4cbb-b775-b84b4465bb38"}}}},"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":{"ResourceHealthMetadata":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Used for getting ResourceHealthCheck settings.","properties":{"properties":{"description":"ResourceHealthMetadata resource specific properties","properties":{"category":{"description":"The category that the resource matches in the RHC Policy File","type":"string"},"signalAvailability":{"description":"Is there a health signal for the resource","type":"boolean"}},"x-ms-client-flatten":true}},"type":"object"},"ResourceHealthMetadataCollection":{"description":"Collection of resource health metadata.","properties":{"nextLink":{"description":"Link to next page of resources.","readOnly":true,"type":"string"},"value":{"description":"Collection of resources.","items":{"$ref":"#/components/schemas/ResourceHealthMetadata"},"type":"array"}},"required":["value"],"type":"object"}}}}