openapi-directory/api/azure.com/security-serverVulnerabilityAssessments.json

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

{"openapi":"3.0.0","info":{"description":"API spec for Microsoft.Security (Azure Security Center) resource provider","title":"Security Center","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-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"security-serverVulnerabilityAssessments","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments":{"get":{"description":"Gets a list of server vulnerability assessment onboarding statuses on a given resource.","operationId":"ServerVulnerabilityAssessment_ListByExtendedResource","parameters":[{"description":"Azure subscription ID","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","pattern":"^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The name of the resource group within the user's subscription. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"value":"vm1"}}},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"value":"2019-01-01-preview"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessmentsList"},"examples":{"Get a list of server vulnerability assessments on a resource. Though this API returns a list, Currently Microsoft.Security only supports a single default type of server vulnerability assessment":{"$ref":"#/components/examples/Get_a_list_of_server_vulnerability_assessments_on_a_resource._Though_this_API_returns_a_list_Currently_Microsoft.Security_only_supports_a_single_default_type_of_server_vulnerability_assessment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response structure.","properties":{"error":{"description":"Error details.","properties":{"code":{"description":"An identifier for the error. Codes are invariant and are intended to be consumed programmatically.","readOnly":true,"type":"string"},"message":{"description":"A message describing the error, intended to be suitable for display in a user interface.","readOnly":true,"type":"string"}},"type":"object","x-ms-external":true}},"type":"object","x-ms-external":true}}}}},"tags":["ServerVulnerabilityAssessments"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments/{serverVulnerabilityAssessment}":{"delete":{"description":"Removing server vulnerability assessment from a resource.","operationId":"ServerVulnerabilityAssessment_Delete","parameters":[{"description":"Azure subscription ID","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","pattern":"^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$"},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The name of the resource group within the user's subscription. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"vm1"}}},{"description":"ServerVulnerabilityAssessment status. only a 'default' value is supported.","in":"path","name":"serverVulnerabilityAssessment","required":true,"schema":{"type":"string","enum":["default"]},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"default"}}},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete a server vulnerability assessments on a resource. Only 'default' resource is supported. Once deleting, Microsoft.Security will not provide vulnerability assessment findings on the resource.":{"value":"2019-01-01-preview"}}}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content - Resource does not exist"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response structure.","properties":{"error":{"description":"Error details.","properties":{"code":{"description":"An identifier for the error. Codes are invariant and are intended to be consumed programmatically.","readOnly":true,"type":"string"},"message":{"description":"A message describing the error, intended to be suitable for display in a user interface.","readOnly":true,"type":"string"}},"type":"object","x-ms-external":true}},"type":"object","x-ms-external":true}}}}},"tags":["ServerVulnerabilityAssessment"]},"get":{"description":"Gets a server vulnerability assessment onboarding statuses on a given resource.","operationId":"ServerVulnerabilityAssessment_Get","parameters":[{"description":"Azure subscription ID","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","pattern":"^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The name of the resource group within the user's subscription. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"vm1"}}},{"description":"ServerVulnerabilityAssessment status. only a 'default' value is supported.","in":"path","name":"serverVulnerabilityAssessment","required":true,"schema":{"type":"string","enum":["default"]},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"default"}}},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"value":"2019-01-01-preview"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"examples":{"Get a server vulnerability assessments onboarding status on a resource. Currently Microsoft.Security only supports the single 'default' resource":{"$ref":"#/components/examples/Get_a_server_vulnerability_assessments_onboarding_status_on_a_resource._Currently_Microsoft.Security_only_supports_the_single_default_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response structure.","properties":{"error":{"description":"Error details.","properties":{"code":{"description":"An identifier for the error. Codes are invariant and are intended to be consumed programmatically.","readOnly":true,"type":"string"},"message":{"description":"A message describing the error, intended to be suitable for display in a user interface.","readOnly":true,"type":"string"}},"type":"object","x-ms-external":true}},"type":"object","x-ms-external":true}}}}},"tags":["ServerVulnerabilityAssessments"]},"put":{"description":"Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it","operationId":"ServerVulnerabilityAssessment_CreateOrUpdate","parameters":[{"description":"Azure subscription ID","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","pattern":"^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"The name of the resource group within the user's subscription. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"vm1"}}},{"description":"ServerVulnerabilityAssessment status. only a 'default' value is supported.","in":"path","name":"serverVulnerabilityAssessment","required":true,"schema":{"type":"string","enum":["default"]},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"default"}}},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"value":"2019-01-01-preview"}}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"examples":{"Create a server vulnerability assessments on a resource. Only 'default' resource is supported. Once creating the resource, the server will be onboarded to vulnerability assessment by Microsoft.Security":{"$ref":"#/components/examples/Create_a_server_vulnerability_assessments_on_a_resource._Only_default_resource_is_supported._Once_creating_the_resource_the_server_will_be_onboarded_to_vulnerability_assessment_by_Microsoft.Security"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response structure.","properties":{"error":{"description":"Error details.","properties":{"code":{"description":"An identifier for the error. Codes are invariant and are intended to be consumed programmatically.","readOnly":true,"type":"string"},"message":{"description":"A message describing the error, intended to be suitable for display in a user interface.","readOnly":true,"type":"string"}},"type":"object","x-ms-external":true}},"type":"object","x-ms-external":true}}}}},"tags":["ServerVulnerabilityAssessment"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_a_list_of_server_vulnerability_assessments_on_a_resource._Though_this_API_returns_a_list_Currently_Microsoft.Security_only_supports_a_single_default_type_of_server_vulnerability_assessment":{"value":{"value":[{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/serverVulnerabilityAssessments/default","name":"default","properties":{"provisioningState":"Succeeded"},"type":"Microsoft.Security/serverVulnerabilityAssessments"}]}},"Get_a_server_vulnerability_assessments_onboarding_status_on_a_resource._Currently_Microsoft.Security_only_supports_the_single_default_resource":{"value":{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/serverVulnerabilityAssessments/default","name":"default","properties":{"provisioningState":"Succeeded"},"type":"Microsoft.Security/serverVulnerabilityAssessments"}},"Create_a_server_vulnerability_assessments_on_a_resource._Only_default_resource_is_supported._Once_creating_the_resource_the_server_will_be_onboarded_to_vulnerability_assessment_by_Microsoft.Security":{"value":{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/serverVulnerabilityAssessments/default","name":"default","properties":{"provisioningState":"Provisioning"},"type":"Microsoft.Security/serverVulnerabilityAssessments"}}},"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":{"ServerVulnerabilityAssessment":{"allOf":[{"description":"Describes an Azure resource.","properties":{"id":{"description":"Resource Id","readOnly":true,"type":"string"},"name":{"description":"Resource name","readOnly":true,"type":"string"},"type":{"description":"Resource type","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Describes the server vulnerability assessment details on a resource","properties":{"properties":{"$ref":"#/components/schemas/ServerVulnerabilityAssessmentProperties"}},"type":"object"},"ServerVulnerabilityAssessmentProperties":{"description":"describes ServerVulnerabilityAssessment properties.","properties":{"provisioningState":{"description":"The provisioningState of the vulnerability assessment capability on the VM","enum":["Succeeded","Failed","Canceled","Provisioning","Deprovisioning"],"readOnly":true,"type":"string"}},"type":"object"},"ServerVulnerabilityAssessmentsList":{"description":"List of server vulnerability assessments","properties":{"value":{"items":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"type":"array"}},"type":"object"}}}}