From 5351e881bb0e8290d4a59dab87383013456ccf5c Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 12:35:04 -0700 Subject: [PATCH 01/31] Add Tumbling Window dependsOn property to Trigger.json for Tumbling Window Trigger and self-dependent Tumbling Window Trigger --- .../entityTypes/Trigger.json | 115 +++++++++++++++++- 1 file changed, 114 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 921b0da9c4da..63e97444bd01 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,7 +381,14 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - } + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } + } }, "required": [ "frequency", @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 8b838c0d2844b3b53026507ad868dd6576783569 Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 14:43:59 -0700 Subject: [PATCH 02/31] revert tumbling window dependsOn property under preview, and apply same changes to stable --- .../entityTypes/Trigger.json | 115 +----------------- .../2018-06-01/entityTypes/Trigger.json | 113 +++++++++++++++++ 2 files changed, 114 insertions(+), 114 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 63e97444bd01..921b0da9c4da 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,14 +381,7 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - }, - "dependsOn": { - "type": "array", - "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", - "items": { - "$ref": "#/definitions/DependencyReference" - } - } + } }, "required": [ "frequency", @@ -429,112 +422,6 @@ "maximum": 86400 } } - }, - "TriggerReference": { - "description": "Trigger reference type.", - "type": "object", - "properties": { - "type": { - "description": "Trigger reference type.", - "type": "string", - "enum": [ - "TriggerReference" - ] - }, - "referenceName": { - "description": "Reference trigger name.", - "type": "string" - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "DependencyReference": { - "description": "Referenced dependency.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "description": "The type of dependency reference.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "TriggerDependencyReference": { - "description": "Trigger referenced dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "referenceTrigger": { - "description": "Referenced trigger.", - "$ref": "#/definitions/TriggerReference" - } - }, - "required": [ - "referenceTrigger" - ] - }, - "TumblingWindowTriggerDependencyReference": { - "description": "Referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TriggerDependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - } - }, - "SelfDependencyTumblingWindowTriggerReference": { - "description": "Self referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - }, - "required": [ - "offset" - ] } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json index eed541ff50d3..737431fcffe8 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json @@ -381,6 +381,13 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } } }, "required": [ @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 7f4d093f3d4cdee21f74d6cf1538a2c7e9197a9d Mon Sep 17 00:00:00 2001 From: Brian Fjeldstad Date: Fri, 13 Jul 2018 15:51:30 -0700 Subject: [PATCH 03/31] PR for public windows IoT resource provider (#3339) --- .../WindowsIotServices.json | 680 ++++++++++++++++++ .../examples/OperationsList.json | 58 ++ .../Service_CheckNameAvailability.json | 16 + .../examples/Service_Create.json | 28 + .../examples/Service_Delete.json | 22 + .../examples/Service_GetProperties.json | 25 + .../examples/Service_List.json | 74 ++ .../examples/Service_ListByResourceGroup.json | 39 + .../examples/Service_Update.json | 28 + .../windowsiot/resource-manager/readme.md | 42 ++ 10 files changed, 1012 insertions(+) create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json create mode 100644 specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json create mode 100644 specification/windowsiot/resource-manager/readme.md diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json new file mode 100644 index 000000000000..1f2ed9feabea --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json @@ -0,0 +1,680 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-02-16-preview", + "title": "DeviceServices", + "description": "Use this API to manage the Windows IoT device services in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.WindowsIoT/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Windows IoT Services REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/OperationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}": { + "get": { + "tags": [ + "DeviceServices" + ], + "description": "Get the non-security related metadata of a Windows IoT Device Service.", + "operationId": "Services_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Services_GetProperties": { + "$ref": "./examples/Service_GetProperties.json" + } + } + }, + "put": { + "tags": [ + "DeviceServices" + ], + "summary": "Create or update the metadata of a Windows IoT Device Service.", + "description": "Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.", + "operationId": "Services_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + }, + { + "name": "deviceService", + "in": "body", + "description": "The Windows IoT Device Service metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Windows IoT Device Service. Do not specify for creating a new Windows IoT Device Service. Required to update an existing Windows IoT Device Service." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_Create": { + "$ref": "./examples/Service_Create.json" + } + } + }, + "patch": { + "tags": [ + "DeviceServices" + ], + "summary": "Updates the metadata of a Windows IoT Device Service.", + "description": "Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.", + "operationId": "Services_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + }, + { + "name": "deviceService", + "in": "body", + "description": "The Windows IoT Device Service metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Windows IoT Device Service. Do not specify for creating a brand new Windows IoT Device Service. Required to update an existing Windows IoT Device Service." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_Update": { + "$ref": "./examples/Service_Update.json" + } + } + }, + "delete": { + "tags": [ + "DeviceServices" + ], + "description": "Delete a Windows IoT Device Service.", + "operationId": "Services_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_Delete": { + "$ref": "./examples/Service_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices": { + "get": { + "tags": [ + "DeviceServices" + ], + "description": "Get all the IoT hubs in a resource group.", + "operationId": "Services_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceServiceDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Service_ListByResourceGroup": { + "$ref": "./examples/Service_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/deviceServices": { + "get": { + "tags": [ + "DeviceServices" + ], + "description": "Get all the IoT hubs in a subscription.", + "operationId": "Services_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceServiceDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Service_List": { + "$ref": "./examples/Service_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/checkDeviceServiceNameAvailability": { + "post": { + "tags": [ + "CheckDeviceServiceNameAvailability" + ], + "description": "Check if a Windows IoT Device Service name is available.", + "operationId": "Services_CheckDeviceServiceNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "deviceServiceCheckNameAvailabilityParameters", + "in": "body", + "description": "Set the name parameter in the DeviceServiceCheckNameAvailabilityParameters structure to the name of the Windows IoT Device Service to check.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceServiceCheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceServiceNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_CheckNameAvailability": { + "$ref": "./examples/Service_CheckNameAvailability.json" + } + } + } + } + }, + "definitions": { + "DeviceServiceProperties": { + "description": "The properties of a Windows IoT Device Service.", + "type": "object", + "properties": { + "notes": { + "description": "Windows IoT Device Service notes.", + "type": "string" + }, + "startDate": { + "description": "Windows IoT Device Service start date,", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "quantity": { + "description": "Windows IoT Device Service device allocation,", + "type": "integer", + "format": "int64" + }, + "billingDomainName": { + "description": "Windows IoT Device Service ODM AAD domain", + "type": "string", + "readOnly": true + }, + "adminDomainName": { + "description": "Windows IoT Device Service OEM AAD domain", + "type": "string" + } + } + }, + "DeviceService": { + "description": "The description of the Windows IoT Device Service.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "The properties of a Windows IoT Device Service.", + "$ref": "#/definitions/DeviceServiceProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ] + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "OperationListResult": { + "description": "Result of the request to list Windows IoT Device Service operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Windows IoT Device Service operations supported by the Microsoft.WindowsIoT resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationEntity" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "OperationEntity": { + "description": "The operation supported by Azure Data Catalog Service.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Azure Data Catalog Service." + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Azure Data Catalog Service.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Azure Data Catalog Service.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error.", + "type": "string" + }, + "target": { + "description": "The target of the particular error.", + "type": "string" + }, + "details": { + "description": "A human-readable representation of the error's details.", + "type": "string" + } + } + }, + "DeviceServiceDescriptionListResult": { + "description": "The JSON-serialized array of DeviceService objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of DeviceService objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceService" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "DeviceServiceCheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Windows IoT Device Service to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "DeviceServiceNameAvailabilityInfo": { + "description": "The properties indicating whether a given Windows IoT Device Service name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "serviceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the Windows IoT Device Service.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeviceNameParameter": { + "name": "deviceName", + "in": "path", + "description": "The name of the Windows IoT Device Service.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json new file mode 100644 index 000000000000..bd7fbb7da7a7 --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.WindowsIoT/Services/write", + "display": { + "provider": "Windows IoT", + "resource": "Windows IoT Services", + "operation": "Create/Update Windows IoT Subscription", + "description": "Creates a Windows IoT Subscription with the specified parameters or update the properties or tags or adds custom domain for the specified Windows IoT Subscription." + } + }, + { + "name": "Microsoft.WindowsIoT/Services/delete", + "display": { + "provider": "Windows IoT", + "resource": "Windows IoT Services", + "operation": "Delete Windows IoT Subscription", + "description": "Deletes an existing Windows IoT Subscription." + } + }, + { + "name": "Microsoft.WindowsIoT/checkNameAvailability/read", + "display": { + "provider": "Windows IoT", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that account name is valid and is not in use." + } + }, + { + "name": "Microsoft.WindowsIoT/Services/read", + "display": { + "provider": "Windows IoT", + "resource": "Windows IoT Services", + "operation": "List/Get Windows IoT Subscription(s)", + "description": "Returns the list of Windows IoT Services or gets the properties for the specified Windows IoT Subscription." + } + }, + { + "name": "Microsoft.WindowsIoT/operations/read", + "display": { + "provider": "Windows IoT", + "resource": "Operations", + "operation": "Poll Asynchronous Operation", + "description": "Polls the status of an asynchronous operation." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json new file mode 100644 index 000000000000..5e262a63b387 --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "api-version": "2018-02-16-preview", + "deviceServiceCheckNameAvailabilityParameters": { + "name": "service3363" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json new file mode 100644 index 000000000000..c91d9ff160eb --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "resourceGroupName": "res9101", + "deviceName": "service4445", + "api-version": "2018-02-16-preview", + "deviceService": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "quantity": 1000000 + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json new file mode 100644 index 000000000000..854d399ca3a0 --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "resourceGroupName": "res4228", + "deviceName": "service2434", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json new file mode 100644 index 000000000000..432bbd85ed8e --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "45b60d85-fd72-427a-a708-f994d26e593e", + "resourceGroupName": "res9407", + "deviceName": "service8596", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/res9407/providers/Microsoft.WindowsIoT/Services/service8596", + "name": "service8596", + "location": "westus", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json new file mode 100644 index 000000000000..877b619f071e --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res2627/providers/Microsoft.WindowsIoT/Services/service1125", + "name": "service1125", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/testcmk3/providers/Microsoft.WindowsIoT/Services/service3699", + "name": "service3699", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/testcmk3/providers/Microsoft.WindowsIoT/Services/service6637", + "name": "service6637", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res8186/providers/Microsoft.WindowsIoT/Services/service834", + "name": "service834", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/testcmk3/providers/Microsoft.WindowsIoT/Services/service9174", + "name": "service9174", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json new file mode 100644 index 000000000000..0e4ce008ab1e --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "resourceGroupName": "res6117", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res6117/providers/Microsoft.WindowsIoT/Services/service4036", + "name": "service4036", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res6117/providers/Microsoft.WindowsIoT/Services/service4452", + "name": "service4452", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json new file mode 100644 index 000000000000..b93d6efcd79f --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "45b60d85-fd72-427a-a708-f994d26e593e", + "resourceGroupName": "res9407", + "deviceName": "service8596", + "api-version": "2018-02-16-preview", + "deviceService": { + "notes": "blah", + "quantity": 1000000 + }, + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "location": "westus", + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/readme.md b/specification/windowsiot/resource-manager/readme.md new file mode 100644 index 000000000000..eb82567de728 --- /dev/null +++ b/specification/windowsiot/resource-manager/readme.md @@ -0,0 +1,42 @@ +# Services + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Services. + + + +--- +## Getting Started +To build the SDK for Services, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Services API. + +``` yaml +openapi-type: arm +tag: package-2018-02 +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json +``` + +--- +# Code Generation From 726e43f14da436c9735eca137b175e7719da35d1 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Mon, 16 Jul 2018 09:24:38 -0700 Subject: [PATCH 04/31] Bump containerregistry management Node.js package version (#3419) --- .../containerregistry/resource-manager/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/containerregistry/resource-manager/readme.nodejs.md b/specification/containerregistry/resource-manager/readme.nodejs.md index af4a6955d549..4b2007b25076 100644 --- a/specification/containerregistry/resource-manager/readme.nodejs.md +++ b/specification/containerregistry/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= Date: Mon, 16 Jul 2018 10:59:23 -0700 Subject: [PATCH 05/31] Azure Service Fabric Mesh Preview 2018-07-01 REST API specification (#3389) * Azure Service Fabric Mesh Preview 2018-07-01 REST API specification * fix the suppression typing error * updating the go SDK tag and output location based on the review feedback --- .../examples/ApplicationCreateOrUpdate.json | 83 + .../examples/ApplicationDelete.json | 16 + .../examples/ApplicationGet.json | 28 + .../examples/ApplicationsByResourceGroup.json | 47 + .../ApplicationsBySubscriptionId.json | 175 ++ .../examples/ContainerLogsList.json | 18 + .../examples/NetworkCreateOrUpdate.json | 76 + .../examples/NetworkDelete.json | 14 + .../examples/NetworkGet.json | 35 + .../examples/NetworksByResourceGroup.json | 61 + .../examples/NetworksBySubscriptionId.json | 60 + .../examples/ReplicaGet.json | 109 + .../examples/ReplicasGetAll.json | 207 ++ .../examples/ServiceGet.json | 57 + .../examples/ServiceList.json | 62 + .../examples/VolumeCreate.json | 58 + .../examples/VolumeDelete.json | 14 + .../examples/VolumeGet.json | 28 + .../examples/VolumesByResourceGroup.json | 47 + .../examples/VolumesBySubscriptionId.json | 46 + .../2018-07-01-preview/servicefabricmesh.json | 2242 +++++++++++++++++ .../resource-manager/readme.md | 164 ++ .../resource-manager/readme.nodejs.md | 15 + .../resource-manager/readme.ruby.md | 28 + 24 files changed, 3690 insertions(+) create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json create mode 100644 specification/servicefabricmesh/resource-manager/readme.md create mode 100644 specification/servicefabricmesh/resource-manager/readme.nodejs.md create mode 100644 specification/servicefabricmesh/resource-manager/readme.ruby.md diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json new file mode 100644 index 000000000000..ce3e4db488e7 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json @@ -0,0 +1,83 @@ +{ + "operationId":"Application_Create", + "description":"This example shows how to create or update an application resource.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "applicationResourceDescription": { + "properties": { + "description": "SeaBreeze HelloWorld Application!", + "services": [ + { + "properties": { + "osType": "linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1 + }, + "name": "helloWorldService" + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", + "name": "myHelloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + }, + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", + "name": "myHelloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json new file mode 100644 index 000000000000..aa925879e076 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json @@ -0,0 +1,16 @@ +{ + "operationId":"Application_Delete", + "description":"This example shows how to delete an existing application resource. If the application resource exists and is deleted successfully, an empty response with 200 status code is returned. If the application resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "applicationName": "helloWorldAppWindows" + }, + "responses": { + "200": {}, + "204": {} + } + } + + diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json new file mode 100644 index 000000000000..fa3243b21b41 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "demo1" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json new file mode 100644 index 000000000000..2d4e507408ef --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", + "name": "helloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json new file mode 100644 index 000000000000..c86d60e3f22b --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappl", + "name": "myappl", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "healthState": "Ok", + "serviceNames": [ + "myservice" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappw", + "name": "myappw", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "healthState": "Ok", + "serviceNames": [ + "myservice" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp2/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp3/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", + "name": "helloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar1ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar4ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharRG/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json new file mode 100644 index 000000000000..4b7cc891243a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "sbzDocApp", + "serviceName": "sbzDocService", + "replicaName": "0", + "codePackageName": "sbzDocCode" + }, + "responses": { + "200": { + "body": { + "content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n" + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json new file mode 100644 index 000000000000..59aa09568838 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "operationId": "Network_Create", + "description": "This example shows how to create a network resource with custom address range and a load balanced public endpoint.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "networkName": "helloWorldNetworkWindows", + "networkResourceDescription": { + "properties": { + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "layer4": [ + { + "publicPort": "80", + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json new file mode 100644 index 000000000000..0eee1b214f41 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json @@ -0,0 +1,14 @@ +{ + "operationId":"Network_Delete", + "description":"This example shows how to delete an existing network resource. If the network resource exists and is deleted successfully, an empty response with 200 status code is returned. If the network resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "networkName": "helloWorldNetworkWindows" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json new file mode 100644 index 000000000000..6ae8caf1e8d1 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "networkName": "helloWorldNetworkWindows" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json new file mode 100644 index 000000000000..32d19f8454b5 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", + "name": "helloWorldNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.12.219", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json new file mode 100644 index 000000000000..6527fdc04c6a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", + "name": "helloWorldNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.12.219", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json new file mode 100644 index 000000000000..beb530b0fcf3 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "replicaName": "1" + }, + "responses": { + "200": { + "body": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "1" + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json new file mode 100644 index 000000000000..c7549c862176 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "1" + }, + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "0" + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json new file mode 100644 index 000000000000..d5bfe5632f4b --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 2, + "healthState": "Ok", + "status": "Unknown" + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json new file mode 100644 index 000000000000..cc2e90cc9e59 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json @@ -0,0 +1,62 @@ +{ + "operationId":"Service_ListByApplicationName", + "description":"This example shows how to list all services of a given application.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1, + "healthState": "Ok", + "status": "Unknown" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json new file mode 100644 index 000000000000..2d3c36f4c007 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "volumeName": "sbzDemoVolume", + "volumeResourceDescription": { + "properties": { + "description": "File share backed by Azure Files storage.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + }, + "provider": "SFAzureFile" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json new file mode 100644 index 000000000000..02145e25ee18 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json @@ -0,0 +1,14 @@ +{ + "operationId":"Volume_Delete", + "description":"This example shows how to delete an existing volume resource. If the volume resource exists and is deleted successfully, an empty response with 200 status code is returned. If the volume resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "volumeName": "sbzDemoVolume" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json new file mode 100644 index 000000000000..4a8cc7e3d626 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "volumeName": "sbzDemoVolume" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json new file mode 100644 index 000000000000..6c68786b1a06 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume2", + "name": "sbzDemoShare", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json new file mode 100644 index 000000000000..2afae5f97d1a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharel", + "name": "mysharel", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharew", + "name": "mysharew", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharew", + "accountName": "sbzdemoaccount" + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json new file mode 100644 index 000000000000..a394a917c84e --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json @@ -0,0 +1,2242 @@ +{ + "swagger": "2.0", + "info": { + "title": "SeaBreezeManagementClient", + "description": "APIs to deploy and manage resources to SeaBreeze.", + "version": "2018-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}": { + "put": { + "operationId": "Application_Create", + "x-ms-examples": { + "ApplicationCreateOrUpdate": { + "$ref": "./examples/ApplicationCreateOrUpdate.json" + } + }, + "summary": "Creates or updates an application resource.", + "description": "Creates an application resource with the specified name and description. If an application with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to provide public connectivity to the services of an application.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Application_Get", + "x-ms-examples": { + "ApplicationGet": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "summary": "Gets the application resource.", + "description": "Gets the information about the application resource with a given name. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Application_Delete", + "x-ms-examples": { + "ApplicationDelete": { + "$ref": "./examples/ApplicationDelete.json" + } + }, + "summary": "Deletes the application resource.", + "description": "Deletes the application resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified application was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services": { + "get": { + "operationId": "Service_ListByApplicationName", + "x-ms-examples": { + "ServiceGetAll": { + "$ref": "./examples/ServiceList.json" + } + }, + "summary": "Gets services of a given application.", + "description": "Gets the information about all services of a given service of an application. The information includes the runtime properties of the service instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}": { + "get": { + "operationId": "Service_Get", + "x-ms-examples": { + "ServiceGet": { + "$ref": "./examples/ServiceGet.json" + } + }, + "summary": "Gets the properties of the service.", + "description": "The operation returns the properties of the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas": { + "get": { + "operationId": "Replica_ListByServiceName", + "x-ms-examples": { + "ReplicasGetAll": { + "$ref": "./examples/ReplicasGetAll.json" + } + }, + "summary": "Gets replicas of a given service.", + "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + } + ], + "tags": [ + "Replicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}": { + "get": { + "operationId": "Replica_Get", + "x-ms-examples": { + "ReplicaGet": { + "$ref": "./examples/ReplicaGet.json" + } + }, + "summary": "Gets a specific replica of a given service.", + "description": "Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "Replicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListByResourceGroup", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationsByResourceGroup.json" + } + }, + "summary": "Gets all the application resources in a given resource group.", + "description": "Gets the information about all application resources in a given resource group. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListBySubscription", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationsBySubscriptionId.json" + } + }, + "summary": "Gets all the application resources in a given subscription.", + "description": "Gets the information about all application resources in a given subscription. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { + "get": { + "operationId": "CodePackage_GetContainerLog", + "x-ms-examples": { + "ContainerLogsList": { + "$ref": "./examples/ContainerLogsList.json" + } + }, + "summary": "Gets the logs for the container.", + "description": "Get the logs for the container of a given code package of an application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + } + ], + "tags": [ + "ContainerLogs" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabricMesh/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available operations.", + "description": "Lists all the available operations provided by Service Fabric SeaBreeze resource provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkName}": { + "put": { + "operationId": "Network_Create", + "x-ms-examples": { + "Network_Create": { + "$ref": "./examples/NetworkCreateOrUpdate.json" + } + }, + "summary": "Creates or updates a network resource.", + "description": "Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to create private network and configure public connectivity for services within your application. \n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Network_Get", + "x-ms-examples": { + "NetworkGet": { + "$ref": "./examples/NetworkGet.json" + } + }, + "summary": "Gets the network resource.", + "description": "Gets the information about the network resource with a given name. This information includes the network description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Network_Delete", + "x-ms-examples": { + "NetworkDelete": { + "$ref": "./examples/NetworkDelete.json" + } + }, + "summary": "Deletes the network resource.", + "description": "Deletes the network resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified network was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListByResourceGroup", + "x-ms-examples": { + "NetworksList": { + "$ref": "./examples/NetworksByResourceGroup.json" + } + }, + "summary": "Gets all the network resources in a given resource group.", + "description": "Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListBySubscription", + "x-ms-examples": { + "NetworksList": { + "$ref": "./examples/NetworksBySubscriptionId.json" + } + }, + "summary": "Gets all the network resources in a given subscription.", + "description": "Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}": { + "put": { + "operationId": "Volume_Create", + "x-ms-examples": { + "VolumeCreate": { + "$ref": "./examples/VolumeCreate.json" + } + }, + "summary": "Creates or updates a volume resource.", + "description": "Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Volume_Get", + "x-ms-examples": { + "VolumeGet": { + "$ref": "./examples/VolumeGet.json" + } + }, + "summary": "Gets the volume resource.", + "description": "Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Volume_Delete", + "x-ms-examples": { + "VolumeDelete": { + "$ref": "./examples/VolumeDelete.json" + } + }, + "summary": "Deletes the volume resource.", + "description": "Deletes the volume identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified volume was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListByResourceGroup", + "x-ms-examples": { + "VolumesList": { + "$ref": "./examples/VolumesByResourceGroup.json" + } + }, + "summary": "Gets all the volume resources in a given resource group.", + "description": "Gets the information about all volume resources in a given resource group. The information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListBySubscription", + "x-ms-examples": { + "VolumesList": { + "$ref": "./examples/VolumesBySubscriptionId.json" + } + }, + "summary": "Gets all the volume resources in a given subscription.", + "description": "Gets the information about all volume resources in a given subscription. The information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "The resource model definition for Azure Resource Manager resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ManagedProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for Azure Resource Manager tracked top-level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ] + }, + "ProvisionedResourceProperties": { + "description": "Describes common properties of a provisioned resource.", + "properties": { + "provisioningState": { + "type": "string", + "description": "State of the resource.", + "readOnly": true + } + } + }, + "NetworkResourceDescriptionList": { + "description": "A pageable list of network resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "NetworkResourceDescription": { + "description": "This type describes a network resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkResourceProperties", + "description": "Describes properties of a network resource." + } + }, + "required": [ + "properties" + ] + }, + "NetworkResourceProperties": { + "description": "Describes properties of a network resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/NetworkProperties" + } + ] + }, + "NetworkProperties": { + "description": "Describes a network.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the network.", + "type": "string" + }, + "addressPrefix": { + "description": "the address prefix for this network.", + "type": "string" + }, + "ingressConfig": { + "$ref": "#/definitions/IngressConfig", + "description": "Configuration for public connectivity for this network." + } + }, + "required": [ + "addressPrefix" + ] + }, + "VolumeResourceDescriptionList": { + "description": "A pageable list of volume resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VolumeResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "VolumeResourceDescription": { + "description": "This type describes a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeResourceProperties", + "description": "Describes properties of a volume resource." + } + }, + "required": [ + "properties" + ] + }, + "VolumeResourceProperties": { + "description": "Describes properties of a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/VolumeProperties" + } + ] + }, + "VolumeProperties": { + "description": "This type describes properties of a volume resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the volume.", + "type": "string" + }, + "provider": { + "description": "Provider of the volume.", + "type": "string", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true + } + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "type": "object", + "properties": { + "accountName": { + "description": "Name of the Azure storage account for the File Share.", + "type": "string" + }, + "accountKey": { + "description": "Access key of the Azure storage account for the File Share.", + "type": "string" + }, + "shareName": { + "description": "Name of the Azure Files file share that provides storage for the volume.", + "type": "string" + } + }, + "required": [ + "accountName", + "shareName" + ] + }, + "ApplicationResourceDescriptionList": { + "description": "A pageable list of application resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ApplicationResourceDescription": { + "description": "This type describes an application resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties", + "description": "This type describes properties of an application resource." + } + }, + "required": [ + "properties" + ] + }, + "ApplicationResourceProperties": { + "description": "This type describes properties of an application resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ApplicationProperties" + } + ] + }, + "ApplicationProperties": { + "description": "This type describes properties of an application resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the application.", + "type": "string" + }, + "debugParams": { + "description": "Internal use.", + "type": "string" + }, + "services": { + "type": "array", + "description": "describes the services in the application.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the application resource.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationResourceStatus", + "modelAsString": true + } + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application deployment." + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + } + } + }, + "ServiceList": { + "description": "A pageable list of all services in an application.\n", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceResourceDescription": { + "description": "This type describes a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "properties" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "description": { + "description": "User readable description of the service.", + "type": "string" + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "healthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a resource such as Application, Service, or Network." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Represents the status of the service.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceResourceStatus", + "modelAsString": true + } + } + } + } + ] + }, + "ContainerInstanceView": { + "description": "Runtime information of a container instance.", + "type": "object", + "properties": { + "restartCount": { + "type": "integer", + "description": "The number of times the container has been restarted." + }, + "currentState": { + "$ref": "#/definitions/ContainerState", + "description": "Current container instance state." + }, + "previousState": { + "$ref": "#/definitions/ContainerState", + "description": "Previous container instance state." + }, + "events": { + "description": "The events of this container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerEvent" + } + } + } + }, + "ContainerEvent": { + "description": "A container event.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the container event." + }, + "count": { + "type": "integer", + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "description": "Date/time of the first event." + }, + "lastTimestamp": { + "type": "string", + "description": "Date/time of the last event." + }, + "message": { + "type": "string", + "description": "The event message" + }, + "type": { + "type": "string", + "description": "The event type." + } + } + }, + "ContainerLabel": { + "description": "Describes a container label.", + "type": "object", + "properties": { + "name": { + "description": "The name of the container label.", + "type": "string" + }, + "value": { + "description": "The value of the container label.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "ContainerLogs": { + "description": "The logs of the container.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "content of the log." + } + } + }, + "ContainerState": { + "description": "The container state.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of this container" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state started." + }, + "exitCode": { + "type": "string", + "description": "The container exit code." + }, + "finishTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state finished." + }, + "detailStatus": { + "description": "Human-readable status of this state.", + "type": "string" + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ] + }, + "ResourceLimits": { + "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "CPU limits in cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + } + }, + "ResourceRequests": { + "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.\n", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory request in GB for this container.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "Requested number of CPU cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + }, + "required": [ + "memoryInGB", + "cpu" + ] + }, + "ResourceRequirements": { + "description": "This type describes the resource requirements for a container or a service.", + "type": "object", + "properties": { + "requests": { + "$ref": "#/definitions/ResourceRequests", + "description": "Describes the requested resources for a given container." + }, + "limits": { + "$ref": "#/definitions/ResourceLimits", + "description": "Describes the maximum limits on the resources for a given container." + } + }, + "required": [ + "requests" + ] + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of operations available at the listed Azure resource provider." + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "Name of the operation provider." + }, + "resource": { + "type": "string", + "description": "Name of the resource on which the operation is available." + }, + "operation": { + "type": "string", + "description": "Name of the available operation." + }, + "description": { + "type": "string", + "description": "Description of the available operation." + } + }, + "description": "An operation available at the listed Azure resource provider." + }, + "ErrorModel": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the code package.", + "type": "string" + }, + "image": { + "description": "The Container image to use.", + "type": "string" + }, + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Image registry credential." + }, + "entrypoint": { + "description": "Override for the default entry point in the container.", + "type": "string" + }, + "commands": { + "description": "Command array to execute within the container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in this container", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "settings": { + "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "labels": { + "description": "The labels to set in this container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + "endpoints": { + "description": "The endpoints exposed by this container.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "resources": { + "$ref": "#/definitions/ResourceRequirements", + "description": "This type describes the resource requirements for a container or a service." + }, + "volumeRefs": { + "description": "The volumes to be attached to the container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerVolume" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerVolume": { + "description": "Describes how a volume is attached to a container.", + "type": "object", + "properties": { + "name": { + "description": "Name of the volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume is read only. Default is 'false'.", + "type": "boolean" + }, + "destinationPath": { + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed.", + "type": "string" + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the endpoint.", + "type": "string" + }, + "port": { + "description": "Port used by the container.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "ServiceReplicaList": { + "description": "A pageable list of replicas of a service resource.\n", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceReplicaDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceReplicaDescription": { + "type": "object", + "description": "This type describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + } + } + ] + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "type": "object", + "properties": { + "osType": { + "type": "string", + "description": "The Operating system type required by the code in service.\n", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "codePackages": { + "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).\n", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + "networkRefs": { + "type": "array", + "description": "The names of the private networks that this service needs to be part of.", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "osType", + "codePackages" + ] + }, + "IngressConfig": { + "description": "Describes public connectivity configuration for the network.", + "type": "object", + "properties": { + "qosLevel": { + "type": "string", + "description": "The QoS tier for ingress.", + "enum": [ + "Bronze" + ], + "x-ms-enum": { + "name": "IngressQoSLevel", + "modelAsString": true + } + }, + "layer4": { + "description": "Configuration for layer4 public connectivity for this network.", + "type": "array", + "items": { + "$ref": "#/definitions/Layer4IngressConfig" + } + }, + "publicIPAddress": { + "type": "string", + "readOnly": true, + "description": "The public IP address for reaching this network." + } + } + }, + "Layer4IngressConfig": { + "description": "Describes the layer4 configuration for public connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Layer4 ingress config name." + }, + "publicPort": { + "type": "integer", + "description": "Specifies the public port at which the service endpoint below needs to be exposed." + }, + "applicationName": { + "type": "string", + "description": "The application name which contains the service to be exposed." + }, + "serviceName": { + "type": "string", + "description": "The service whose endpoint needs to be exposed at the public port." + }, + "endpointName": { + "type": "string", + "description": "The service endpoint that needs to be exposed." + } + } + }, + "EnvironmentVariable": { + "description": "Describes an environment variable for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the environment variable.", + "type": "string" + }, + "value": { + "description": "The value of the environment variable.", + "type": "string" + } + } + }, + "Setting": { + "description": "Describes a setting for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the network." + } + } + }, + "HealthState": { + "type": "string", + "description": "The health state of a resource such as Application, Service, or Network.", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ok", + "description": "Indicates the health state is okay. The value is 1." + }, + { + "value": "Warning", + "description": "Indicates the health state is at a warning level. The value is 2." + }, + { + "value": "Error", + "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." + }, + { + "value": "Unknown", + "description": "Indicates an unknown health status. The value is 65535." + } + ] + } + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "type": "object", + "properties": { + "sinks": { + "description": "List of supported sinks that can be referenced.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "defaultSinkRefs": { + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", + "type": "string" + } + } + }, + "DiagnosticsRef": { + "description": "Reference to sinks in DiagnosticsDescription.", + "type": "object", + "properties": { + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "sinkRefs": { + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsSinkProperties": { + "description": "Properties of a DiagnosticsSink.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/DiagnosticsSinkKind", + "description": "The kind of DiagnosticsSink." + }, + "name": { + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", + "type": "string" + }, + "description": { + "description": "A description of the sink.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "DiagnosticsSinkKind": { + "type": "string", + "description": "The kind of DiagnosticsSink.", + "enum": [ + "Invalid", + "AzureInternalMonitoringPipeline" + ], + "x-ms-enum": { + "name": "DiagnosticsSinkKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva." + } + ] + } + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + ], + "x-ms-discriminator-value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva.", + "properties": { + "accountName": { + "description": "Azure Internal monitoring pipeline account.", + "type": "string" + }, + "namespace": { + "description": "Azure Internal monitoring pipeline account namespace.", + "type": "string" + }, + "maConfigUrl": { + "description": "Azure Internal monitoring agent configuration.", + "type": "string" + }, + "fluentdConfigUrl": { + "description": "Azure Internal monitoring agent fluentd configuration." + }, + "autoKeyConfigUrl": { + "description": "Azure Internal monitoring pipeline autokey associated with the certificate.", + "type": "string" + } + } + } + }, + "parameters": { + "api-versionRequiredQueryParam": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-07-01-preview" + ], + "default": "2018-07-01-preview", + "description": "The version of the API. This parameter is required and its value must be `2018-07-01-preview`.", + "required": true, + "x-ms-enum": { + "name": "2018-07-01-preview", + "modelAsString": true, + "values": [ + { + "value": "2018-07-01-preview", + "description": "The `2018-07-01-preview` version of the API." + } + ] + } + }, + "subscriptionIdRequiredPathParam": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier", + "required": true, + "type": "string" + }, + "ResourceGroupNameRequiredPathParam": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure resource group name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApplicationNameRequiredPathParam": { + "name": "applicationName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating an application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ServiceNameRequiredPathParam": { + "name": "serviceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service." + }, + "ReplicaNameRequiredPathParam": { + "name": "replicaName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service replica." + }, + "NetworkNameRequiredPathParam": { + "name": "networkName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the network." + }, + "NetworkResourceDescriptionRequiredBodyParam": { + "name": "networkResourceDescription", + "in": "body", + "description": "Description for creating a network resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "VolumeNameRequiredPathParam": { + "name": "volumeName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the volume." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "CodePackageNameRequiredPathParam": { + "name": "codePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the code package." + }, + "TailOptionalQueryParam": { + "name": "tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100." + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/readme.md b/specification/servicefabricmesh/resource-manager/readme.md new file mode 100644 index 000000000000..a789db75ef22 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/readme.md @@ -0,0 +1,164 @@ +# Service Fabric Mesh REST APIs + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Service Fabric Mesh. + +Azure Service Fabric Mesh is fully managed service where developers can build and deploy mission critical applications without managing any infrastructure such as VMs, storage, or networking. Mesh is a serverless environment for applications built from microservices. + +[Azure Service Fabric](http://aka.ms/ServiceFabric) is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices. + + +--- +## Getting Started +To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. + +``` yaml +title: ServiceFabricMeshManagementClient +description: Service Fabric Mesh Management Client +openapi-type: arm +tag: package-2018-07-01-preview + +directive: + - suppress: RequiredPropertiesMissingInResourceModel + reason: Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required by RP to manage those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed. The inlined objects should be part of the application properties and not a seperate proxy resource. + - suppress: EnumInsteadOfBoolean + reason: The `readOnly` boolean schema is part of Azure Resource Manager common schema. + - suppress: TrackedResourcePatchOperation + reason: The patch operation is not implemented in the preview APIs. +``` +### Tag: package-2018-07-01-preview + +These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2018-07-01-preview' +input-file: +- Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json +``` +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric_mesh'] +``` + + +## C# +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ServiceFabricMesh + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabricMesh/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.servicefabricmesh + package-name: azure-mgmt-servicefabricmesh +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh/azure/mgmt/servicefabricmesh +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh +``` +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: servicefabricmesh + clear-output-folder: true +``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-07-01-preview +``` + +### Tag: package-2018-07-01-preview and go + +These settings apply only when `--tag=package-2018-07-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-07-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/servicefabricmesh/mgmt/2018-07-01-preview/servicefabricmesh +``` +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicefabricmesh +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabricmesh +``` +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-07-01-preview +``` +### Tag: package-2018-07-01-preview and java + +These settings apply only when `--tag=2018-07-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == '2018-07-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabricmesh.v2018_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_07_01_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/servicefabricmesh/resource-manager/readme.nodejs.md b/specification/servicefabricmesh/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..a49f88016ae7 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-servicefabricmesh + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/serviceFabricMeshManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/servicefabricmesh/resource-manager/readme.ruby.md b/specification/servicefabricmesh/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..b0a04419da90 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/readme.ruby.md @@ -0,0 +1,28 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml $(ruby) +ruby: + package-name: azure_mgmt_service_fabric_mesh + package-version: "0.1.0" + azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-07-01-preview +``` + +### Tag: package-2018-07-01-preview and ruby + +These settings apply only when `--tag=package-2018-07-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-07-01-preview' && $(ruby) +namespace: "Azure::ServiceFabricMesh::Mgmt::V2018_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_fabric_mesh/lib +``` + From cc19f5d01e6f8524a90d313bd41f77ba15aca7c8 Mon Sep 17 00:00:00 2001 From: Raj Shah Date: Mon, 16 Jul 2018 12:02:49 -0700 Subject: [PATCH 06/31] Updating 2018-03-01-preview to include a few extra fields and parameters (#3370) * Update get entities to include two fields * Fix a typo --- .../examples/GetEntities.json | 9 +++++--- .../2018-03-01-preview/management.json | 21 ++++++++++++++++++- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json index 91a26cba5065..d233d7d30ea0 100644 --- a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json @@ -21,7 +21,9 @@ "inheritedPermissions": "view", "parentDisplayNameChain": ["Tenant Root Group", "Group 1 Tenant 2 Parent"], "parentNameChain": ["TenantRootGroup", "Group1Tenant2Parent"], - "numberOfDescendants": 2 + "numberOfDescendants": 3, + "numberOfChildren": 2, + "numberOfChildGroups": 1 } }, { @@ -38,8 +40,9 @@ "inheritedPermissions": "delete", "parentDisplayNameChain": ["Tenant Root Group", "Group 4 Tenant 2 Parent"], "parentNameChain": ["TenantRootGroup", "Group4 Tenant2Parent"], - "numberOfDescendants": 0 - } + "numberOfDescendants": 0, + "numberOfChildren": 0, + "numberOfChildGroups": 0 } } ], "nextLink": null diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json index 691c4f2d8eaf..f517d090124c 100644 --- a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json @@ -955,6 +955,11 @@ "$ref": "#/definitions/EntityInfo" } }, + "count": { + "description": "Total count of records that match the filter", + "type": "integer", + "readOnly": true + }, "nextLink": { "description": "The URL to use for getting the next set of results.", "type": "string", @@ -1024,6 +1029,18 @@ "type": "integer", "x-nullable": true }, + "numberOfChildren": { + "title": "Number of Children", + "description": "Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.", + "type": "integer", + "x-nullable": true + }, + "numberOfChildGroups": { + "title": "Number of Child Groups", + "description": "Number of child groups is the number of Groups that are exactly one level underneath the current Group.", + "type": "integer", + "x-nullable": true + }, "parentDisplayNameChain": { "type": "array", "description": "The parent display name chain from the root group to the immediate parent", @@ -1407,7 +1424,9 @@ "enum": [ "AllowedParents", "AllowedChildren", - "ParentAndFirstLevelChildren" + "ParentAndFirstLevelChildren", + "ParentOnly", + "ChildrenOnly" ], "x-ms-parameter-location": "method", "description": "The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants." From a14dcbbce1c05eaddbfb4b19b2f39d6d2d34f0b6 Mon Sep 17 00:00:00 2001 From: Yang Yuan Date: Mon, 16 Jul 2018 12:30:32 -0700 Subject: [PATCH 07/31] Keep Bing swagger and SDKs sync. (#3412) --- .../data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json | 2 +- .../CustomImageSearch/stable/v1.0/CustomImageSearch.json | 2 +- .../data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json | 2 +- .../data-plane/EntitySearch/stable/v1.0/EntitySearch.json | 2 +- .../data-plane/ImageSearch/stable/v1.0/ImageSearch.json | 2 +- .../data-plane/NewsSearch/stable/v1.0/NewsSearch.json | 2 +- .../data-plane/VideoSearch/stable/v1.0/VideoSearch.json | 2 +- .../data-plane/VisualSearch/preview/v1.0/VisualSearch.json | 2 +- .../data-plane/WebSearch/stable/v1.0/WebSearch.json | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json index 2d20339623ed..4bb38df98c1d 100644 --- a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json +++ b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "AutoSuggest Search Client", + "title": "AutoSuggest Search API", "description": "The AutoSuggest Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference).", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json index 2cc7731629bc..4236a1154c6e 100644 --- a/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Custom Image Search Client", + "title": "Custom Image Search API", "description": "The Bing Custom Image Search API lets you send an image search query to Bing and get back image search results customized to meet your custom search definition.", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json b/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json index 8a11883e6ddb..fc9316f94580 100644 --- a/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Custom Search Client", + "title": "Custom Search API", "description": "The Bing Custom Search API lets you send a search query to Bing and get back search results customized to meet your custom search definition.", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json b/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json index 0f2869e9d2b0..be6a506037b4 100644 --- a/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json +++ b/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Entity Search Client", + "title": "Entity Search API", "description": "The Entity Search API lets you send a search query to Bing and get back search results that include entities and places. Place results include restaurants, hotel, or other local businesses. For places, the query can specify the name of the local business or it can ask for a list (for example, restaurants near me). Entity results include persons, places, or things. Place in this context is tourist attractions, states, countries, etc.", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json index 6b7194b872db..2a6773c47853 100644 --- a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json +++ b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Image Search Client", + "title": "Image Search API", "description": "The Image Search API lets you send a search query to Bing and get back a list of relevant images. This section provides technical details about the query parameters and headers that you use to request images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json index 64ee6b4c023b..f05cfc1aba66 100644 --- a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json +++ b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "News Search Client", + "title": "News Search API", "description": "The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json b/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json index 0ec655ad69ed..3d87a12b7a91 100644 --- a/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json +++ b/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Video Search Client", + "title": "Video Search API", "description": "The Video Search API lets you search on Bing for video that are relevant to the user's search query, for insights about a video or for videos that are trending based on search requests made by others. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json index e0b9dba22cce..84c6a3a713a8 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Visual Search Client", + "title": "Visual Search API", "description": "Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see [Visual Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).", "version": "1.0" }, diff --git a/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json b/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json index a12a0e486def..98ee8cecc62c 100644 --- a/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json +++ b/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Web Search Client", + "title": "Web Search API", "description": "The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.", "version": "1.0" }, From 0a45a302dd727d4876c2ffd82607ae7d2704e3f3 Mon Sep 17 00:00:00 2001 From: Sarangan Rajamanickam Date: Mon, 16 Jul 2018 12:31:22 -0700 Subject: [PATCH 08/31] Suppress Operations API Implemenetation Error (#3139) * Suppress Operations API Implemenetation Error * Suppress RequiredPropertiesMissingInResourceModel linter error --- .../trafficmanager/resource-manager/readme.md | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/specification/trafficmanager/resource-manager/readme.md b/specification/trafficmanager/resource-manager/readme.md index 5264b78fed68..70071e96b8dc 100644 --- a/specification/trafficmanager/resource-manager/readme.md +++ b/specification/trafficmanager/resource-manager/readme.md @@ -34,9 +34,23 @@ directive: - suppress: OperationsAPIImplementation reason: We do have a operations api as "/providers/Microsoft.Network/operations" from: trafficmanager.json - where: - - $.paths["/providers/Microsoft.Network/operations"] - + where: $.paths + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.HeatMapModel + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.TrafficManagerGeographicHierarchy + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.Profile + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.Endpoint ``` ### Tag: package-2018-04 From d068d86fa5927cac0952c27ca0d5a000d6e4f037 Mon Sep 17 00:00:00 2001 From: Sergey Shandar Date: Mon, 16 Jul 2018 20:12:16 -0700 Subject: [PATCH 09/31] Fix OAV error log (#3421) * Fix OAV error log * remove test/model.js --- .travis.yml | 2 +- package.json | 2 +- scripts/modelValidation.js | 20 ++++++++++++++++++++ test/model.js | 29 ----------------------------- 4 files changed, 22 insertions(+), 31 deletions(-) create mode 100644 scripts/modelValidation.js delete mode 100644 test/model.js diff --git a/.travis.yml b/.travis.yml index b915eb0a16c1..4af13ebd635f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -87,7 +87,7 @@ script: fi - >- if [[ $MODE == 'model' ]]; then - npm test -- test/model.js + node scripts/modelValidation.js fi - >- if [[ $MODE == 'BreakingChange' ]]; then diff --git a/package.json b/package.json index 5ccf00b8cf1c..00d83d53243a 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "json-schema-ref-parser": "^3.1.2", "mocha": "*", "oad": "^0.1.11", - "oav": "^0.4.44", + "oav": "^0.4.57", "request": "^2.61.0", "request-promise-native": "^1.0.5", "z-schema": "^3.16.1" diff --git a/scripts/modelValidation.js b/scripts/modelValidation.js new file mode 100644 index 000000000000..7cc0dc62611d --- /dev/null +++ b/scripts/modelValidation.js @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License in the project root for license information. +'use strict'; + +const utils = require('../test/util/utils') +const oav = require('oav'); + +async function main() { + const swaggersToProcess = utils.getFilesChangedInPR(); + // Useful when debugging a test for a particular swagger. + // Just update the regex. That will return an array of filtered items. + // swaggersToProcess = swaggersToProcess.filter(function(item) { + // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); + // }); + for (const swagger of swaggersToProcess) { + await oav.validateExamples(swagger, null, {consoleLogLevel: 'error', pretty: true}); + } +} + +main() \ No newline at end of file diff --git a/test/model.js b/test/model.js deleted file mode 100644 index 4648425cb72d..000000000000 --- a/test/model.js +++ /dev/null @@ -1,29 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. - -'use strict'; -var assert = require('assert'), - utils = require('./util/utils'), - oav = require('oav'); - -describe('Azure swagger model validation using x-ms-examples and examples in spec', function () { - let swaggersToProcess = utils.getFilesChangedInPR(); - // Useful when debugging a test for a particular swagger. - // Just update the regex. That will return an array of filtered items. - // swaggersToProcess = swaggersToProcess.filter(function(item) { - // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); - // }); - for (const swagger of swaggersToProcess) { - it(swagger + ' should have valid examples.', async function () { - try { - const validationResult = await oav.validateExamples(swagger, null, {consoleLogLevel: 'error'}); - return assert( - validationResult.validityStatus === true, - `swagger "${swagger}" contains model validation errors.`); - } catch (err) { - console.dir(err, {depth: null, colors: true}); - throw err; - } - }); - } -}); \ No newline at end of file From e61491cf3b458d1cdf2fcdb27f51747d93413848 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Tue, 17 Jul 2018 09:57:06 -0700 Subject: [PATCH 10/31] Bump hdinsight management Node.js package version to 0.4.0 (#3427) --- specification/hdinsight/resource-manager/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/hdinsight/resource-manager/readme.nodejs.md b/specification/hdinsight/resource-manager/readme.nodejs.md index 9aad401963b8..c43b29bef27b 100644 --- a/specification/hdinsight/resource-manager/readme.nodejs.md +++ b/specification/hdinsight/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= Date: Tue, 17 Jul 2018 11:03:23 -0600 Subject: [PATCH 11/31] [AKS] suppress two autorest ARM linter errors (#3388) --- .../containerservices/resource-manager/readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservices/resource-manager/readme.md index 1fcd7ef0037e..0a85d3b35182 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservices/resource-manager/readme.md @@ -296,3 +296,15 @@ java: regenerate-manager: true generate-interface: true ``` + +## Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: managedClusters.json + reason: Name chamge of "enableRBAC" property would break compatibility + - suppress: TrackedResourcePatchOperation + from: containerService.json + reason: ACS service is deprecated so a PATCH endpoint won't be implemented +``` From b36d263ad426869bd10e981e944cb33f33f0868e Mon Sep 17 00:00:00 2001 From: mozehgir <32183061+mozehgir@users.noreply.github.com> Date: Tue, 17 Jul 2018 13:54:13 -0700 Subject: [PATCH 12/31] Update ReadMe.md by linking the announcements section (#3428) * Update ReadMe.md by linking the announcements section * Update README.md * Update README.md --- README.md | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 39463e726b81..bee32b5b9506 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,10 @@ This repository is the canonical source for REST API specifications for Microsoft Azure. -## News - -While you're away for the holiday season, we're going to be making a few improvements to the Azure REST API Specs repository: - - - We will stop merging PRs until the new year starting on **6:00 p.m. December 20th, 2017**. - - Starting on **December 21st, 2017**, we will be restoring `master` as the default branch for this repository. - - All open PRs will automatically be updated to target `master` instead of `current`. - - We will stop accepting contributions to the `current` branch. - - On **December 21st, 2017**, we will merge a refactoring of this repository where we introduce `preview` and `stable` directories to differentiate Swaggers and services that are ready for General Availability and those that are not yet. - - Beginning **December 21st, 2017**, the `master` branch in the private repository will become a read-only copy of the `master` branch in the public repository. - -For more information about this project, please see our wiki: -[December 2017 Refactoring](https://github.com/Azure/azure-rest-api-specs/wiki/December-2017-Refactoring) - ## Basics -If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. +If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. + +Please check the [announcements page](https://github.com/Azure/azure-rest-api-specs/wiki/Announcements) for any new updates since your last visit. ## Getting started - Our [Contribution guidelines](./.github/CONTRIBUTING.md) walks you through the process of contributing to this repository. From e2b430335f4ec961d785e2bf31c3d9260cd073d7 Mon Sep 17 00:00:00 2001 From: Samir Solanki Date: Tue, 17 Jul 2018 14:25:56 -0700 Subject: [PATCH 13/31] Add revision and Version Description to Contract (#3430) * add revision description * fixed missing file reference * add the missing file --- .../preview/2018-01-01/apimapis.json | 13 ++++++++ .../ApiManagementCreateApiRevision.json | 31 ++++++++++-------- .../examples/ApiManagementGetApiRevision.json | 32 +++++++++++++++++++ .../preview/2018-06-01-preview/apimapis.json | 13 ++++++++ .../ApiManagementCreateApiRevision.json | 31 ++++++++++-------- .../examples/ApiManagementGetApiRevision.json | 32 +++++++++++++++++++ 6 files changed, 124 insertions(+), 28 deletions(-) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json index fcc1ee028eca..c5074d3c172a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json @@ -160,6 +160,9 @@ "x-ms-examples": { "ApiManagementGetApiContract": { "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" } }, "produces": [ @@ -3900,6 +3903,16 @@ "description": "Indicates if API revision is accessible via the gateway.", "readOnly": true }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of the Api Revision.", + "maxLength": 256 + }, + "apiVersionDescription": { + "type": "string", + "description": "Description of the Api Version.", + "maxLength": 256 + }, "apiVersionSetId": { "type": "string", "description": "A resource identifier for the related ApiVersionSet." diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json index 92edb681e566..cb3e6d083c6a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json @@ -4,12 +4,12 @@ "resourceGroupName": "rg1", "api-version": "2018-01-01", "subscriptionId": "subid", - "apiId": "5a838fd48f33670ed070d77c;rev=4", + "apiId": "echo-api;rev=4", "parameters": { "properties": { - "displayName": "Swagger Petstore V2", + "displayName": "Echo API", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -18,21 +18,22 @@ "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": false + "isCurrent": false, + "apiRevisionDescription": "moved to swagger petstore backend" } } }, "responses": { "201": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a838fd48f33670ed070d77c;rev=4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", "type": "Microsoft.ApiManagement/service/apis", - "name": "5a838fd48f33670ed070d77c;rev=4", + "name": "echo-api;rev=4", "properties": { - "displayName": "Swagger Petstore 2", + "displayName": "Echo API", "apiRevision": "4", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -40,20 +41,21 @@ "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - } + }, + "apiRevisionDescription": "moved to swagger petstore backend" } } }, "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a838fd48f33670ed070d77c;rev=4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", "type": "Microsoft.ApiManagement/service/apis", - "name": "5a838fd48f33670ed070d77c;rev=4", + "name": "echo-api;rev=4", "properties": { - "displayName": "Swagger Petstore 2", + "displayName": "Echo API", "apiRevision": "4", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -61,7 +63,8 @@ "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - } + }, + "apiRevisionDescription": "moved to swagger petstore backend" } } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..81167d6c4767 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-01-01", + "subscriptionId": "subid", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json index 7eeaf15d1000..b641dc887fe5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json @@ -160,6 +160,9 @@ "x-ms-examples": { "ApiManagementGetApiContract": { "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" } }, "produces": [ @@ -3680,6 +3683,16 @@ "description": "Indicates if API revision is accessible via the gateway.", "readOnly": true }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of the Api Revision.", + "maxLength": 256 + }, + "apiVersionDescription": { + "type": "string", + "description": "Description of the Api Version.", + "maxLength": 256 + }, "apiVersionSetId": { "type": "string", "description": "A resource identifier for the related ApiVersionSet." diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json index b50bc8523acd..6dc22817f714 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json @@ -4,12 +4,12 @@ "resourceGroupName": "rg1", "api-version": "2018-06-01-preview", "subscriptionId": "subid", - "apiId": "5a838fd48f33670ed070d77c;rev=4", + "apiId": "echo-api;rev=4", "parameters": { "properties": { - "displayName": "Swagger Petstore V2", + "displayName": "Echo API", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -18,21 +18,22 @@ "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": false + "isCurrent": false, + "apiRevisionDescription": "moved to swagger petstore backend" } } }, "responses": { "201": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a838fd48f33670ed070d77c;rev=4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", "type": "Microsoft.ApiManagement/service/apis", - "name": "5a838fd48f33670ed070d77c;rev=4", + "name": "echo-api;rev=4", "properties": { - "displayName": "Swagger Petstore 2", + "displayName": "Echo API", "apiRevision": "4", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -40,20 +41,21 @@ "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - } + }, + "apiRevisionDescription": "moved to swagger petstore backend" } } }, "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a838fd48f33670ed070d77c;rev=4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", "type": "Microsoft.ApiManagement/service/apis", - "name": "5a838fd48f33670ed070d77c;rev=4", + "name": "echo-api;rev=4", "properties": { - "displayName": "Swagger Petstore 2", + "displayName": "Echo API", "apiRevision": "4", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -61,7 +63,8 @@ "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - } + }, + "apiRevisionDescription": "moved to swagger petstore backend" } } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..5a1ada142d29 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} \ No newline at end of file From 7499d0ec4ccffa2417f56f3dadd9c710ff30cd5a Mon Sep 17 00:00:00 2001 From: wawon-msft <32000704+wawon-msft@users.noreply.github.com> Date: Tue, 17 Jul 2018 15:55:51 -0700 Subject: [PATCH 14/31] Fixed operation ID for configuration operation (#3424) --- .../preview/2018-06-01-preview/configurations.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json index 179a28687e06..195561448e30 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json @@ -37,8 +37,8 @@ "tags": [ "Configurations" ], - "operationId": "Configurations_UpdateHTTPSettings", - "description": "Configures the HTTP settings on the specified cluster.", + "operationId": "Configurations_Update", + "description": "Configures the configuration on the specified cluster.", "x-ms-examples": { "Enable HTTP connectivity": { "$ref": "./examples/ChangeHttpConnectivityEnable.json" From a6e8ad77c8d3c8a34f7671e422ac1e7ebfcc08cb Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 12:35:04 -0700 Subject: [PATCH 15/31] Add Tumbling Window dependsOn property to Trigger.json for Tumbling Window Trigger and self-dependent Tumbling Window Trigger --- .../entityTypes/Trigger.json | 115 +++++++++++++++++- 1 file changed, 114 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 921b0da9c4da..63e97444bd01 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,7 +381,14 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - } + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } + } }, "required": [ "frequency", @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 79e00548ed163a432e88e9ae0241fdbb6ebd41ff Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 14:43:59 -0700 Subject: [PATCH 16/31] revert tumbling window dependsOn property under preview, and apply same changes to stable --- .../entityTypes/Trigger.json | 115 +----------------- .../2018-06-01/entityTypes/Trigger.json | 113 +++++++++++++++++ 2 files changed, 114 insertions(+), 114 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 63e97444bd01..921b0da9c4da 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,14 +381,7 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - }, - "dependsOn": { - "type": "array", - "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", - "items": { - "$ref": "#/definitions/DependencyReference" - } - } + } }, "required": [ "frequency", @@ -429,112 +422,6 @@ "maximum": 86400 } } - }, - "TriggerReference": { - "description": "Trigger reference type.", - "type": "object", - "properties": { - "type": { - "description": "Trigger reference type.", - "type": "string", - "enum": [ - "TriggerReference" - ] - }, - "referenceName": { - "description": "Reference trigger name.", - "type": "string" - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "DependencyReference": { - "description": "Referenced dependency.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "description": "The type of dependency reference.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "TriggerDependencyReference": { - "description": "Trigger referenced dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "referenceTrigger": { - "description": "Referenced trigger.", - "$ref": "#/definitions/TriggerReference" - } - }, - "required": [ - "referenceTrigger" - ] - }, - "TumblingWindowTriggerDependencyReference": { - "description": "Referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TriggerDependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - } - }, - "SelfDependencyTumblingWindowTriggerReference": { - "description": "Self referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - }, - "required": [ - "offset" - ] } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json index eed541ff50d3..737431fcffe8 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json @@ -381,6 +381,13 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } } }, "required": [ @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 40e3e9947c3573fa243925f98164898ba013f154 Mon Sep 17 00:00:00 2001 From: Varad Meru Date: Wed, 18 Jul 2018 06:41:19 -0700 Subject: [PATCH 17/31] Changing schema from string to file (#3420) --- .../Microsoft.Automation/stable/2015-10-31/runbook.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json index ba3d390cb569..247c2a567486 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json @@ -130,7 +130,8 @@ "in": "body", "required": true, "schema": { - "type": "string" + "type": "object", + "format": "file" }, "description": "The runbook draft content." }, From ccefbaf343f2c71f3314e93c149b48e9e76d2e90 Mon Sep 17 00:00:00 2001 From: sumitmal <32121310+sumitmal@users.noreply.github.com> Date: Wed, 18 Jul 2018 20:42:32 +0530 Subject: [PATCH 18/31] Added BackupValidateOperation API (#3395) * Added BackupValidateOperation API * Added BackupValidateOperation API * Fix casing in validateOperationResponse * Fix casing in validateOperationResponse * Fix casing in swagger example file path * Use ValidateRequest instead of Resource * Update operationid of validate_Operation to Operation_Validate per feedback * Update operationid of validate_Operation to Operation_Validate per feedback * remove additional parameter api-version --- .../stable/2016-12-01/bms.json | 81 ++- .../stable/2017-07-01/bms.json | 551 +++++++++++++++++- .../ValidateOperation_RestoreDisk.json | 47 ++ 3 files changed, 622 insertions(+), 57 deletions(-) create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json index 8f553e6b10b5..44b2124483c3 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json @@ -394,7 +394,7 @@ "tags": [ "ProtectionContainers" ], - "description": "Registers the container with Recovery Services vault.\r\n This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.", + "description": "Registers the container with Recovery Services vault.\r\n This is an asynchronous operation. To track the operation status, use location header to call get latest status of\r\n the operation.", "operationId": "ProtectionContainers_Register", "produces": [ "application/json" @@ -458,7 +458,7 @@ "tags": [ "ProtectionContainers" ], - "description": "Unregisters the given container from your Recovery Services Vault.\r\n This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.", + "description": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\r\n whether the backend service has finished processing the request, call Get Container Operation Result API.", "operationId": "ProtectionContainers_Unregister", "produces": [ "application/json" @@ -572,7 +572,7 @@ "tags": [ "BackupWorkloadItems" ], - "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.", + "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\n parameters.", "operationId": "BackupWorkloadItems_List", "produces": [ "application/json" @@ -711,7 +711,7 @@ "tags": [ "ProtectedItems" ], - "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", + "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\r\n call the GetItemOperationResult API.", "operationId": "ProtectedItems_Get", "produces": [ "application/json" @@ -781,7 +781,7 @@ "tags": [ "ProtectedItems" ], - "description": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", + "description": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an\r\n asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", "operationId": "ProtectedItems_CreateOrUpdate", "produces": [ "application/json" @@ -846,7 +846,7 @@ "tags": [ "ProtectedItems" ], - "description": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.", + "description": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the\r\n request, call the GetItemOperationResult API.", "operationId": "ProtectedItems_Delete", "produces": [ "application/json" @@ -907,7 +907,7 @@ "tags": [ "Backups" ], - "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.", + "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\r\n operation, call GetProtectedItemOperationResult API.", "operationId": "Backups_Trigger", "produces": [ "application/json" @@ -1048,7 +1048,7 @@ "tags": [ "ProtectedItemOperationStatuses" ], - "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.", + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\n or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\r\n create jobs. This method returns the list of jobs associated with the operation.", "operationId": "ProtectedItemOperationStatuses_Get", "produces": [ "application/json" @@ -1188,7 +1188,7 @@ "tags": [ "RecoveryPoints" ], - "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.", + "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\r\n To know the status of the operation, call the GetProtectedItemOperationResult API.", "operationId": "RecoveryPoints_Get", "produces": [ "application/json" @@ -1256,7 +1256,7 @@ "tags": [ "ItemLevelRecoveryConnections" ], - "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.", + "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\r\n explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\r\n provisioning, call GetProtectedItemOperationResult API.", "operationId": "ItemLevelRecoveryConnections_Provision", "produces": [ "application/json" @@ -1298,7 +1298,7 @@ { "name": "recoveryPointId", "in": "path", - "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned for this backed up data.", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\n for this backed up data.", "required": true, "type": "string" }, @@ -1330,7 +1330,7 @@ "tags": [ "Restores" ], - "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.", + "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\r\n GetProtectedItemOperationResult API.", "operationId": "Restores_Trigger", "produces": [ "application/json" @@ -1407,7 +1407,7 @@ "tags": [ "ItemLevelRecoveryConnections" ], - "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.", + "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\r\n displaying all recoverable files and folders. This is an asynchronous operation.", "operationId": "ItemLevelRecoveryConnections_Revoke", "produces": [ "application/json" @@ -1449,7 +1449,7 @@ { "name": "recoveryPointId", "in": "path", - "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for this backed up data.", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\n this backed up data.", "required": true, "type": "string" } @@ -1472,7 +1472,7 @@ "tags": [ "ProtectionContainers" ], - "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", + "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\r\n asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", "operationId": "ProtectionContainers_Refresh", "produces": [ "application/json" @@ -1524,7 +1524,7 @@ "tags": [ "JobCancellations" ], - "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.", + "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\n GetCancelOperationResult API.", "operationId": "JobCancellations_Trigger", "produces": [ "application/json" @@ -1625,7 +1625,7 @@ "tags": [ "BackupOperationResults" ], - "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.", + "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\r\n status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\r\n successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\r\n part of the Location header of the operation response.", "operationId": "BackupOperationResults_Get", "produces": [ "application/json" @@ -1675,7 +1675,7 @@ "tags": [ "BackupOperationStatuses" ], - "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.", + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\n or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\r\n create jobs. This method returns the list of jobs when the operation is complete.", "operationId": "BackupOperationStatuses_Get", "produces": [ "application/json" @@ -1722,7 +1722,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\r\n operation. Status of the operation can be fetched using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_Get", "produces": [ "application/json" @@ -1767,7 +1767,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\n using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_CreateOrUpdate", "produces": [ "application/json" @@ -1830,7 +1830,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\r\n operation can be fetched using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_Delete", "produces": [ "application/json" @@ -1931,7 +1931,7 @@ "tags": [ "ProtectionPolicyOperationStatuses" ], - "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.", + "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\r\n or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\r\n create jobs. This method returns the list of jobs associated with operation.", "operationId": "ProtectionPolicyOperationStatuses_Get", "produces": [ "application/json" @@ -1985,7 +1985,7 @@ "tags": [ "BackupProtectableItems" ], - "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.", + "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\n pagination parameters.", "operationId": "BackupProtectableItems_List", "produces": [ "application/json" @@ -3394,7 +3394,7 @@ "type": "object", "properties": { "hostServerName": { - "description": "Host Os Name in case of Stand Alone and \r\n Cluster Name in case of distributed container.", + "description": "Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.", "type": "string" }, "inquiryInfo": { @@ -4110,12 +4110,7 @@ "VMAppContainer", "SQLAGWorkLoadContainer", "StorageContainer", - "GenericContainer", - "SqlCluster", - "ExchangeDAG", - "SharepointFarm", - "HyperVCluster", - "WindowsClient" + "GenericContainer" ], "type": "string", "x-ms-enum": { @@ -5089,11 +5084,11 @@ "type": "string" }, "subnetId": { - "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent the subnet.", + "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\n the subnet.", "type": "string" }, "targetDomainNameId": { - "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.", + "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\n Virtual Machines.", "type": "string" }, "region": { @@ -5105,7 +5100,7 @@ "type": "string" }, "createNewCloudService": { - "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same cloud service as it was at the time of backup.", + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\n cloud service as it was at the time of backup.", "type": "boolean" }, "originalStorageAccountOption": { @@ -5152,7 +5147,7 @@ "type": "object", "properties": { "status": { - "description": "Inquiry Status for this container such as \r\n InProgress | Failed | Succeeded", + "description": "Inquiry Status for this container such as\r\n InProgress | Failed | Succeeded", "type": "string" }, "errorDetail": { @@ -5160,7 +5155,7 @@ "description": "Error Details if the Status is non-success." }, "inquiryDetails": { - "description": "Inquiry Details which will have workload specific details. \r\n For e.g. - For SQL and oracle this will contain different details.", + "description": "Inquiry Details which will have workload specific details.\r\n For e.g. - For SQL and oracle this will contain different details.", "type": "array", "items": { "$ref": "#/definitions/WorkloadInquiryDetails" @@ -5751,12 +5746,7 @@ "VMAppContainer", "SQLAGWorkLoadContainer", "StorageContainer", - "GenericContainer", - "SqlCluster", - "ExchangeDAG", - "SharepointFarm", - "HyperVCluster", - "WindowsClient" + "GenericContainer" ], "type": "string", "readOnly": true, @@ -5946,7 +5936,7 @@ "type": "string" }, "containerType": { - "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer", + "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\n Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\n Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\n Backup is VMAppContainer", "enum": [ "Invalid", "Unknown", @@ -5962,12 +5952,7 @@ "VMAppContainer", "SQLAGWorkLoadContainer", "StorageContainer", - "GenericContainer", - "SqlCluster", - "ExchangeDAG", - "SharepointFarm", - "HyperVCluster", - "WindowsClient" + "GenericContainer" ], "type": "string", "x-ms-enum": { diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json index 3077a1836e90..351d238e15b6 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json @@ -335,7 +335,7 @@ "tags": [ "ExportJobsOperationResults" ], - "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\r\n contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", "operationId": "ExportJobsOperationResults_Get", "produces": [ "application/json" @@ -433,7 +433,7 @@ "tags": [ "BackupPolicies" ], - "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.", + "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\n scoped results.", "operationId": "BackupPolicies_List", "produces": [ "application/json" @@ -600,6 +600,55 @@ } } } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation": { + "post": { + "tags": [ + "Validate" + ], + "description": "Validate operation for specified backed up item. This is a synchronous operation.", + "operationId": "Operation_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource validate operation request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateOperationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateOperationsResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Validate Operation": { + "$ref": "./examples/AzureIaasVm/ValidateOperation_RestoreDisk.json" + } + } + } } }, "definitions": { @@ -724,6 +773,75 @@ }, "x-ms-discriminator-value": "AzureStorage" }, + "AzureFileShareRestoreRequest": { + "description": "AzureFileShare Restore Request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Source storage account ARM Id", + "type": "string" + }, + "copyOptions": { + "description": "Options to resolve copy conflicts.", + "enum": [ + "Invalid", + "CreateCopy", + "Skip", + "Overwrite", + "FailOnConflict" + ], + "type": "string", + "x-ms-enum": { + "name": "CopyOptions", + "modelAsString": true + } + }, + "restoreRequestType": { + "description": "Restore Type (FullShareRestore or ItemLevelRestore)", + "enum": [ + "Invalid", + "FullShareRestore", + "ItemLevelRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreRequestType", + "modelAsString": true + } + }, + "restoreFileSpecs": { + "description": "List of Source Files/Folders(which need to recover) and TargetFolderPath details", + "type": "array", + "items": { + "$ref": "#/definitions/RestoreFileSpecs" + } + }, + "targetDetails": { + "$ref": "#/definitions/TargetAFSRestoreInfo", + "description": "Target File Share Details" + } + }, + "x-ms-discriminator-value": "AzureFileShareRestoreRequest" + }, "AzureIaaSClassicComputeVMProtectedItem": { "description": "IaaS VM workload-specific backup item representing the Classic Compute VM.", "type": "object", @@ -874,6 +992,10 @@ "description": "Indicates progress of the job. Null if it has not started or completed.", "type": "number" }, + "estimatedRemainingDuration": { + "description": "Time remaining for execution of this job.", + "type": "string" + }, "dynamicErrorMessage": { "description": "Non localized error message on job execution.", "type": "string" @@ -915,6 +1037,10 @@ "format": "double", "description": "Progress of the task.", "type": "number" + }, + "taskExecutionDetails": { + "description": "Details about execution of the task.\r\n eg: number of bytes transfered etc", + "type": "string" } } }, @@ -1664,6 +1790,101 @@ } } }, + "AzureWorkloadRestoreRequest": { + "description": "AzureWorkload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "OLR/ALR, RestoreDisks is invalid option", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" + }, + "AzureWorkloadSAPHanaPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreRequest" + }, + "AzureWorkloadSAPHanaRestoreRequest": { + "description": "AzureWorkload SAP Hana-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "recoveryType": { + "description": "OLR/ALR, RestoreDisks is invalid option", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreRequest" + }, "AzureWorkloadSQLAutoProtectionIntent": { "description": "Azure Workload SQL Auto Protection intent item.", "type": "object", @@ -1691,6 +1912,54 @@ }, "x-ms-discriminator-value": "AzureWorkloadSQLAutoProtectionIntent" }, + "AzureWorkloadSQLPointInTimeRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreRequest" + }, + "AzureWorkloadSQLRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for full/diff restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "shouldUseAlternateTargetLocation": { + "description": "Default option set to true. If this is set to false, alternate data directory must be provided", + "type": "boolean" + }, + "isNonRecoverable": { + "description": "SQL specific property where user can chose to set no-recovery when restore operation is tried", + "type": "boolean" + }, + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "alternateDirectoryPaths": { + "description": "Data directory details", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectoryMapping" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRestoreRequest" + }, "BackupManagementUsage": { "description": "Backup management usages of a vault.", "type": "object", @@ -2158,6 +2427,32 @@ } } }, + "EncryptionDetails": { + "description": "Details needed if the VM was encrypted at the time of backup.", + "type": "object", + "properties": { + "encryptionEnabled": { + "description": "Identifies whether this backup copy represents an encrypted VM at the time of backup.", + "type": "boolean" + }, + "kekUrl": { + "description": "Key Url.", + "type": "string" + }, + "secretKeyUrl": { + "description": "Secret Url.", + "type": "string" + }, + "kekVaultId": { + "description": "ID of Key Vault where KEK is stored.", + "type": "string" + }, + "secretKeyVaultId": { + "description": "ID of Key Vault where Secret is stored.", + "type": "string" + } + } + }, "ErrorDetail": { "description": "Error Detail class which encapsulates Code, Message and Recommendations.", "type": "object", @@ -2289,6 +2584,84 @@ }, "x-ms-discriminator-value": "GenericProtectionPolicy" }, + "IaasVMRestoreRequest": { + "description": "IaaS VM workload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "ID of the backup copy to be recovered.", + "type": "string" + }, + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM which is being recovered.", + "type": "string" + }, + "targetVirtualMachineId": { + "description": "This is the complete ARM Id of the VM that will be created.\r\n For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", + "type": "string" + }, + "targetResourceGroupId": { + "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\n For e.g. /subscriptions/{subId}/resourcegroups/{rg}", + "type": "string" + }, + "storageAccountId": { + "description": "Fully qualified ARM ID of the storage account to which the VM has to be restored.", + "type": "string" + }, + "virtualNetworkId": { + "description": "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\n User will be validated for join action permissions in the linked access.", + "type": "string" + }, + "subnetId": { + "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\n the subnet.", + "type": "string" + }, + "targetDomainNameId": { + "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\n Virtual Machines.", + "type": "string" + }, + "region": { + "description": "Region in which the virtual machine is restored.", + "type": "string" + }, + "affinityGroup": { + "description": "Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.", + "type": "string" + }, + "createNewCloudService": { + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\n cloud service as it was at the time of backup.", + "type": "boolean" + }, + "originalStorageAccountOption": { + "description": "Original Storage Account Option", + "type": "boolean" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Details needed if the VM was encrypted at the time of backup." + } + }, + "x-ms-discriminator-value": "IaasVMRestoreRequest" + }, "Job": { "description": "Defines workload agnostic properties for a job.", "required": [ @@ -2638,12 +3011,7 @@ "VMAppContainer", "SQLAGWorkLoadContainer", "StorageContainer", - "GenericContainer", - "SqlCluster", - "ExchangeDAG", - "SharepointFarm", - "HyperVCluster", - "WindowsClient" + "GenericContainer" ], "type": "string", "x-ms-enum": { @@ -3011,7 +3379,7 @@ "type": "string" }, "containerName": { - "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required for portal", + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\n for portal", "type": "string" }, "protectedItemName": { @@ -3449,6 +3817,38 @@ } } }, + "RestoreFileSpecs": { + "description": "Restore file specs like file path, type and target folder path info.", + "type": "object", + "properties": { + "path": { + "description": "Source File/Folder path", + "type": "string" + }, + "fileSpecType": { + "description": "Indicates what the Path variable stands for", + "type": "string" + }, + "targetFolderPath": { + "description": "Destination folder path in target FileShare", + "type": "string" + } + } + }, + "RestoreRequest": { + "description": "Base class for restore request. Workload-specific restore requests are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, "RetentionDuration": { "description": "Retention duration.", "type": "object", @@ -3595,6 +3995,37 @@ }, "x-ms-discriminator-value": "SimpleSchedulePolicy" }, + "SQLDataDirectoryMapping": { + "description": "Encapsulates information regarding data directory", + "type": "object", + "properties": { + "mappingType": { + "description": "Type of data directory mapping", + "enum": [ + "Invalid", + "Data", + "Log" + ], + "type": "string", + "x-ms-enum": { + "name": "SQLDataDirectoryType", + "modelAsString": true + } + }, + "sourceLogicalName": { + "description": "Restore source logical name path", + "type": "string" + }, + "sourcePath": { + "description": "Restore source path", + "type": "string" + }, + "targetPath": { + "description": "Target path", + "type": "string" + } + } + }, "SubProtectionPolicy": { "description": "Sub-protection policy which includes schedule and retention", "type": "object", @@ -3613,6 +4044,108 @@ } } }, + "TargetAFSRestoreInfo": { + "description": "Target Azure File Share Info.", + "type": "object", + "properties": { + "name": { + "description": "File share name", + "type": "string" + }, + "targetResourceId": { + "description": "Target file share resource ARM ID", + "type": "string" + } + } + }, + "TargetRestoreInfo": { + "description": "Details about target workload during restore operation.", + "type": "object", + "properties": { + "overwriteOption": { + "description": "Can Overwrite if Target DataBase already exists", + "enum": [ + "Invalid", + "FailOnConflict", + "Overwrite" + ], + "type": "string", + "x-ms-enum": { + "name": "OverwriteOptions", + "modelAsString": true + } + }, + "containerId": { + "description": "Resource Id name of the container in which Target DataBase resides", + "type": "string" + }, + "databaseName": { + "description": "Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana", + "type": "string" + } + } + }, + "ValidateIaasVMRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateRestoreOperationRequest" + } + ], + "x-ms-discriminator-value": "ValidateIaasVMRestoreOperationRequest" + }, + "ValidateOperationRequest": { + "description": "Base class for validate operation request.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ValidateOperationResponse": { + "description": "Base class for validate operation response.", + "type": "object", + "properties": { + "validationResults": { + "description": "Gets the validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + } + }, + "ValidateOperationsResponse": { + "type": "object", + "properties": { + "validateOperationResponse": { + "$ref": "#/definitions/ValidateOperationResponse" + } + } + }, + "ValidateRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateOperationRequest" + } + ], + "properties": { + "restoreRequest": { + "$ref": "#/definitions/RestoreRequest", + "description": "Sets restore request to be validated" + } + }, + "x-ms-discriminator-value": "ValidateRestoreOperationRequest" + }, "WeeklyRetentionFormat": { "description": "Weekly retention format.", "type": "object", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json new file mode 100644 index 000000000000..2ea2e631b773 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testRG;testvmName", + "protectedItemName": "VM;iaasvmcontainerv2;testRG;testvmName", + "recoveryPointId": "348916168024334", + "api-version": "2017-07-01", + "parameters": { + "objectType": "ValidateIaasVMRestoreOperationRequest", + "restoreRequest": { + "recoveryPointId": "348916168024334", + "objectType": "IaasVMRestoreRequest", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + } + } + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } +} \ No newline at end of file From 3316d44639fe66286c6e63594c058dd0806d090a Mon Sep 17 00:00:00 2001 From: chlahav Date: Wed, 18 Jul 2018 19:19:22 +0300 Subject: [PATCH 19/31] Security Center: Fixing documentation of auto-provision settings (#3429) --- ...teAutoProvisioningSettingsSubscription_example.json | 4 ++-- ...GetAutoProvisioningSettingSubscription_example.json | 2 +- ...etAutoProvisioningSettingsSubscription_example.json | 2 +- .../preview/2017-08-01-preview/security.json | 10 +++++----- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json index 0d55170d1f2e..507975c379e2 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json @@ -8,7 +8,7 @@ "name": "default", "type": "Microsoft.Security/autoProvisioningSettings", "properties": { - "provisioningSetting": "Automatic" + "autoProvision": "On" } } }, @@ -19,7 +19,7 @@ "name": "default", "type": "Microsoft.Security/autoProvisioningSettings", "properties": { - "provisioningSetting": "Automatic" + "autoProvision": "On" } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json index f9f3bed03f32..6ff9bb0e7264 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json @@ -11,7 +11,7 @@ "name": "default", "type": "Microsoft.Security/autoProvisioningSettings", "properties": { - "provisioningSetting": "Automatic" + "autoProvision": "On" } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json index e3d1a39f0ad4..1574e0bfb25c 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json @@ -11,7 +11,7 @@ "name": "default", "type": "Microsoft.Security/autoProvisioningSettings", "properties": { - "provisioningSetting": "Automatic" + "autoProvision": "On" } }] } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json index 4ed59059f15b..cc2d14c50ce9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json @@ -1020,15 +1020,15 @@ "type": "object", "description": "describes properties of an auto provisioning setting", "properties": { - "provisioningSetting": { + "autoProvision": { "type": "string", "description": "Describes what kind of security agent provisioning action to take", - "enum": ["Automatic", "Off"], + "enum": ["On", "Off"], "x-ms-enum": { - "name": "provisioningSetting", + "name": "autoProvision", "modelAsString": true, "values": [{ - "value": "Automatic", + "value": "On", "description": "Install missing security agent on VMs automatically" }, { @@ -1040,7 +1040,7 @@ } }, "required": [ - "provisioningSetting" + "autoProvision" ] }, "ComplianceList": { From fa000df8ed64eda8f86f8c6225c7c3613d57a674 Mon Sep 17 00:00:00 2001 From: Vipul Modi - MSFT Date: Wed, 18 Jul 2018 09:25:27 -0700 Subject: [PATCH 20/31] BugFix: defaultSinkRefs is an array of string (#3432) --- .../preview/2018-07-01-preview/servicefabricmesh.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json index a394a917c84e..cd4b6488ca71 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json @@ -2012,7 +2012,10 @@ }, "defaultSinkRefs": { "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", - "type": "string" + "type": "array", + "items": { + "type": "string" + } } } }, From fe957d8f8e597dc34cbc985ef9aa66331e41b5e8 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Wed, 18 Jul 2018 09:26:46 -0700 Subject: [PATCH 21/31] Bump hdinsight Node.js package version to 0.5.0 (#3434) --- specification/hdinsight/resource-manager/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/hdinsight/resource-manager/readme.nodejs.md b/specification/hdinsight/resource-manager/readme.nodejs.md index c43b29bef27b..f6dbc5e896bb 100644 --- a/specification/hdinsight/resource-manager/readme.nodejs.md +++ b/specification/hdinsight/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= Date: Wed, 18 Jul 2018 09:27:01 -0700 Subject: [PATCH 22/31] Bump recoveryservicesbackup Node.js package version to 3.0.0 (#3435) --- .../recoveryservicesbackup/resource-manager/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md b/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md index ca74ac6971eb..3454d7942205 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= Date: Wed, 18 Jul 2018 09:49:16 -0700 Subject: [PATCH 23/31] Bump azure-arm-iothub Node.js package version to 2.0.1 (#3436) --- specification/iothub/resource-manager/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/iothub/resource-manager/readme.nodejs.md b/specification/iothub/resource-manager/readme.nodejs.md index 28dd8fa6bc47..bfb57ea323e0 100644 --- a/specification/iothub/resource-manager/readme.nodejs.md +++ b/specification/iothub/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= Date: Wed, 18 Jul 2018 22:51:18 +0530 Subject: [PATCH 24/31] AlertsManagement RP Public preview Swagger Spec (#3431) --- .../2018-05-05-preview/AlertsManagement.json | 1589 +++++++++++++++++ .../examples/Alerts_ChangeState.json | 38 + .../examples/Alerts_GetbyId.json | 35 + .../examples/Alerts_History.json | 40 + .../examples/Alerts_List.json | 61 + .../examples/Alerts_Summary.json | 89 + .../examples/SmartGroups_ChangeState.json | 74 + .../examples/SmartGroups_GetbyId.json | 70 + .../examples/SmartGroups_History.json | 30 + .../examples/SmartGroups_List.json | 145 ++ .../resource-manager/readme.md | 139 ++ 11 files changed, 2310 insertions(+) create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json create mode 100644 specification/alertsmanagement/resource-manager/readme.md diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json new file mode 100644 index 000000000000..b57a92105dc9 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json @@ -0,0 +1,1589 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-05-05-preview", + "title": "Azure Alerts Management Service Resource Provider", + "description": "REST APIs for Azure Alerts Management Service." + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AlertsManagement/operations": { + "get": { + "operationId": "Operations_List", + "description": "List all operations available through Azure Alerts Management Resource Provider.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Succesfully retrieved operations list.", + "schema": { + "$ref": "#/definitions/operationsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts": { + "get": { + "operationId": "Alerts_GetAll", + "description": "List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields. ", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResource" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/targetResourceType" + }, + { + "$ref": "#/parameters/monitorService" + }, + { + "$ref": "#/parameters/monitorCondition" + }, + { + "$ref": "#/parameters/severity" + }, + { + "$ref": "#/parameters/alertState" + }, + { + "$ref": "#/parameters/smartGroupIdFilter" + }, + { + "$ref": "#/parameters/includePayload" + }, + { + "$ref": "#/parameters/pageCount" + }, + { + "$ref": "#/parameters/alertsSortBy" + }, + { + "$ref": "#/parameters/sortOrder" + }, + { + "$ref": "#/parameters/timeRange" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Succesfully listed alert objects.", + "schema": { + "$ref": "#/definitions/alertsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListAlerts": { + "$ref": "./examples/Alerts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}": { + "get": { + "operationId": "Alerts_GetById", + "summary": "Get a specific alert.", + "description": "Get information related to a specific alert", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/alertId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the alert with the specified ID.", + "schema": { + "$ref": "#/definitions/alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "GetById": { + "$ref": "./examples/Alerts_GetbyId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate": { + "post": { + "operationId": "Alerts_ChangeState", + "description": "Change the state of the alert.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/alertId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/newState" + } + ], + "responses": { + "200": { + "description": "OK. Alert state updated.", + "schema": { + "$ref": "#/definitions/alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Resolve": { + "$ref": "./examples/Alerts_ChangeState.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history": { + "get": { + "operationId": "Alerts_GetHistory", + "description": "Get the history of the changes of an alert.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/alertId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of changes of alert.", + "schema": { + "$ref": "#/definitions/alertModification" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Resolve": { + "$ref": "./examples/Alerts_History.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary": { + "get": { + "operationId": "Alerts_GetSummary", + "description": "Summary of alerts with the count each severity.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/timeRange" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Alert state updated.", + "schema": { + "$ref": "#/definitions/alertsSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Summary": { + "$ref": "./examples/Alerts_Summary.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups": { + "get": { + "operationId": "SmartGroups_GetAll", + "summary": "Get all smartGroups within the subscription", + "description": "List all the smartGroups within the specified subscription. ", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResource" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/targetResourceType" + }, + { + "$ref": "#/parameters/monitorService" + }, + { + "$ref": "#/parameters/monitorCondition" + }, + { + "$ref": "#/parameters/severity" + }, + { + "$ref": "#/parameters/smartGroupState" + }, + { + "$ref": "#/parameters/timeRange" + }, + { + "$ref": "#/parameters/pageCount" + }, + { + "$ref": "#/parameters/smartGroupsSortBy" + }, + { + "$ref": "#/parameters/sortOrder" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Returns list of all smartGroups.", + "schema": { + "$ref": "#/definitions/smartGroupsList", + "description": "List of smart groups in value property." + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "List": { + "$ref": "./examples/SmartGroups_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}": { + "get": { + "operationId": "SmartGroups_GetById", + "summary": "Get information of smart alerts group.", + "description": "Get details of smart group.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/smartGroupId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the group with the specified smart group Id.", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/smartGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Get": { + "$ref": "./examples/SmartGroups_GetbyId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState": { + "post": { + "operationId": "SmartGroups_ChangeState", + "description": "Change the state from unresolved to resolved and all the alerts within the smart group will also be resolved.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/smartGroupId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/newState" + } + ], + "responses": { + "200": { + "description": "OK. Alert state updated.", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/smartGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "changestate": { + "$ref": "./examples/SmartGroups_ChangeState.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history": { + "get": { + "operationId": "SmartGroups_GetHistory", + "description": "Get the history of the changes of smart group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/smartGroupId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of changes of smart group.", + "schema": { + "$ref": "#/definitions/smartGroupModification" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Resolve": { + "$ref": "./examples/SmartGroups_History.json" + } + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "type": "string", + "in": "path", + "required": true + }, + "api-version": { + "name": "api-version", + "description": "client API version", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "2017-11-15-privatepreview", + "2018-05-05-preview" + ], + "x-ms-enum": { + "name": "api-version", + "modelAsString": true + } + }, + "alertId": { + "name": "alertId", + "description": "Unique ID of an alert object.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "targetResourceGroup": { + "description": "filter by target resource group name", + "name": "targetResourceGroup", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "targetResource": { + "description": "filter by target resource", + "name": "targetResource", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "targetResourceType": { + "description": "filter by target resource type", + "name": "targetResourceType", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "monitorService": { + "description": "filter by monitor service which is the source of the alert object.", + "name": "monitorService", + "type": "string", + "in": "query", + "required": false, + "enum": [ + "Platform", + "Application Insights", + "Log Analytics", + "Zabbix", + "SCOM", + "Nagios", + "Infrastructure Insights", + "ActivityLog Administrative", + "ActivityLog Security", + "ActivityLog Recommendation", + "ActivityLog Policy", + "ActivityLog Autoscale", + "ServiceHealth", + "SmartDetector" + ], + "x-ms-enum": { + "name": "MonitorService", + "modelAsString": true + } + }, + "severity": { + "description": "filter by severity", + "name": "severity", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "Sev0", + "Sev1", + "Sev2", + "Sev3", + "Sev4" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "smartGroupIdFilter": { + "description": "filter by smart Group Id", + "name": "smartGroupId", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "smartGroupId": { + "description": "Smart Group Id", + "name": "smartGroupId", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "newState": { + "description": "filter by state", + "name": "newState", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "alertState": { + "description": "filter by state", + "name": "alertState", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "smartGroupState": { + "description": "filter by state", + "name": "smartGroupState", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "monitorCondition": { + "description": "filter by monitor condition which is the state of the alert at monitor service", + "name": "monitorCondition", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "Fired", + "Resolved" + ], + "x-ms-enum": { + "name": "MonitorCondition", + "modelAsString": true + } + }, + "timeRange": { + "description": "filter by time range, default value is 1 day", + "name": "timeRange", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "1h", + "1d", + "7d", + "30d" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true + } + }, + "includePayload": { + "description": "include payload field content, default value is 'false'.", + "name": "includePayload", + "type": "boolean", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "pageCount": { + "description": "number of items per page, default value is '25'.", + "name": "pageCount", + "type": "integer", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "alertsSortBy": { + "description": "sort the query results by input field, default value is 'lastModifiedDateTime'.", + "name": "sortBy", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "name", + "severity", + "alertState", + "monitorCondition", + "targetResource", + "targetResourceName", + "targetResourceGroup", + "targetResourceType", + "startDateTime", + "lastModifiedDateTime" + ], + "x-ms-enum": { + "name": "AlertsSortByFields", + "modelAsString": true + } + }, + "smartGroupsSortBy": { + "description": "sort the query results by input field, default value is 'lastModifiedDateTime'.", + "name": "sortBy", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "alertsCount", + "state", + "severity", + "startDateTime", + "lastModifiedDateTime" + ], + "x-ms-enum": { + "name": "SmartGroupsSortByFields", + "modelAsString": true + } + }, + "sortOrder": { + "description": "sort the query results order in either ascending or descending, default value is 'desc' for time fields and 'asc' for others.", + "name": "sortOrder", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "asc", + "desc" + ] + } + }, + "definitions": { + "operation": { + "description": "Operation provided by provider", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation" + }, + "display": { + "type": "object", + "description": "Properties of the operation", + "properties": { + "provider": { + "type": "string", + "description": "Provider name" + }, + "resource": { + "type": "string", + "description": "Resource name" + }, + "operation": { + "type": "string", + "description": "Operation name" + }, + "description": { + "type": "string", + "description": "Description of the operation" + } + } + } + } + }, + "operationsList": { + "description": "Lists the operations available in the AlertsManagement RP.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alerts.", + "type": "string" + }, + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/operation" + } + } + }, + "required": [ + "value" + ] + }, + "errorResponse": { + "description": "An error response from the service.", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/errorResponseBody" + } + } + }, + "errorResponseBody": { + "description": "Details of error response.", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "Error code, intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "Description of the error, intended for display in user interface." + }, + "target": { + "type": "string", + "description": "Target of the particular error, for example name of the property." + }, + "details": { + "type": "array", + "description": "A list of additional details about the error.", + "items": { + "$ref": "#/definitions/errorResponseBody" + } + } + } + }, + "Resource": { + "x-ms-azure-resource": true, + "description": "An azure resource object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + } + } + }, + "alert": { + "description": "An alert created in alert management service.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/alertProperties", + "x-ms-client-flatten": true + } + } + }, + "alertsList": { + "description": "List the alerts.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alerts.", + "type": "string" + }, + "value": { + "description": "List of alerts", + "type": "array", + "items": { + "$ref": "#/definitions/alert" + } + } + } + }, + "alertProperties": { + "type": "object", + "description": "An alert created in alert management service.", + "properties": { + "severity": { + "type": "string", + "description": "Severity of alert Sev1 being highest and Sev3 being lowest.", + "readOnly": true, + "enum": [ + "Sev0", + "Sev1", + "Sev2", + "Sev3", + "Sev4" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "signalType": { + "type": "string", + "description": "Log based alert or metric based alert", + "readOnly": true, + "enum": [ + "Metric", + "Log", + "Unknown" + ], + "x-ms-enum": { + "name": "SignalType", + "modelAsString": true + } + }, + "alertState": { + "type": "string", + "description": "Alert object state", + "readOnly": true, + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "monitorCondition": { + "type": "string", + "description": "Condition of the rule at the monitor service", + "readOnly": true, + "enum": [ + "Fired", + "Resolved" + ], + "x-ms-enum": { + "name": "MonitorCondition", + "modelAsString": true + } + }, + "targetResource": { + "type": "string", + "description": "Target ARM resource, on which alert got created." + }, + "targetResourceName": { + "type": "string", + "description": "Target ARM resource name, on which alert got created." + }, + "targetResourceGroup": { + "type": "string", + "description": "Resource group of target ARM resource." + }, + "targetResourceType": { + "type": "string", + "description": "Resource type of target ARM resource" + }, + "monitorService": { + "type": "string", + "description": "Monitor service which is the source of the alert object.", + "readOnly": true, + "enum": [ + "Platform", + "Application Insights", + "Log Analytics", + "Infrastructure Insights", + "ActivityLog Administrative", + "ActivityLog Security", + "ActivityLog Recommendation", + "ActivityLog Policy", + "ActivityLog Autoscale", + "ServiceHealth", + "SmartDetector", + "Zabbix", + "SCOM", + "Nagios" + ], + "x-ms-enum": { + "name": "MonitorService", + "modelAsString": true + } + }, + "sourceCreatedId": { + "type": "string", + "description": "Unique Id created by monitor service", + "readOnly": true + }, + "smartGroupId": { + "type": "string", + "description": "Unique Id of the smart group", + "readOnly": true + }, + "smartGroupingReason": { + "type": "string", + "description": "Reason for addition to a smart group", + "readOnly": true + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Creation time(ISO-8601 format).", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "Last modification time(ISO-8601 format).", + "readOnly": true + }, + "lastModifiedUserName": { + "type": "string", + "description": "User who last modified the alert.", + "readOnly": true + }, + "payload": { + "type": "object", + "description": "More details which are contextual to the monitor service.", + "readOnly": true + } + } + }, + "alertModification": { + "description": "Alert Modification details", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/alertModificationProperties" + } + } + }, + "alertModificationProperties": { + "type": "object", + "description": "Properties of the alert modification item.", + "properties": { + "alertId": { + "type": "string", + "description": "Unique Id of the alert for which the history is being retrieved", + "readOnly": true + }, + "modifications": { + "type": "array", + "description": "Modification details", + "items": { + "$ref": "#/definitions/alertModificationItem" + } + } + } + }, + "alertModificationItem": { + "description": "Alert modification item.", + "properties": { + "modificationEvent": { + "type": "string", + "description": "Reason for the modification", + "enum": [ + "AlertCreated", + "StateChange", + "MonitorConditionChange" + ], + "x-ms-enum": { + "name": "AlertModificationEvent" + } + }, + "oldValue": { + "type": "string", + "description": "Old value" + }, + "newValue": { + "type": "string", + "description": "New value" + }, + "modifiedAt": { + "type": "string", + "description": "Modified date and time" + }, + "modifiedBy": { + "type": "string", + "description": "Modified user details (Principal client name)" + }, + "comments": { + "type": "string", + "description": "Modification comments" + }, + "description": { + "type": "string", + "description": "Description of the modification" + } + } + }, + "smartGroupModification": { + "description": "Alert Modification details", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/smartGroupModificationProperties" + } + } + }, + "smartGroupModificationProperties": { + "description": "Properties of the smartGroup modification item.", + "properties": { + "smartGroupId": { + "type": "string", + "description": "Unique Id of the smartGroup for which the history is being retrieved", + "readOnly": true + }, + "modifications": { + "type": "array", + "description": "Modification details", + "items": { + "$ref": "#/definitions/smartGroupModificationItem" + } + }, + "nextLink": { + "description": "URL to fetch the next set of results.", + "type": "string" + } + } + }, + "smartGroupModificationItem": { + "description": "smartGroup modification item.", + "properties": { + "modificationEvent": { + "type": "string", + "description": "Reason for the modification", + "enum": [ + "SmartGroupCreated", + "StateChange", + "AlertAdded", + "AlertRemoved" + ], + "x-ms-enum": { + "name": "SmartGroupModificationEvent" + } + }, + "oldValue": { + "type": "string", + "description": "Old value" + }, + "newValue": { + "type": "string", + "description": "New value" + }, + "modifiedAt": { + "type": "string", + "description": "Modified date and time" + }, + "modifiedBy": { + "type": "string", + "description": "Modified user details (Principal client name)" + }, + "comments": { + "type": "string", + "description": "Modification comments" + }, + "description": { + "type": "string", + "description": "Description of the modification" + } + } + }, + "alertsSummary": { + "description": "Summary of the alerts.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/alertsSummaryProperties", + "x-ms-client-flatten": true + } + } + }, + "alertsSummaryProperties": { + "type": "object", + "description": "Summary of the alerts", + "properties": { + "total": { + "type": "integer", + "description": "Total number of alerts." + }, + "smartGroupsCount": { + "type": "integer", + "description": "Total number of smart groups." + }, + "summaryByState": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by state" + }, + "summaryBySeverity": { + "type": "object", + "description": "Summary of alerts by severity", + "properties": { + "sev0": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev0'" + }, + "sev1": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev1'" + }, + "sev2": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev2'" + }, + "sev3": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev3'" + }, + "sev4": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev4'" + } + } + }, + "summaryBySeverityAndMonitorCondition": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryBySeverityAndMonitorCondition" + } + ], + "type": "object", + "description": "Summary of alerts by severity and monitor condition" + }, + "summaryByMonitorService": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorService" + } + ], + "type": "object", + "description": "Summary of alerts by severity" + }, + "nextLink": { + "description": "URL to fetch the next set of results.", + "type": "string" + } + } + }, + "alertsSummaryByState": { + "type": "object", + "description": "Summary of alerts by state", + "properties": { + "new": { + "type": "integer", + "description": "Count of alerts with state 'New'" + }, + "acknowledged": { + "type": "integer", + "description": "Count of alerts with state 'Acknowledged'" + }, + "closed": { + "type": "integer", + "description": "Count of alerts with state 'Closed'" + } + } + }, + "alertsSummaryBySeverityAndMonitorCondition": { + "type": "object", + "description": "Summary of the alerts by severity and monitor condition", + "properties": { + "sev0": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev0'" + }, + "sev1": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev1'" + }, + "sev2": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev2'" + }, + "sev3": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev3'" + }, + "sev4": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev4'" + } + } + }, + "alertsSummaryByMonitorCondition": { + "type": "object", + "description": "Summary of the alerts by monitor condition", + "properties": { + "fired": { + "type": "integer", + "description": "Count of alerts with monitorCondition 'Fired'" + }, + "resolved": { + "type": "integer", + "description": "Count of alerts with monitorCondition 'Resolved'" + } + } + }, + "alertsSummaryByMonitorService": { + "type": "object", + "description": "Summary of the alerts by monitor service", + "properties": { + "platform": { + "type": "integer", + "description": "Count of alerts of \"Platform\"" + }, + "application Insights": { + "type": "integer", + "description": "Count of alerts of \"Application Insights\"" + }, + "log Analytics": { + "type": "integer", + "description": "Count of alerts of \"Log Analytics\"" + }, + "zabbix": { + "type": "integer", + "description": "Count of alerts of \"Zabbix\"" + }, + "scom": { + "type": "integer", + "description": "Count of alerts of \"SCOM\"" + }, + "nagios": { + "type": "integer", + "description": "Count of alerts of \"Nagios\"" + }, + "infrastructure Insights": { + "type": "integer", + "description": "Count of alerts of \"Infrastructure Insights\"" + }, + "activityLog Administrative": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Administrative\"" + }, + "activityLog Security": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Security\"" + }, + "activityLog Recommendation": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Recommendation\"" + }, + "activityLog Policy": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Policy\"" + }, + "activityLog Autoscale": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Autoscale\"" + }, + "serviceHealth": { + "type": "integer", + "description": "Count of alerts of \"ServiceHealth\"" + }, + "smartDetector": { + "type": "integer", + "description": "Count of alerts of \"Smart Detector\"" + } + } + }, + "smartGroupsList": { + "description": "List the alerts.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alerts.", + "type": "string" + }, + "value": { + "description": "List of alerts", + "type": "array", + "items": { + "$ref": "#/definitions/smartGroup" + } + } + } + }, + "smartGroup": { + "description": "Set of related alerts grouped together smartly by AMS.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/smartGroupProperties" + } + } + }, + "smartGroupProperties": { + "type": "object", + "description": "Properties of smart group.", + "properties": { + "alertsCount": { + "type": "integer", + "description": "Total number of alerts in smart group" + }, + "smartGroupState": { + "type": "string", + "description": "Smart group state", + "readOnly": true, + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true + } + }, + "severity": { + "type": "string", + "description": "Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group.", + "readOnly": true, + "enum": [ + "Sev0", + "Sev1", + "Sev2", + "Sev3", + "Sev4" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Creation time of smart group. Date-Time in ISO-8601 format.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "Last updated time of smart group. Date-Time in ISO-8601 format.", + "readOnly": true + }, + "lastModifiedUserName": { + "type": "string", + "description": "Last modified by user name.", + "readOnly": true + }, + "resources": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of target resources in the smart group" + }, + "resourceTypes": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of target resource types in the smart group" + }, + "resourceGroups": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of target resource groups in the smart group" + }, + "monitorServices": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of monitorServices in the smart group" + }, + "monitorConditions": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of monitorConditions in the smart group" + }, + "alertStates": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of alertStates in the smart group" + }, + "alertSeverities": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of alertSeverities in the smart group" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts." + } + } + }, + "smartGroupAggregatedProperty": { + "type": "object", + "description": "Aggregated property of each type", + "properties": { + "name": { + "type": "string", + "description": "Name of the type." + }, + "count": { + "type": "integer", + "description": "Total number of items of type." + } + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json new file mode 100644 index 000000000000..b77a6029fb67 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "alertId": "66114d64-d9d9-478b-95c9-b789d6502100", + "newState": "Acknowledged", + "body":{ + "comments" : "Acknowledging alert" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "lastModifiedUserName":"vikramm@microsoft.com", + "payload":{} + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + } + } +} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json new file mode 100644 index 000000000000..aad3d0031733 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "alertId": "66114d64-d9d9-478b-95c9-b789d6502100" + }, + "responses": { + "200": { + "body": { + + "properties":{ + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "lastModifiedUserName":"System", + "payload":{} + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json new file mode 100644 index 000000000000..2305f2aa9598 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "alertId": "66114d64-d9d9-478b-95c9-b789d6502100" + }, + "responses": { + "200": { + "body": { + "properties":{ + "alertId":"66114d64-d9d9-478b-95c9-b789d6502100", + "modifications":[ + { + "modificationEvent":"StateChange", + "oldValue":"New", + "newValue":"Acknowledged", + "modifiedAt":"2018-06-13T06:14:15.7378737Z", + "modifiedBy":"vikramm@microsoft.com", + "comments":"Acknowledging alert", + "description":"State changed from 'New' to 'Acknowledged'" + }, + { + "modificationEvent":"AlertCreated", + "oldValue":"", + "newValue":"", + "modifiedAt":"2018-06-13T06:09:01Z", + "modifiedBy":"System", + "comments":"", + "description":"New Alert Object is created" + } + ] + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100/history/default", + "type":"Microsoft.AlertsManagement/alerts", + "name":"CPU Alert" + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json new file mode 100644 index 000000000000..1e299af0a821 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d" + }, + "responses": { + "200": { + "body": { + "nextLink":"https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1", + "value": [ + { + "properties":{ + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "lastModifiedUserName":"System", + "payload":{} + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + }, + { + "properties":{ + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"e1c5c974-b796-46a1-bb59-740eeca48c15", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T21:40:09Z", + "lastModifiedDateTime":"2018-06-12T21:40:09Z", + "lastModifiedUserName":"System", + "payload":{} + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts/239f0e9f-9871-4c8b-a6a2-b893853d1066", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json new file mode 100644 index 000000000000..54c6c6e73a8f --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d" + }, + "responses": { + "200": { + "body": { + "properties":{ + "total":885, + "smartGroupsCount":2, + "summaryByState":{ + "new":884, + "acknowledged":1, + "closed":0 + }, + "summaryBySeverity":{ + "sev0":{ + "new":286, + "acknowledged":0, + "closed":0 + }, + "sev1":{ + "new":309, + "acknowledged":0, + "closed":0 + }, + "sev2":{ + "new":0, + "acknowledged":0, + "closed":0 + }, + "sev3":{ + "new":289, + "acknowledged":1, + "closed":0 + }, + "sev4":{ + "new":0, + "acknowledged":0, + "closed":0 + } + }, + "summaryBySeverityAndMonitorCondition":{ + "sev0":{ + "fired":286, + "resolved":0 + }, + "sev1":{ + "fired":309, + "resolved":0 + }, + "sev2":{ + "fired":0, + "resolved":0 + }, + "sev3":{ + "fired":290, + "resolved":0 + }, + "sev4":{ + "fired":0, + "resolved":0 + } + }, + "summaryByMonitorService":{ + "platform":0, + "application Insights":290, + "log Analytics":595, + "zabbix":0, + "scom":0, + "nagios":0, + "infrastructure Insights":0, + "activityLog Administrative":0, + "activityLog Security":0, + "activityLog Recommendation":0, + "activityLog Policy":0, + "activityLog Autoscale":0, + "serviceHealth":0, + "smartDetector":0 + } + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current", + "type":"Microsoft.AlertsManagement/alertsSummary", + "name":"current" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json new file mode 100644 index 000000000000..9d5acd7f3fb0 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "dd91de05-d791-4ceb-b6dc-988682dc7d72", + "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059", + "newState": "Acknowledged", + "body":{ + "comments" : "Acknowledging smart group" + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "alertsCount":1942, + "smartGroupState":"Acknowledged", + "severity":"Sev3", + "startDateTime":"2018-06-06T12:35:09Z", + "lastModifiedDateTime":"2018-06-13T06:30:09Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "count":1942 + } + ], + "resourceTypes":[ + { + "name":"components", + "count":1942 + } + ], + "resourceGroups":[ + { + "name":"alertscorrelationrg", + "count":1942 + } + ], + "monitorServices":[ + { + "name":"Application Insights", + "count":1942 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":1942 + } + ], + "alertStates":[ + { + "name":"New", + "count":1941 + }, + { + "name":"Acknowledged", + "count":1 + } + ], + "alertSeverities":[ + { + "name":"Sev3", + "count":1942 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"cpu alert" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json new file mode 100644 index 000000000000..3fdbc04189b1 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "smartGroupId": "603675da-9851-4b26-854a-49fc53d32715" + }, + "responses": { + "200": { + "body": { + "properties":{ + "alertsCount":1942, + "smartGroupState":"New", + "severity":"Sev3", + "startDateTime":"2018-06-06T12:35:09Z", + "lastModifiedDateTime":"2018-06-13T06:30:09Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "count":1942 + } + ], + "resourceTypes":[ + { + "name":"components", + "count":1942 + } + ], + "resourceGroups":[ + { + "name":"alertscorrelationrg", + "count":1942 + } + ], + "monitorServices":[ + { + "name":"Application Insights", + "count":1942 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":1942 + } + ], + "alertStates":[ + { + "name":"New", + "count":1941 + }, + { + "name":"Acknowledged", + "count":1 + } + ], + "alertSeverities":[ + { + "name":"Sev3", + "count":1942 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"cpu alert" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json new file mode 100644 index 000000000000..d4a2671b3808 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059" + }, + "responses": { + "200": { + "body": { + "properties":{ + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "modifications":[ + { + "modificationEvent":"SmartGroupCreated", + "oldValue":"", + "newValue":"", + "modifiedAt":"2018-06-06T12:35:09Z", + "modifiedBy":"System", + "comments":"", + "description":"New Smart Group is created" + } + ] + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059/history/default", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + } + } +} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json new file mode 100644 index 000000000000..46c24ed19a12 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "dd91de05-d791-4ceb-b6dc-988682dc7d72" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "properties":{ + "alertsCount":1942, + "smartGroupState":"New", + "severity":"Sev3", + "startDateTime":"2018-06-06T12:35:09Z", + "lastModifiedDateTime":"2018-06-13T06:30:09Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "count":1942 + } + ], + "resourceTypes":[ + { + "name":"components", + "count":1942 + } + ], + "resourceGroups":[ + { + "name":"alertscorrelationrg", + "count":1942 + } + ], + "monitorServices":[ + { + "name":"Application Insights", + "count":1942 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":1942 + } + ], + "alertStates":[ + { + "name":"New", + "count":1941 + }, + { + "name":"Acknowledged", + "count":1 + } + ], + "alertSeverities":[ + { + "name":"Sev3", + "count":1942 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"cpu alert" + }, + { + "properties":{ + "alertsCount":15374, + "smartGroupState":"Acknowledged", + "severity":"Sev0", + "startDateTime":"2018-05-17T10:18:44.2020997Z", + "lastModifiedDateTime":"2018-06-13T06:29:01Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/alertsint", + "count":15374 + } + ], + "resourceTypes":[ + { + "name":"microsoft.operationalinsights/workspaces", + "count":6912 + }, + { + "name":"workspaces", + "count":8462 + } + ], + "resourceGroups":[ + { + "name":"mms-eus", + "count":15374 + } + ], + "monitorServices":[ + { + "name":"Log Analytics", + "count":13911 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":15374 + } + ], + "alertStates":[ + { + "name":"New", + "count":15358 + }, + { + "name":"Acknowledged", + "count":12 + }, + { + "name":"Closed", + "count":4 + } + ], + "alertSeverities":[ + { + "name":"Sev0", + "count":6984 + }, + { + "name":"Sev1", + "count":6927 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/01114c7c-769f-4fd4-b6fa-ab77693b83cd", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"CPU Alert" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md new file mode 100644 index 000000000000..8ac5decf13cf --- /dev/null +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -0,0 +1,139 @@ +# AlertsManagement + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for AlerManagement. + + +--- +## Getting Started +To build the SDK for AlertManagement, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + +### Basic Information +These are the global settings for the AlertManagement API. + +``` yaml +title: AlertsManagementClient +description: AlertsManagement Client +openapi-type: arm +tag: package-2018-05-preview +``` + +### Tag: package-2018-05-preview + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05-preview' +input-file: +- Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json +``` + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-libraries-for-java + - repo: azure-sdk-for-go +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.AlertsManagement + output-folder: $(csharp-sdks-folder)/AlertsManagement/Management.AlertsManagement/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.alertsmanagement + package-name: azure-mgmt-alertsmanagement + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-alertsmanagement +``` + + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: alertsmanagement + clear-output-folder: true +``` + +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-05-preview +``` + +### Tag: package-2018-05-preview and go + +These settings apply only when `--tag=package-2018-05-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05-preview' && $(go) +output-folder: $(go-sdk-folder)/services/alertsmanagement/mgmt/2018-05-05-preview/alertsmanagement +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.alertsmanagement + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-alertsmanagement +``` + + From c4c8e6dd9932708078ab50975d023c3ec43c324f Mon Sep 17 00:00:00 2001 From: jeji1101 <40178078+jeji1101@users.noreply.github.com> Date: Wed, 18 Jul 2018 11:16:21 -0700 Subject: [PATCH 25/31] Modify Cognitive Search Swagger (#3386) * Address CR comments * Address CR comment * Address PR comments in C# * Fix syntax error * Address CR comments --- .../2017-11-11-preview/searchservice.json | 117 +++++++++++------- 1 file changed, 70 insertions(+), 47 deletions(-) diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json index 0334273c8355..2e8b5d10bcfd 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json @@ -573,9 +573,9 @@ "x-ms-examples": { "SearchServiceGetSkillset": { "$ref": "./examples/SearchServiceGetSkillset.json" } }, - "description": "Retrieves a Cognitive Search skillset in an Azure Search service.", + "description": "Retrieves a cognitive skillset in an Azure Search service.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" }, "parameters": [ { @@ -608,9 +608,9 @@ "x-ms-examples": { "SearchServiceCreateOrUpdateSkillset": { "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" } }, - "description": "Creates a new Cognitive Search skillset in an Azure Search service.", + "description": "Creates a new cognitive skillset in an Azure Search service.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" }, "parameters": [ { @@ -627,7 +627,7 @@ "schema": { "$ref": "#/definitions/Skillset" }, - "description": "The skillset containing one or more Cognitive Search skills to create or update in an Azure Search service." + "description": "The skillset containing one or more cognitive skills to create or update in an Azure Search service." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -661,9 +661,9 @@ "x-ms-examples": { "SearchServiceDeleteSkillset": { "$ref": "./examples/SearchServiceDeleteSkillset.json" } }, - "description": "Deletes a Cognitive Search skillset in an Azure Search service.", + "description": "Deletes a cognitive skillset in an Azure Search service.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" }, "parameters": [ { @@ -698,9 +698,9 @@ "x-ms-examples": { "SearchServiceListSkillsets": { "$ref": "./examples/SearchServiceListSkillsets.json" } }, - "description": "List all Cognitive Search skillsets in an Azure Search service.", + "description": "List all cognitive skillsets in an Azure Search service.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" }, "parameters": [ { @@ -728,7 +728,7 @@ "$ref": "./examples/SearchServiceCreateSkillset.json" } }, - "description": "Creates a new Cognitive Search skillset in an Azure Search service.", + "description": "Creates a new cognitive skillset in an Azure Search service.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" }, @@ -740,7 +740,7 @@ "schema": { "$ref": "#/definitions/Skillset" }, - "description": "The skillset containing one or more Cognitive Search skills to create in an Azure Search service." + "description": "The skillset containing one or more cognitive skills to create in an Azure Search service." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -3431,6 +3431,10 @@ "dataSourceName": { "type": "string", "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the cognitive skillset executing with this indexer." }, "targetIndexName": { "type": "string", @@ -3453,6 +3457,16 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } }, "disabled": { "x-ms-client-name": "IsDisabled", @@ -4183,7 +4197,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" }, - "description": "A list of Cognitive Search skills." + "description": "A list of cognitive skills." }, "Skill": { "discriminator": "@odata.type", @@ -4197,21 +4211,21 @@ }, "context": { "type": "string", - "description": "The context of the skill." + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content)." }, "inputs": { "type": "array", "items": { "$ref": "#/definitions/InputFieldMappingEntry" }, - "description": "The inputs of the skill." + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." }, "outputs": { "type": "array", "items": { "$ref": "#/definitions/OutputFieldMappingEntry" }, - "description": "The outputs of the skill." + "description": "The output of a skill is either a field in an Azure Search index, or a value that can be consumed as an input by another skill." } }, "required": [ @@ -4242,16 +4256,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the output." + "description": "The name of the output defined by the skill." }, "targetName": { "type": "string", - "description": "The target name of the output." + "description": "The target name of the output. It is optional and default to name." } }, - "required": ["name", - "targetName"], - "description": "output field mapping for a skill." + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." }, "KeyPhraseExtractionSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", @@ -4266,13 +4284,14 @@ "maxKeyPhraseCount": { "type": "integer", "format": "int32", - "x-nullable": true + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." } }, "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" }, - "description": "Text analytics key phrase extraction." + "description": "A skill that uses text analytics for key phrase extraction." }, "OcrSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", @@ -4298,7 +4317,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" }, - "description": "The skill extracts text from image files." + "description": "A skill that extracts text from image files." }, "ImageAnalysisSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", @@ -4313,14 +4332,16 @@ "visualFeatures": { "type": "array", "items": { - "$ref": "#/definitions/VisualFeatures" + "$ref": "#/definitions/VisualFeature", + "x-nullable": false }, "description": "A list of visual features." }, "details": { "type": "array", "items": { - "$ref": "#/definitions/Details" + "$ref": "#/definitions/ImageDetail", + "x-nullable": false }, "description": "A string indicating which domain-specific details to return." } @@ -4328,7 +4349,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" }, - "description": "The skill analyzes image files. It extracts a rich set of visual features based on the image content." + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." }, "LanguageDetectionSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", @@ -4338,7 +4359,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" }, - "description": "The skill detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the strength of the analysis." + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." }, "ShaperSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", @@ -4348,7 +4369,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" }, - "description": "The skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." }, "MergeSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", @@ -4359,18 +4380,18 @@ "insertPreTag": { "type": "string", "default": " ", - "description": "The tag indicates the start of the merged text." + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." }, "insertPostTag": { "type": "string", "default": " ", - "description": "The tag indicates the end of the merged text." + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." } }, "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" }, - "description": "The skill for merging the text." + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." }, "NamedEntityRecognitionSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", @@ -4381,7 +4402,8 @@ "categories": { "type": "array", "items": { - "$ref": "#/definitions/Categories" + "$ref": "#/definitions/NamedEntityCategory", + "x-nullable": false }, "description": "A list of named entity categories." }, @@ -4415,7 +4437,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" }, - "description": "Text analytics sentiment analysis." + "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." }, "SplitSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", @@ -4429,19 +4451,20 @@ }, "textSplitMode": { "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, "description": "A value indicating which split mode to perform." }, "maximumPageLength": { "type": "integer", "format": "int32", "x-nullable": true, - "description": "The desired maximum page length." + "description": "The desired maximum page length. Default is 10000." } }, "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" }, - "description": "The skill to split text." + "description": "A skill to split a string into chunks of text." }, "WebApiSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", @@ -4451,7 +4474,7 @@ "properties": { "uri": { "type": "string", - "description": "The url for the Web Api." + "description": "The url for the Web API." }, "httpHeaders": { "$ref": "#/definitions/WebApiHttpHeaders", @@ -4464,13 +4487,13 @@ "timeout": { "type": "string", "format": "duration", - "description": "The desired timeout for the request." + "description": "The desired timeout for the request. Default is 30 seconds." }, "batchSize": { "type": "integer", "format": "int32", "x-nullable": true, - "description": "The desired batch size." + "description": "The desired batch size which indicates number of documents." } }, "required": [ @@ -4479,7 +4502,7 @@ "externalDocs": { "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-interface" }, - "description": "The customized Web Api skill." + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." }, "WebApiHttpHeaders": { "properties": { @@ -4504,7 +4527,7 @@ "description": "The skillsets defined in the Search service." } }, - "description": "Response from a List skillset request. If successful, it includes the full definitions of all skillsets." + "description": "Response from a list Skillset request. If successful, it includes the full definitions of all skillsets." }, "TextExtractionAlgorithm": { "type": "string", @@ -4530,7 +4553,7 @@ }, "description": "A value indicating which split mode to perform." }, - "VisualFeatures": { + "VisualFeature": { "type": "string", "enum": [ "categories", @@ -4541,24 +4564,24 @@ "color" ], "x-ms-enum": { - "name": "VisualFeatures", + "name": "VisualFeature", "modelAsString": false }, "description": "The strings indicating what visual feature types to return." }, - "Details": { + "ImageDetail": { "type": "string", "enum": [ "celebrities", "landmarks" ], "x-ms-enum": { - "name": "Details", + "name": "ImageDetail", "modelAsString": false }, "description": "A string indicating which domain-specific details to return." }, - "Categories": { + "NamedEntityCategory": { "type": "string", "enum": [ "location", @@ -4566,7 +4589,7 @@ "person" ], "x-ms-enum": { - "name": "Categories", + "name": "NamedEntityCategory", "modelAsString": false }, "description": "A string indicating which named entity categories to return." @@ -4836,4 +4859,4 @@ "x-ms-parameter-location": "client" } } -} \ No newline at end of file +} From 96d6b7f529f7a8041e42b419ad6be120ac48aeee Mon Sep 17 00:00:00 2001 From: Elena Lakhno Date: Wed, 18 Jul 2018 11:29:55 -0700 Subject: [PATCH 26/31] Revert AccessUri description to make it correspond to server response (#3433) --- .../stable/2018-04-01/disk.json | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json index 7d4ae298e21f..714d1630d3dd 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json @@ -1038,6 +1038,26 @@ "description": "Data used for requesting a SAS." }, "AccessUri": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessUriOutput", + "description": "Operation output data (raw JSON)" + } + }, + "description": "A disk access SAS uri." + }, + "AccessUriOutput": { + "properties": { + "output": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessUriRaw", + "description": "Operation output data (raw JSON)" + } + }, + "description": "Azure properties, including output." + }, + "AccessUriRaw": { "properties": { "accessSAS": { "readOnly": true, From 59180bb07cd31c599a73373b69acb761a3d2b336 Mon Sep 17 00:00:00 2001 From: Nicholas King Date: Wed, 18 Jul 2018 11:47:42 -0700 Subject: [PATCH 27/31] Update default package version for WebSiteManagementClient (#3415) * Updated webapps swagger with restore deleted site APIs * Update default package version for WebSiteManagementClient --- specification/web/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index df60814ed1a6..0be882ab5141 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Web API. title: WebSiteManagementClient description: WebSite Management Client openapi-type: arm -tag: package-2016-09 +tag: package-2018-02 ``` ### Tag: package-2018-02 From 2510141840fc336cbe69418c3e34c4f82993c387 Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 12:35:04 -0700 Subject: [PATCH 28/31] Add Tumbling Window dependsOn property to Trigger.json for Tumbling Window Trigger and self-dependent Tumbling Window Trigger --- .../entityTypes/Trigger.json | 115 +++++++++++++++++- 1 file changed, 114 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 921b0da9c4da..63e97444bd01 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,7 +381,14 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - } + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } + } }, "required": [ "frequency", @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 8d8f0a3ec4d9e04a555b5b4f7fecec7417290552 Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 14:43:59 -0700 Subject: [PATCH 29/31] revert tumbling window dependsOn property under preview, and apply same changes to stable --- .../entityTypes/Trigger.json | 115 +----------------- .../2018-06-01/entityTypes/Trigger.json | 113 +++++++++++++++++ 2 files changed, 114 insertions(+), 114 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 63e97444bd01..921b0da9c4da 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,14 +381,7 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - }, - "dependsOn": { - "type": "array", - "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", - "items": { - "$ref": "#/definitions/DependencyReference" - } - } + } }, "required": [ "frequency", @@ -429,112 +422,6 @@ "maximum": 86400 } } - }, - "TriggerReference": { - "description": "Trigger reference type.", - "type": "object", - "properties": { - "type": { - "description": "Trigger reference type.", - "type": "string", - "enum": [ - "TriggerReference" - ] - }, - "referenceName": { - "description": "Reference trigger name.", - "type": "string" - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "DependencyReference": { - "description": "Referenced dependency.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "description": "The type of dependency reference.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "TriggerDependencyReference": { - "description": "Trigger referenced dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "referenceTrigger": { - "description": "Referenced trigger.", - "$ref": "#/definitions/TriggerReference" - } - }, - "required": [ - "referenceTrigger" - ] - }, - "TumblingWindowTriggerDependencyReference": { - "description": "Referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TriggerDependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - } - }, - "SelfDependencyTumblingWindowTriggerReference": { - "description": "Self referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - }, - "required": [ - "offset" - ] } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json index eed541ff50d3..737431fcffe8 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json @@ -381,6 +381,13 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } } }, "required": [ @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 8508d87c1af45a8faca762bcc6bf00a8a62d8c37 Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 12:35:04 -0700 Subject: [PATCH 30/31] Add Tumbling Window dependsOn property to Trigger.json for Tumbling Window Trigger and self-dependent Tumbling Window Trigger --- .../entityTypes/Trigger.json | 115 +++++++++++++++++- 1 file changed, 114 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 921b0da9c4da..63e97444bd01 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,7 +381,14 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - } + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } + } }, "required": [ "frequency", @@ -422,6 +429,112 @@ "maximum": 86400 } } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ] + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] } } } From 6c47dfcd5d3cf866754f3e5a06489f107ba74dc3 Mon Sep 17 00:00:00 2001 From: haoyingl Date: Fri, 13 Jul 2018 14:43:59 -0700 Subject: [PATCH 31/31] revert tumbling window dependsOn property under preview, and apply same changes to stable --- .../entityTypes/Trigger.json | 115 +----------------- 1 file changed, 1 insertion(+), 114 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 63e97444bd01..921b0da9c4da 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -381,14 +381,7 @@ "retryPolicy": { "$ref": "#/definitions/RetryPolicy", "description": "Retry policy that will be applied for failed pipeline runs." - }, - "dependsOn": { - "type": "array", - "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", - "items": { - "$ref": "#/definitions/DependencyReference" - } - } + } }, "required": [ "frequency", @@ -429,112 +422,6 @@ "maximum": 86400 } } - }, - "TriggerReference": { - "description": "Trigger reference type.", - "type": "object", - "properties": { - "type": { - "description": "Trigger reference type.", - "type": "string", - "enum": [ - "TriggerReference" - ] - }, - "referenceName": { - "description": "Reference trigger name.", - "type": "string" - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "DependencyReference": { - "description": "Referenced dependency.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "description": "The type of dependency reference.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "TriggerDependencyReference": { - "description": "Trigger referenced dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "referenceTrigger": { - "description": "Referenced trigger.", - "$ref": "#/definitions/TriggerReference" - } - }, - "required": [ - "referenceTrigger" - ] - }, - "TumblingWindowTriggerDependencyReference": { - "description": "Referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TriggerDependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - } - }, - "SelfDependencyTumblingWindowTriggerReference": { - "description": "Self referenced tumbling window trigger dependency.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DependencyReference" - } - ], - "properties": { - "offset": { - "description": "Timespan applied to the start time of a tumbling window when evaluating dependency, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - }, - "size": { - "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used, .Net timespan format.", - "type": "string", - "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", - "minLength": 8, - "maxLength": 15 - } - }, - "required": [ - "offset" - ] } } }