openapi-directory/api/azure.com/security-adaptiveNetworkHardenings.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":"2015-06-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/2015-06-01-preview/adaptiveNetworkHardenings.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"security-adaptiveNetworkHardenings","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings":{"get":{"description":"Gets a list of Adaptive Network Hardenings resources in scope of an extended resource.","operationId":"AdaptiveNetworkHardenings_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":{"List Adaptive Network Hardenings resources of an extended 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":{"List Adaptive Network Hardenings resources of an extended resource":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"List Adaptive Network Hardenings resources of an extended resource":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"List Adaptive Network Hardenings resources of an extended resource":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"List Adaptive Network Hardenings resources of an extended resource":{"value":"vm1"}}},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List Adaptive Network Hardenings resources of an extended resource":{"value":"2015-06-01-preview"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdaptiveNetworkHardeningsList"},"examples":{"List Adaptive Network Hardenings resources of an extended resource":{"$ref":"#/components/examples/List_Adaptive_Network_Hardenings_resources_of_an_extended_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":["AdaptiveNetworkHardenings"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}":{"get":{"description":"Gets a single Adaptive Network Hardening resource","operationId":"AdaptiveNetworkHardenings_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 single Adaptive Network Hardening 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 single Adaptive Network Hardening resource":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"Get a single Adaptive Network Hardening resource":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"Get a single Adaptive Network Hardening resource":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Get a single Adaptive Network Hardening resource":{"value":"vm1"}}},{"$ref":"#/components/parameters/AdaptiveNetworkHardeningResourceName"},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a single Adaptive Network Hardening resource":{"value":"2015-06-01-preview"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdaptiveNetworkHardening"},"examples":{"Get a single Adaptive Network Hardening resource":{"$ref":"#/components/examples/Get_a_single_Adaptive_Network_Hardening_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":["AdaptiveNetworkHardenings"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}/{adaptiveNetworkHardeningEnforceAction}":{"post":{"description":"Enforces the given rules on the NSG(s) listed in the request","operationId":"AdaptiveNetworkHardenings_Enforce","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":{"Enforces the given rules on the NSG(s) listed in the request":{"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":{"Enforces the given rules on the NSG(s) listed in the request":{"value":"rg1"}}},{"description":"The Namespace of the resource.","in":"path","name":"resourceNamespace","required":true,"schema":{"type":"string"},"examples":{"Enforces the given rules on the NSG(s) listed in the request":{"value":"Microsoft.Compute"}}},{"description":"The type of the resource.","in":"path","name":"resourceType","required":true,"schema":{"type":"string"},"examples":{"Enforces the given rules on the NSG(s) listed in the request":{"value":"virtualMachines"}}},{"description":"Name of the resource.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"Enforces the given rules on the NSG(s) listed in the request":{"value":"vm1"}}},{"$ref":"#/components/parameters/AdaptiveNetworkHardeningResourceName"},{"$ref":"#/components/parameters/AdaptiveNetworkHardeningEnforceAction"},{"description":"API version for the operation","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Enforces the given rules on the NSG(s) listed in the request":{"value":"2015-06-01-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdaptiveNetworkHardeningEnforceRequest"}}},"required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK."},"202":{"description":"Accepted"},"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":["AdaptiveNetworkHardenings"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_Adaptive_Network_Hardenings_resources_of_an_extended_resource":{"value":{"value":[{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default","name":"default","properties":{"effectiveNetworkSecurityGroups":[{"networkInterface":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1","networkSecurityGroups":["/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg","/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg"]},{"networkInterface":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic2","networkSecurityGroups":["/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg2"]}],"rules":[{"destinationPort":3389,"direction":"Inbound","ipAddresses":["100.10.1.1","200.20.2.2","81.199.3.0/24"],"name":"rule1","protocols":["TCP"]},{"destinationPort":22,"direction":"Inbound","ipAddresses":[],"name":"rule2","protocols":["TCP"]}],"rulesCalculationTime":"2018-08-15T00:00:00.0000000Z"},"type":"Microsoft.Security/adaptiveNetworkHardenings"}]}},"Get_a_single_Adaptive_Network_Hardening_resource":{"value":{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default","name":"default","properties":{"effectiveNetworkSecurityGroups":[{"networkInterface":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1","networkSecurityGroups":["/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg","/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg"]},{"networkInterface":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2","networkSecurityGroups":["/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg"]}],"rules":[{"destinationPort":3389,"direction":"Inbound","ipAddresses":["100.10.1.1","200.20.2.2","81.199.3.0/24"],"name":"rule1","protocols":["TCP"]},{"destinationPort":22,"direction":"Inbound","ipAddresses":[],"name":"rule2","protocols":["TCP"]}],"rulesCalculationTime":"2018-08-15T00:00:00.0000000Z"},"type":"Microsoft.Security/adaptiveNetworkHardenings"}}},"parameters":{"AdaptiveNetworkHardeningEnforceAction":{"description":"Enforces the given rules on the NSG(s) listed in the request","in":"path","name":"adaptiveNetworkHardeningEnforceAction","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","enum":["enforce"]},"examples":{"Enforces the given rules on the NSG(s) listed in the request":{"value":"enforce"}}},"AdaptiveNetworkHardeningResourceName":{"description":"The name of the Adaptive Network Hardening resource.","in":"path","name":"adaptiveNetworkHardeningResourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a single Adaptive Network Hardening resource":{"value":"default"},"Enforces the given rules on the NSG(s) listed in the request":{"value":"default"}}}},"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":{"AdaptiveNetworkHardening":{"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":"The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource","properties":{"properties":{"$ref":"#/components/schemas/AdaptiveNetworkHardeningProperties"}}},"AdaptiveNetworkHardeningEnforceRequest":{"properties":{"networkSecurityGroups":{"description":"The Azure resource IDs of the effective network security groups that will be updated with the created security rules from the Adaptive Network Hardening rules","items":{"type":"string"},"type":"array"},"rules":{"description":"The rules to enforce","items":{"$ref":"#/components/schemas/Rule"},"type":"array"}},"required":["rules","networkSecurityGroups"],"type":"object"},"AdaptiveNetworkHardeningProperties":{"description":"Adaptive Network Hardening resource properties","properties":{"effectiveNetworkSecurityGroups":{"description":"The Network Security Groups effective on the network interfaces of the protected resource","items":{"$ref":"#/components/schemas/EffectiveNetworkSecurityGroups"},"type":"array"},"rules":{"description":"The security rules which are recommended to be effective on the VM","items":{"$ref":"#/components/schemas/Rule"},"type":"array"},"rulesCalculationTime":{"description":"The UTC time on which the rules were calculated","format":"date-time","type":"string"}}},"AdaptiveNetworkHardeningsList":{"description":"Response for ListAdaptiveNetworkHardenings API service call","properties":{"nextLink":{"description":"The URL to get the next set of results","type":"string"},"value":{"description":"A list of Adaptive Network Hardenings resources","items":{"$ref":"#/components/schemas/AdaptiveNetworkHardening"},"type":"array"}}},"EffectiveNetworkSecurityGroups":{"description":"Describes the Network Security Groups effective on a network interface","properties":{"networkInterface":{"description":"The Azure resource ID of the network interface","type":"string"},"networkSecurityGroups":{"description":"The Network Security Groups effective on the network interface","items":{"type":"string"},"type":"array"}}},"PortNumber":{"maximum":65535,"minimum":0,"type":"integer"},"Rule":{"description":"Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked","properties":{"destinationPort":{"$ref":"#/components/schemas/PortNumber"},"direction":{"description":"The rule's direction","enum":["Inbound","Outbound"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"direction"}},"ipAddresses":{"description":"The remote IP addresses that should be able to communicate with the Azure resource on the rule's destination port and protocol","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the rule","type":"string"},"protocols":{"description":"The rule's transport protocols","items":{"enum":["TCP","UDP"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"transportProtocol"}},"type":"array"}}}}}}