openapi-directory/api/azure.com/frontdoor-networkexperiment.json

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

{"openapi":"3.0.0","info":{"description":"These are the Network Experiment APIs.\n","title":"NetworkExperiments","version":"2019-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/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/networkexperiment.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"frontdoor-networkexperiment","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"tags":[{"description":"The configuration of Network Experiment profiles","name":"NetworkExperimentProfiles"},{"description":"The configuration of the Network Experiment experiments","name":"Experiments"},{"description":"The preconfigured endpoints and details","name":"PreconfiguredEndpoints"},{"description":"The analysis and results of the experiments","name":"Reports"}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/NetworkExperimentProfiles":{"get":{"operationId":"NetworkExperimentProfiles_List","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"List NetworkExperiment Profiles in a Resource Group":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List NetworkExperiment Profiles in a Resource Group":{"value":"2019-11-01"}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileList"},"examples":{"List NetworkExperiment Profiles in a Resource Group":{"$ref":"#/components/examples/List_NetworkExperiment_Profiles_in_a_Resource_Group"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets a list of Network Experiment Profiles under a subscription","tags":["NetworkExperimentProfiles"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles":{"get":{"operationId":"NetworkExperimentProfiles_ListByResourceGroup","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"List NetworkExperiment Profiles in a Resource Group":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List NetworkExperiment Profiles in a Resource Group":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileList"},"examples":{"List NetworkExperiment Profiles in a Resource Group":{"$ref":"#/components/examples/List_NetworkExperiment_Profiles_in_a_Resource_Group"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets a list of Network Experiment Profiles within a resource group under a subscription","tags":["NetworkExperimentProfiles"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}":{"delete":{"operationId":"NetworkExperimentProfiles_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Deletes an NetworkExperiment Profile by ProfileName":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Deletes an NetworkExperiment Profile by ProfileName":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously."},"204":{"description":"No Content. The request has been accepted but the profile was not found."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Deletes an NetworkExperiment Profile by ProfileName","tags":["NetworkExperimentProfiles"],"x-ms-long-running-operation":true},"get":{"operationId":"NetworkExperimentProfiles_Get","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Gets an NetworkExperiment Profile by Profile Id":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Gets an NetworkExperiment Profile by Profile Id":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"examples":{"Gets an NetworkExperiment Profile by Profile Id":{"$ref":"#/components/examples/Gets_an_NetworkExperiment_Profile_by_Profile_Id"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets an NetworkExperiment Profile by ProfileName","tags":["NetworkExperimentProfiles"]},"patch":{"description":"Updates an NetworkExperimentProfiles","operationId":"NetworkExperimentProfiles_Update","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Updates an Experiment":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Updates an Experiment":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileUpdateModel"}}},"description":"The Profile Update Model","required":true},"responses":{"200":{"description":"OK. successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"examples":{"Updates an Experiment":{"$ref":"#/components/examples/Updates_an_Experiment"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"examples":{"Updates an Experiment":{"$ref":"#/components/examples/Updates_an_Experiment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Updates an NetworkExperimentProfiles by NetworkExperimentProfile name","tags":["NetworkExperimentProfiles"],"x-ms-long-running-operation":true},"put":{"operationId":"NetworkExperimentProfiles_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ProfileNameParameter"},{"description":"The subscription credentials which uniquely identify the 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":{"Creates an NetworkExperiment Profile in a Resource Group":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Creates an NetworkExperiment Profile in a Resource Group":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}},"description":"An Network Experiment Profile","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"examples":{"Creates an NetworkExperiment Profile in a Resource Group":{"$ref":"#/components/examples/Creates_an_NetworkExperiment_Profile_in_a_Resource_Group"}}}}},"201":{"description":"Created. The request has been fulfilled and a new protection policy has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"examples":{"Creates an NetworkExperiment Profile in a Resource Group":{"$ref":"#/components/examples/Creates_an_NetworkExperiment_Profile_in_a_Resource_Group"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"examples":{"Creates an NetworkExperiment Profile in a Resource Group":{"$ref":"#/components/examples/Creates_an_NetworkExperiment_Profile_in_a_Resource_Group"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Creates an NetworkExperiment Profile","tags":["NetworkExperimentProfiles"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments":{"get":{"operationId":"Experiments_ListByProfile","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Gets a list of Experiments":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Gets a list of Experiments":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperimentList"},"examples":{"Gets a list of Experiments":{"$ref":"#/components/examples/Gets_a_list_of_Experiments"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets a list of Experiments","tags":["Experiments"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}":{"delete":{"operationId":"Experiments_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Deletes an Experiment":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Deletes an Experiment":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"},{"$ref":"#/components/parameters/ExperimentNameParameter"}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously."},"204":{"description":"No Content. The request has been accepted but the policy was not found."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Deletes an Experiment","tags":["Experiments"],"x-ms-long-running-operation":true},"get":{"operationId":"Experiments_Get","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Gets an Experiment by ExperimentName":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Gets an Experiment by ExperimentName":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"},{"$ref":"#/components/parameters/ExperimentNameParameter"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"},"examples":{"Gets an Experiment by ExperimentName":{"$ref":"#/components/examples/Gets_an_Experiment_by_ExperimentName"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets an Experiment by ExperimentName","tags":["Experiments"]},"patch":{"description":"Updates an Experiment","operationId":"Experiments_Update","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Updates an Experiment":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Updates an Experiment":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"},{"$ref":"#/components/parameters/ExperimentNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperimentUpdateModel"}}},"description":"The Experiment Update Model","required":true},"responses":{"200":{"description":"OK. successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"},"examples":{"Updates an Experiment":{"$ref":"#/components/examples/Updates_an_Experiment"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"},"examples":{"Updates an Experiment":{"$ref":"#/components/examples/Updates_an_Experiment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Updates an Experiment by Experiment id","tags":["Experiments"],"x-ms-long-running-operation":true},"put":{"operationId":"Experiments_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Creates an Experiment":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Creates an Experiment":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"},{"$ref":"#/components/parameters/ExperimentNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"}}},"description":"The Experiment resource","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"},"examples":{"Creates an Experiment":{"$ref":"#/components/examples/Creates_an_Experiment"}}}}},"201":{"description":"Created. The request has been fulfilled and a new experiment has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"},"examples":{"Creates an Experiment":{"$ref":"#/components/examples/Creates_an_Experiment"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experiment"},"examples":{"Creates an Experiment":{"$ref":"#/components/examples/Creates_an_Experiment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Creates or updates an Experiment","tags":["Experiments"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/LatencyScorecard":{"get":{"operationId":"Reports_GetLatencyScorecards","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Gets a Latency Scorecard for a given Experiment":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Gets a Latency Scorecard for a given Experiment":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"},{"$ref":"#/components/parameters/ExperimentNameParameter"},{"description":"The end DateTime of the Latency Scorecard in UTC","in":"query","name":"endDateTimeUTC","required":false,"schema":{"type":"string"}},{"description":"The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html","in":"query","name":"country","required":false,"schema":{"type":"string"}},{"description":"The aggregation interval of the Latency Scorecard","in":"query","name":"aggregationInterval","required":true,"x-ms-enum":{"modelAsString":true,"name":"latencyScorecardAggregationInterval"},"schema":{"type":"string","enum":["Daily","Weekly","Monthly"]},"examples":{"Gets a Latency Scorecard for a given Experiment":{"value":"Daily"}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LatencyScorecard"},"examples":{"Gets a Latency Scorecard for a given Experiment":{"$ref":"#/components/examples/Gets_a_Latency_Scorecard_for_a_given_Experiment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets a Latency Scorecard for a given Experiment","tags":["Reports"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/Timeseries":{"get":{"operationId":"Reports_GetTimeseries","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Gets a Timeseries for a given Experiment":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Gets a Timeseries for a given Experiment":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"},{"$ref":"#/components/parameters/ExperimentNameParameter"},{"description":"The start DateTime of the Timeseries in UTC","in":"query","name":"startDateTimeUTC","required":true,"schema":{"type":"string","format":"date-time"},"examples":{"Gets a Timeseries for a given Experiment":{"value":"2019-07-21T17:32:28Z"}}},{"description":"The end DateTime of the Timeseries in UTC","in":"query","name":"endDateTimeUTC","required":true,"schema":{"type":"string","format":"date-time"},"examples":{"Gets a Timeseries for a given Experiment":{"value":"2019-09-21T17:32:28Z"}}},{"description":"The aggregation interval of the Timeseries","in":"query","name":"aggregationInterval","required":true,"x-ms-enum":{"modelAsString":true,"name":"timeseriesAggregationInterval"},"schema":{"type":"string","enum":["Hourly","Daily"]},"examples":{"Gets a Timeseries for a given Experiment":{"value":"Hourly"}}},{"description":"The type of Timeseries","in":"query","name":"timeseriesType","required":true,"x-ms-enum":{"modelAsString":true,"name":"timeseriesType"},"schema":{"type":"string","enum":["MeasurementCounts","LatencyP50","LatencyP75","LatencyP95"]},"examples":{"Gets a Timeseries for a given Experiment":{"value":"MeasurementCounts"}}},{"description":"The specific endpoint","in":"query","name":"endpoint","required":false,"schema":{"type":"string"}},{"description":"The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html","in":"query","name":"country","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Timeseries"},"examples":{"Gets a Timeseries for a given Experiment":{"$ref":"#/components/examples/Gets_a_Timeseries_for_a_given_Experiment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets a Timeseries for a given Experiment","tags":["Reports"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/PreconfiguredEndpoints":{"get":{"operationId":"PreconfiguredEndpoints_List","parameters":[{"description":"The subscription credentials which uniquely identify the 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":{"Gets a list of Preconfigured Endpoints":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Gets a list of Preconfigured Endpoints":{"value":"2019-11-01"}}},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ProfileNameParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconfiguredEndpointList"},"examples":{"Gets a list of Preconfigured Endpoints":{"$ref":"#/components/examples/Gets_a_list_of_Preconfigured_Endpoints"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Gets a list of Preconfigured Endpoints","tags":["PreconfiguredEndpoints"],"x-ms-pageable":{"nextLinkName":"nextLink"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_NetworkExperiment_Profiles_in_a_Resource_Group":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/","location":"WestUs","name":"MyProfile","properties":{"enabledState":"Enabled","resourceState":"Creating"},"tags":{"key1":"value1","key2":"value2"},"type":"Microsoft.Network/NetworkExperimentprofiles"}]}},"Gets_an_NetworkExperiment_Profile_by_Profile_Id":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile","location":"WestUs","name":"MyProfile","properties":{"enabledState":"Enabled","resourceState":"Creating"},"tags":{"key1":"value1","key2":"value2"}}},"Updates_an_Experiment":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment","location":"WestUs","name":"MyExperiment","properties":{"description":"this is my first experiment!","enabledState":"Enabled","endpointA":{"endpoint":"endpointA.net","name":"endpoint A"},"endpointB":{"endpoint":"endpointB.net","name":"endpoint B"},"resourceState":"Creating","scriptFileUri":"www.myScript.com","status":"ongoing"},"tags":{"key1":"value1","key2":"value2"},"type":"Microsoft.Network/NetworkExperimentprofiles"}},"Creates_an_NetworkExperiment_Profile_in_a_Resource_Group":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile","location":"WestUs","name":"MyProfile","properties":{"enabledState":"Enabled","resourceState":"Creating"},"tags":{"key1":"value1","key2":"value2"},"type":"Microsoft.Network/NetworkExperimentprofiles"}},"Gets_a_list_of_Experiments":{"value":{"value":[{"id":"/subscriptions/subId/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments","name":"MyExperiment","properties":{"description":"this is my first experiment!","enabledState":"Enabled","endpointA":{"endpoint":"endpointA.net","name":"endpoint A"},"endpointB":{"endpoint":"endpointB.net","name":"endpoint B"},"resourceState":"Creating","scriptFileUri":"www.myScript.com","status":"ongoing"}}]}},"Gets_an_Experiment_by_ExperimentName":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment","location":"WestUs","name":"MyExperiment","properties":{"description":"this is my first experiment!","enabledState":"Enabled","endpointA":{"endpoint":"endpointA.net","name":"endpoint A"},"endpointB":{"endpoint":"endpointB.net","name":"endpoint B"},"resourceState":"Creating","scriptFileUri":"www.myScript.com","status":"ongoing"},"tags":{"key1":"value1","key2":"value2"}}},"Creates_an_Experiment":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment","location":"WestUs","name":"MyExperiment","properties":{"description":"this is my first experiment!","enabledState":"Enabled","endpointA":{"endpoint":"endpointA.net","name":"endpoint A"},"endpointB":{"endpoint":"endpointB.net","name":"endpoint B"},"resourceState":"Creating","scriptFileUri":"www.myScript.com","status":"ongoing"},"tags":{"key1":"value1","key2":"value2"}}},"Gets_a_Latency_Scorecard_for_a_given_Experiment":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment/LatencyScorecard","name":"DailyLatencyScorecard","properties":{"country":"USA","description":"This scorecard is the latency scorecard, aggregated over a day","endDateTimeUTC":"2019-09-21T17:32:28Z","endpointA":"https://endpointA.com","endpointB":"https://endpoingB.com","startDateTimeUTC":"2019-07-21T17:32:28Z"}}},"Gets_a_Timeseries_for_a_given_Experiment":{"value":{"id":"/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment/Timeseries","properties":{"aggregationInterval":"Hourly","country":"United States","endDateTimeUTC":"2019-08-02","endpoint":"https://endpointA.com","startDateTimeUTC":"2019-07-29","timeseriesData":[{"dateTimeUTC":"2019-07-22T17:32:28Z","value":79}],"timeseriesType":"MeasurementCounts"}}},"Gets_a_list_of_Preconfigured_Endpoints":{"value":{"nextLink":"string","value":[{"name":"Endpoint 1","properties":{"backend":"WESTUS","description":"this is the endpoint 1 preconfigured endpoint.","endpoint":"endpoint1.net","endpointType":"AFD"}}]}}},"parameters":{"ExperimentNameParameter":{"description":"The Experiment identifier associated with the Experiment","in":"path","name":"experimentName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","pattern":"^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$"},"examples":{"Deletes an Experiment":{"value":"MyExperiment"},"Gets an Experiment by ExperimentName":{"value":"MyExperiment"},"Updates an Experiment":{"value":"MyExperiment"},"Creates an Experiment":{"value":"MyExperiment"},"Gets a Latency Scorecard for a given Experiment":{"value":"MyExperiment"},"Gets a Timeseries for a given Experiment":{"value":"MyExperiment"}}},"ProfileNameParameter":{"description":"The Profile identifier associated with the Tenant and Partner","in":"path","name":"profileName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","pattern":"^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$"},"examples":{"Deletes an NetworkExperiment Profile by ProfileName":{"value":"MyProfile"},"Gets an NetworkExperiment Profile by Profile Id":{"value":"MyProfile"},"Updates an Experiment":{"value":"MyProfile"},"Creates an NetworkExperiment Profile in a Resource Group":{"value":"MyProfile"},"Gets a list of Experiments":{"value":"MyProfile"},"Deletes an Experiment":{"value":"MyProfile"},"Gets an Experiment by ExperimentName":{"value":"MyProfile"},"Creates an Experiment":{"value":"MyProfile"},"Gets a Latency Scorecard for a given Experiment":{"value":"MyProfile"},"Gets a Timeseries for a given Experiment":{"value":"MyProfile"},"Gets a list of Preconfigured Endpoints":{"value":"MyProfile"}}},"ResourceGroupNameParameter":{"description":"Name of the Resource group within the Azure subscription.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$"},"examples":{"List NetworkExperiment Profiles in a Resource Group":{"value":"MyResourceGroup"},"Deletes an NetworkExperiment Profile by ProfileName":{"value":"MyResourceGroup"},"Gets an NetworkExperiment Profile by Profile Id":{"value":"MyResourceGroup"},"Updates an Experiment":{"value":"MyResourceGroup"},"Creates an NetworkExperiment Profile in a Resource Group":{"value":"MyResourceGroup"},"Gets a list of Experiments":{"value":"MyResourceGroup"},"Deletes an Experiment":{"value":"MyResourceGroup"},"Gets an Experiment by ExperimentName":{"value":"MyResourceGroup"},"Creates an Experiment":{"value":"MyResourceGroup"},"Gets a Latency Scorecard for a given Experiment":{"value":"MyResourceGroup"},"Gets a Timeseries for a given Experiment":{"value":"MyResourceGroup"},"Gets a list of Preconfigured Endpoints":{"value":"MyResourceGroup"}}}},"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":{"Endpoint":{"description":"Defines the endpoint properties","properties":{"endpoint":{"description":"The endpoint URL","type":"string"},"name":{"description":"The name of the endpoint","type":"string"}},"type":"object"},"ErrorResponse":{"description":"Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"Error message indicating why the operation failed.","readOnly":true,"type":"string"}},"type":"object"},"Experiment":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Defines the properties of an Experiment","properties":{"name":{"description":"The name of the Experiment","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/ExperimentProperties"}}},"ExperimentList":{"description":"Defines a list of Experiments. It contains a list of Experiment objects and a URL link to get the next set of results.","properties":{"nextLink":{"description":"URL to get the next set of Experiment objects if there are any.","type":"string"},"value":{"description":"List of Experiments within a resource group.","items":{"$ref":"#/components/schemas/Experiment"},"readOnly":true,"type":"array"}}},"ExperimentProperties":{"description":"Defines the properties of an experiment","properties":{"description":{"description":"The description of the details or intents of the Experiment","type":"string"},"enabledState":{"description":"The state of the Experiment","enum":["Enabled","Disabled"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"state"}},"endpointA":{"$ref":"#/components/schemas/Endpoint"},"endpointB":{"$ref":"#/components/schemas/Endpoint"},"resourceState":{"$ref":"#/components/schemas/NetworkExperimentResourceState"},"scriptFileUri":{"description":"The uri to the Script used in the Experiment","readOnly":true,"type":"string"},"status":{"description":"The description of Experiment status from the server side","readOnly":true,"type":"string"}},"type":"object"},"ExperimentUpdateModel":{"description":"Defines modifiable attributes of an Experiment","properties":{"properties":{"$ref":"#/components/schemas/ExperimentUpdateProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}},"type":"object"},"ExperimentUpdateProperties":{"description":"Defines the properties of an experiment","properties":{"description":{"description":"The description of the intent or details of the Experiment","type":"string"},"enabledState":{"description":"The state of the Experiment","enum":["Enabled","Disabled"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"state"}}},"type":"object"},"LatencyMetric":{"description":"Defines the properties of a latency metric used in the latency scorecard","properties":{"aCLower95CI":{"description":"The lower end of the 95% confidence interval for endpoint A","readOnly":true,"type":"number"},"aHUpper95CI":{"description":"The upper end of the 95% confidence interval for endpoint A","readOnly":true,"type":"number"},"aValue":{"description":"The metric value of the A endpoint","readOnly":true,"type":"number"},"bCLower95CI":{"description":"The lower end of the 95% confidence interval for endpoint B","readOnly":true,"type":"number"},"bUpper95CI":{"description":"The upper end of the 95% confidence interval for endpoint B","readOnly":true,"type":"number"},"bValue":{"description":"The metric value of the B endpoint","readOnly":true,"type":"number"},"delta":{"description":"The difference in value between endpoint A and B","readOnly":true,"type":"number"},"deltaPercent":{"description":"The percent difference between endpoint A and B","readOnly":true,"type":"number"},"endDateTimeUTC":{"description":"The end time of the Latency Scorecard in UTC","readOnly":true,"type":"string"},"name":{"description":"The name of the Latency Metric","readOnly":true,"type":"string"}},"type":"object"},"LatencyScorecard":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Defines the LatencyScorecard","properties":{"properties":{"$ref":"#/components/schemas/LatencyScorecardProperties"}}},"LatencyScorecardProperties":{"description":"Defines a the properties of a Latency Scorecard","properties":{"country":{"description":"The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html","readOnly":true,"type":"string"},"description":{"description":"The description of the Latency Scorecard","readOnly":true,"type":"string"},"endDateTimeUTC":{"description":"The end time of the Latency Scorecard in UTC","format":"date-time","readOnly":true,"type":"string"},"endpointA":{"description":"The A endpoint in the scorecard","readOnly":true,"type":"string"},"endpointB":{"description":"The B endpoint in the scorecard","readOnly":true,"type":"string"},"id":{"description":"The unique identifier of the Latency Scorecard","readOnly":true,"type":"string"},"latencyMetrics":{"description":"The latency metrics of the Latency Scorecard","items":{"$ref":"#/components/schemas/LatencyMetric"},"type":"array"},"name":{"description":"The name of the Latency Scorecard","readOnly":true,"type":"string"},"startDateTimeUTC":{"description":"The start time of the Latency Scorecard in UTC","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"NetworkExperimentResourceState":{"description":"Defines the server side resource status","enum":["Creating","Enabling","Enabled","Disabling","Disabled","Deleting"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"NetworkExperimentResourceState"}},"PreconfiguredEndpoint":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Defines the properties of a preconfigured endpoint","properties":{"name":{"description":"The name of the endpoint","type":"string"},"properties":{"$ref":"#/components/schemas/PreconfiguredEndpointProperties"}}},"PreconfiguredEndpointList":{"description":"Defines a list of preconfigured endpoints.","properties":{"nextLink":{"description":"URL to get the next set of PreconfiguredEndpoints if there are any.","type":"string"},"value":{"description":"List of PreconfiguredEndpoints supported by NetworkExperiment.","items":{"$ref":"#/components/schemas/PreconfiguredEndpoint"},"readOnly":true,"type":"array"}}},"PreconfiguredEndpointProperties":{"description":"Defines the properties of a preconfigured endpoint","properties":{"backend":{"description":"The preconfigured endpoint backend","type":"string"},"description":{"description":"The description of the endpoint","type":"string"},"endpoint":{"description":"The endpoint that is preconfigured","type":"string"},"endpointType":{"description":"The type of endpoint","enum":["AFD","AzureRegion","CDN","ATM"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"endpointType"}}},"type":"object"},"Profile":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Defines an Network Experiment Profile and lists of Experiments","properties":{"etag":{"description":"Gets a unique read-only string that changes whenever the resource is updated.","type":"string"},"name":{"description":"The name of the Profile","type":"string"},"properties":{"$ref":"#/components/schemas/ProfileProperties"}}},"ProfileList":{"description":"Defines a list of Profiles. It contains a list of Profile objects and a URL link to get the next set of results.","properties":{"nextLink":{"description":"URL to get the next set of Profile objects if there are any.","type":"string"},"value":{"description":"List of Profiles within a resource group.","items":{"$ref":"#/components/schemas/Profile"},"readOnly":true,"type":"array"}}},"ProfileProperties":{"description":"Defines the properties of an experiment","properties":{"enabledState":{"description":"The state of the Experiment","enum":["Enabled","Disabled"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"state"}},"resourceState":{"$ref":"#/components/schemas/NetworkExperimentResourceState"}},"type":"object"},"ProfileUpdateModel":{"description":"Defines modifiable attributes of a Profile","properties":{"properties":{"$ref":"#/components/schemas/ProfileUpdateProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}},"type":"object"},"ProfileUpdateProperties":{"description":"Defines the properties of an experiment","properties":{"enabledState":{"description":"The enabled state of the Profile","enum":["Enabled","Disabled"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"state"}}},"type":"object"},"Timeseries":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Defines the Timeseries","properties":{"properties":{"$ref":"#/components/schemas/TimeseriesProperties"}}},"TimeseriesDataPoint":{"description":"Defines a timeseries datapoint used in a timeseries","properties":{"dateTimeUTC":{"description":"The DateTime of the Timeseries data point in UTC","type":"string"},"value":{"description":"The Value of the Timeseries data point","type":"number"}},"type":"object"},"TimeseriesProperties":{"description":"Defines the properties of a timeseries","properties":{"aggregationInterval":{"description":"The aggregation interval of the Timeseries","enum":["Hourly","Daily"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"aggregationInterval"}},"country":{"description":"The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html","type":"string"},"endDateTimeUTC":{"description":"The end DateTime of the Timeseries in UTC","type":"string"},"endpoint":{"description":"The endpoint associated with the Timeseries data point","type":"string"},"startDateTimeUTC":{"description":"The start DateTime of the Timeseries in UTC","type":"string"},"timeseriesData":{"description":"The set of data points for the timeseries","items":{"$ref":"#/components/schemas/TimeseriesDataPoint"},"type":"array"},"timeseriesType":{"description":"The type of Timeseries","enum":["MeasurementCounts","LatencyP50","LatencyP75","LatencyP95"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"timeseriesType"}}},"type":"object"}}}}