diff --git a/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json b/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json index 6cccb01b0b35..2643b742eba8 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json @@ -114,8 +114,6 @@ { "$ref": "./definitions.json#/parameters/clientRequestId" }, - { - "parameters": [ { "name": "$skip", "in": "query", diff --git a/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationRun.json b/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationRun.json index 1f1963dafc62..ca5fb4f6fcc1 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/2017-05-15-preview/softwareUpdateConfigurationRun.json @@ -112,8 +112,6 @@ { "$ref": "#/parameters/clientRequestId" }, - { - "parameters": [ { "name": "$skip", "in": "query", diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json index 407b2cc11d5b..000a8b1047c1 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json @@ -10391,7 +10391,17 @@ ], "x-ms-enum": { "name": "OSType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "linux", + "description": "The Linux operating system." + }, + { + "value": "windows", + "description": "The Windows operating system." + } + ] } } }, @@ -10410,7 +10420,13 @@ ], "x-ms-enum": { "name": "AccessScope", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "job", + "description": "Grants access to perform all operations on the job containing the task." + } + ] } }, "title": "The Batch resources to which the token grants access.", @@ -10773,7 +10789,17 @@ ], "x-ms-enum": { "name": "CertificateFormat", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "pfx", + "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain." + }, + { + "value": "cer", + "description": "The certificate is a base64-encoded X.509 certificate." + } + ] } }, "password": { @@ -11043,7 +11069,7 @@ "jobAction": { "type": "string", "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'.", - "description": "Values are:\n\n none - Take no action.\n disable - Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue.\n terminate - Terminate the job. The terminateReason in the job's executionInfo is set to \"TaskFailed\". The default is none for exit code 0 and terminate for all other exit conditions.\n\n If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "none", "disable", @@ -11051,20 +11077,44 @@ ], "x-ms-enum": { "name": "JobAction", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Take no action." + }, + { + "value": "disable", + "description": "Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue." + }, + { + "value": "terminate", + "description": "Terminate the job. The terminateReason in the job's executionInfo is set to \"TaskFailed\"." + } + ] } }, "dependencyAction": { "type": "string", "title": "An action that the Batch service performs on tasks that depend on this task.", - "description": "Values are:\n\n satisfy - Satisfy the task's dependencies.\n block - Block the task's dependencies.\n\n The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an erro and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "satisfy", "block" ], "x-ms-enum": { "name": "DependencyAction", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "satisfy", + "description": "Satisfy the task's dependencies." + }, + { + "value": "block", + "description": "Block the task's dependencies." + } + ] } } }, @@ -11075,14 +11125,24 @@ "scope": { "type": "string", "title": "The scope for the auto user", - "description": "Values are:\n\n pool - specifies that the task runs as the common auto user account which is created on every node in a pool.\n task - specifies that the service should create a new user for the task.\n The default value is task.", + "description": "The default value is task.", "enum": [ "task", "pool" ], "x-ms-enum": { "name": "AutoUserScope", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "value": "pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] } }, "elevationLevel": { @@ -11379,14 +11439,24 @@ "properties": { "nodeFillType": { "type": "string", - "title": "How tasks are distributed across compute nodes in a pool. Values are:\n\n pack - As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.\n spread - Tasks should be assigned evenly across all nodes in the pool.", + "title": "How tasks are distributed across compute nodes in a pool.", "enum": [ "spread", "pack" ], "x-ms-enum": { "name": "ComputeNodeFillType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "value": "pack", + "description": "As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." + } + ] } } }, @@ -11453,14 +11523,26 @@ "storeLocation": { "type": "string", "title": "The location of the certificate store on the compute node into which to install the certificate.", - "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", + "description": "The default value is currentuser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", "enum": [ - "currentUser", - "localMachine" + "currentuser", + "localmachine" ], "x-ms-enum": { "name": "CertificateStoreLocation", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "currentuser", + "description": "Certificates should be installed to the CurrentUser certificate store.", + "name": "currentUser" + }, + { + "value": "localmachine", + "description": "Certificates should be installed to the LocalMachine certificate store.", + "name": "localMachine" + } + ] } }, "storeName": { @@ -11474,17 +11556,33 @@ "type": "string", "x-nullable": false, "enum": [ - "startTask", + "starttask", "task", - "remoteUser" + "remoteuser" ], "x-ms-enum": { "name": "CertificateVisibility", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "starttask", + "description": "The certificate should be visible to the user account under which the start task is run.", + "name": "startTask" + }, + { + "value": "task", + "description": "The certificate should be visibile to the user accounts under which job tasks are run." + }, + { + "value": "remoteuser", + "description": "The certificate should be visibile to the user accounts under which users remotely access the node.", + "name": "remoteUser" + } + ] } }, "title": "Which user accounts on the compute node should have access to the private data of the certificate.", - "description": "Values are:\n\n starttask - The user account under which the start task is run.\n task - The accounts under which job tasks are run.\n remoteuser - The accounts under which users remotely access the node.\n\n You can specify more than one visibility in this collection. The default is all accounts." + "description": "You can specify more than one visibility in this collection. The default is all accounts." } }, "required": [ "thumbprint", "thumbprintAlgorithm" ], @@ -11636,14 +11734,24 @@ "poolLifetimeOption": { "type": "string", "title": "The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools.", - "description": "When the pool lifetime is jobSchedule the pool exists for the lifetime of the job schedule. The Batch Service creates the pool when it creates the first job on the schedule. You may apply this option only to job schedules, not to jobs. When the pool lifetime is job the pool exists for the lifetime of the job to which it is dedicated. The Batch service creates the pool when it creates the job. If the 'job' option is applied to a job schedule, the Batch service creates a new auto pool for every job created on the schedule.", "enum": [ - "jobSchedule", + "jobschedule", "job" ], "x-ms-enum": { "name": "PoolLifetimeOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "jobschedule", + "description": "The pool exists for the lifetime of the job schedule. The Batch Service creates the pool when it creates the first job on the schedule. You may apply this option only to job schedules, not to jobs.", + "name": "jobSchedule" + }, + { + "value": "job", + "description": "The pool exists for the lifetime of the job to which it is dedicated. The Batch service creates the pool when it creates the job. If the 'job' option is applied to a job schedule, the Batch service creates a new auto pool for every job created on the schedule." + } + ] } }, "keepAlive": { @@ -11693,12 +11801,12 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in a job created under this schedule are in the completed state.", - "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. The default is noAction.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", "$ref": "#/definitions/OnAllTasksComplete" }, "onTaskFailure": { "title": "The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error.", - "description": "The default is noAction.", + "description": "The default is noaction.", "$ref": "#/definitions/OnTaskFailure" }, "constraints": { @@ -12033,7 +12141,7 @@ "terminateReason": { "type": "string", "title": "A string describing the reason the job ended.", - "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminateJob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminateJob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." + "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." } }, "required": [ "startTime" ], @@ -12132,12 +12240,12 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "noAction - do nothing. The job remains active unless terminated or disabled by some other means. terminateJob - terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noAction.", + "description": "The default is noaction.", "$ref": "#/definitions/OnAllTasksComplete" }, "onTaskFailure": { "title": "The action the Batch service should take when any task in the job fails.", - "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. noAction - do nothing. performExitOptionsJobAction - take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", "$ref": "#/definitions/OnTaskFailure" }, "metadata": { @@ -12210,12 +12318,12 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. Permitted values are: noAction - do nothing. The job remains active unless terminated or disabled by some other means. terminateJob - terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noAction.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", "$ref": "#/definitions/OnAllTasksComplete" }, "onTaskFailure": { "title": "The action the Batch service should take when any task in the job fails.", - "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. noAction - do nothing. performExitOptionsJobAction - take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", "$ref": "#/definitions/OnTaskFailure" }, "metadata": { @@ -12311,14 +12419,23 @@ "state": { "type": "string", "title": "The current state of the Job Preparation task on the compute node.", - "description": "Values are:\n\n running - the task is currently running (including retrying).\n completed - the task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures).", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "JobPreparationTaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures)." + } + ] } }, "taskRootDirectory": { @@ -12383,14 +12500,23 @@ "state": { "type": "string", "title": "The current state of the Job Release task on the compute node.", - "description": "Values are:\n\n running - the task is currently running (including retrying).\n completed - the task has exited, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures).", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "JobReleaseTaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures)." + } + ] } }, "taskRootDirectory": { @@ -12498,14 +12624,23 @@ "validationStatus": { "type": "string", "title": "Whether the task counts have been validated.", - "description": "If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks.", "enum": [ "validated", "unvalidated" ], "x-ms-enum": { "name": "TaskCountValidationStatus", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "validated", + "description": "The Batch service has validated the state counts against the task states as reported in the List Tasks API." + }, + { + "value": "unvalidated", + "description": "The Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks." + } + ] } } }, @@ -12628,7 +12763,7 @@ "properties": { "caching": { "title": "The type of caching to enable for the OS disk.", - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", "$ref": "#/definitions/CachingType" } }, @@ -12655,7 +12790,7 @@ "caching": { "$ref": "#/definitions/CachingType", "title": "The type of caching to be enabled for the data disks.", - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." }, "diskSizeGB": { "type": "integer", @@ -12664,7 +12799,7 @@ }, "storageAccountType": { "title": "The storage account type to be used for the data disk.", - "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage.", + "description": "If omitted, the default is \"standard_lrs\".", "$ref": "#/definitions/StorageAccountType" } }, @@ -12678,26 +12813,54 @@ "type": "string", "title": "The storage account type for use in creating data disks.", "enum": [ - "Standard_LRS", - "Premium_LRS" + "standard_lrs", + "premium_lrs" ], "x-ms-enum": { "name": "StorageAccountType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "standard_lrs", + "description": "The data disk should use standard locally redundant storage.", + "name": "StandardLRS" + }, + { + "value": "premium_lrs", + "description": "The data disk should use premium locally redundant storage.", + "name": "PremiumLRS" + } + ] } }, "CachingType": { "type": "string", "title": "The type of caching to enable for the disk.", - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", "enum": [ "none", - "readOnly", - "readWrite" + "readonly", + "readwrite" ], "x-ms-enum": { "name": "CachingType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "readonly", + "description": "The caching mode for the disk is read only.", + "name": "readOnly" + }, + { + "value": "readwrite", + "description": "The caching mode for the disk is read and write.", + "name": "readWrite" + } + ] } }, "VirtualMachineConfiguration": { @@ -12726,7 +12889,7 @@ "$ref": "#/definitions/DataDisk" }, "title": "The configuration for data disks attached to the comptue nodes in the pool.", - "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated." + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." }, "licenseType": { "type": "string", @@ -12767,13 +12930,18 @@ "type": { "type": "string", "title": "The container technology to be used.", - "description": "Values are:\n\n docker - Docker will be used to launch the containers.", "enum": [ "docker" ], "x-ms-enum": { "name": "ContainerType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "docker", + "description": "Docker will be used to launch the containers." + } + ] } }, "containerImageNames": { @@ -12850,7 +13018,6 @@ "state": { "type": "string", "title": "The current state of the pool.", - "description": "Values are:\n\n active - The pool is available to run tasks subject to the availability of compute nodes.\n deleting - The user has requested that the pool be deleted, but the delete operation has not yet completed.\n upgrading - The user has requested that the operating system of the pool's nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed.", "enum": [ "active", "deleting", @@ -12858,7 +13025,21 @@ ], "x-ms-enum": { "name": "PoolState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "value": "deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + }, + { + "value": "upgrading", + "description": "The user has requested that the operating system of the pool's nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed." + } + ] } }, "stateTransitionTime": { @@ -12869,7 +13050,6 @@ "allocationState": { "type": "string", "title": "Whether the pool is resizing.", - "description": "Values are:\n\n steady - The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes.\n resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool.\n stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed.", "enum": [ "steady", "resizing", @@ -12877,7 +13057,21 @@ ], "x-ms-enum": { "name": "AllocationState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "value": "resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "value": "stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] } }, "allocationStateTransitionTime": { @@ -13655,13 +13849,31 @@ "status": { "type": "string", "title": "The status of the add task request.", - "description": "Values are:\n\n success - Task was added successfully.\n clienterror - Task failed to add due to a client error and should not be retried without modifying the request as appropriate.\n servererror - Task failed to add due to a server error and can be retried without modification.", "enum": [ "success", - "clientError", - "serverError" + "clienterror", + "servererror" ], - "x-ms-enum": { "name": "TaskAddStatus" } + "x-ms-enum": { + "name": "TaskAddStatus", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The task was added successfully." + }, + { + "value": "clienterror", + "description": "The task failed to add due to a client error and should not be retried without modifying the request as appropriate.", + "name": "clientError" + }, + { + "value": "servererror", + "description": "Task failed to add due to a server error and can be retried without modification.", + "name": "serverError" + } + ] + } }, "taskId": { "type": "string", @@ -13831,14 +14043,23 @@ "state": { "type": "string", "title": "The state of the start task on the compute node.", - "description": "Values are:\n\n running - The start task is currently running.\n completed - The start task has exited with exit code 0, or the start task has failed and the retry limit has reached, or the start task process did not run due to task preparation errors (such as resource file download failures).", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "StartTaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The start task is currently running." + }, + { + "value": "completed", + "description": "The start task has exited with exit code 0, or the start task has failed and the retry limit has reached, or the start task process did not run due to task preparation errors (such as resource file download failures)." + } + ] } }, "startTime": { @@ -13924,7 +14145,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "Values are:\n\n idle - The node is not currently running a task.\n rebooting - The node is rebooting.\n reimaging - The node is reimaging.\n running - The node is running one or more tasks (other than a start task).\n unusable - The node cannot be used for task execution due to errors.\n creating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool.\n starting - the Batch service is starting on the underlying virtual machine.\n waitingforstarttask - The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.\n starttaskfailed - The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.\n unknown - The Batch service has lost contact with the node, and does not know its true state.\n leavingpool - The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.\n offline - The node is not currently running a task, and scheduling of new tasks to the node is disabled.\n preempted - The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", @@ -13933,29 +14154,95 @@ "unusable", "creating", "starting", - "waitingForStartTask", - "startTaskFailed", + "waitingforstarttask", + "starttaskfailed", "unknown", - "leavingPool", + "leavingpool", "offline", "preempted" ], "x-ms-enum": { "name": "ComputeNodeState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "idle", + "description": "The node is not currently running a task." + }, + { + "value": "rebooting", + "description": "The node is rebooting." + }, + { + "value": "reimaging", + "description": "The node is reimaging." + }, + { + "value": "running", + "description": "The node is running one or more tasks (other than a start task)." + }, + { + "value": "unusable", + "description": "The node cannot be used for task execution due to errors." + }, + { + "value": "creating", + "description": "The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool." + }, + { + "value": "starting", + "description": "The Batch service is starting on the underlying virtual machine." + }, + { + "value": "waitingforstarttask", + "description": "The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.", + "name": "waitingForStartTask" + }, + { + "value": "starttaskfailed", + "description": "The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.", + "name": "startTaskFailed" + }, + { + "value": "unknown", + "description": "The Batch service has lost contact with the node, and does not know its true state." + }, + { + "value": "leavingpool", + "description": "The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.", + "name": "leavingPool" + }, + { + "value": "offline", + "description": "The node is not currently running a task, and scheduling of new tasks to the node is disabled." + }, + { + "value": "preempted", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + } + ] } }, "schedulingState": { "type": "string", "title": "Whether the compute node is available for task scheduling.", - "description": "Values are:\n\n enabled - Tasks can be scheduled on the node.\n disabled - No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "SchedulingState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "enabled", + "description": "Tasks can be scheduled on the node." + }, + { + "value": "disabled", + "description": "No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled." + } + ] } }, "stateTransitionTime": { @@ -14068,16 +14355,8 @@ "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." }, "protocol": { - "type": "string", - "title": "The protocol of the endpoint.", - "enum": [ - "tcp", - "udp" - ], - "x-ms-enum": { - "name": "InboundEndpointProtocol", - "modelAsString": false - } + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." }, "backendPort": { "type": "integer", @@ -14089,13 +14368,13 @@ "type": "integer", "format": "int32", "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", - "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." }, "frontendPortRangeEnd": { "type": "integer", "format": "int32", "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", - "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." }, "networkSecurityGroupRules": { "type": "array", @@ -14126,7 +14405,17 @@ ], "x-ms-enum": { "name": "NetworkSecurityGroupRuleAccess", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "allow", + "description": "Allow access." + }, + { + "value": "deny", + "description": "Deny access." + } + ] } }, "sourceAddressPrefix": { @@ -14158,16 +14447,8 @@ "title": "The name of the endpoint." }, "protocol": { - "type": "string", - "title": "The protocol of the endpoint.", - "enum": [ - "tcp", - "udp" - ], - "x-ms-enum": { - "name": "InboundEndpointProtocol", - "modelAsString": false - } + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." }, "publicIPAddress": { "type": "string", @@ -14305,7 +14586,6 @@ "disableTasks": { "type": "string", "title": "What to do with active tasks associated with the job.", - "description": "Values are:\n\n requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled.\n terminate - Terminate running tasks. The tasks will not run again.\n wait - Allow currently running tasks to complete.", "enum": [ "requeue", "terminate", @@ -14313,7 +14593,21 @@ ], "x-ms-enum": { "name": "DisableJobOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running tasks and requeue them. The tasks will run again when the job is enabled." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again." + }, + { + "value": "wait", + "description": "Allow currently running tasks to complete." + } + ] } } }, @@ -14339,7 +14633,7 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminateJob to noAction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "$ref": "#/definitions/OnAllTasksComplete" }, "constraints": { @@ -14391,7 +14685,7 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "If omitted, the completion behavior is set to noAction. If the current value is terminateJob, this is an error because a job's completion behavior may not be changed from terminateJob to noAction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", + "description": "If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", "$ref": "#/definitions/OnAllTasksComplete" } }, @@ -14566,16 +14860,36 @@ "nodeRebootOption": { "type": "string", "title": "When to reboot the compute node and what to do with currently running tasks.", - "description": "Values are:\n\n requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Restart the node as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed.\n retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion", - "retainedData" + "taskcompletion", + "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeRebootOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the node as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired.", + "name": "retainedData" + } + ] } } }, @@ -14586,16 +14900,36 @@ "nodeReimageOption": { "type": "string", "title": "When to reimage the compute node and what to do with currently running tasks.", - "description": "Values are:\n\n requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Reimage the node as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed.\n retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion", - "retainedData" + "taskcompletion", + "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeReimageOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the node as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired.", + "name": "retainedData" + } + ] } } }, @@ -14606,15 +14940,30 @@ "nodeDisableSchedulingOption": { "type": "string", "title": "What to do with currently running tasks when disabling task scheduling on the compute node.", - "description": "Values are:\n\n requeue - Terminate running task processes and requeue the tasks. The tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter offline state as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Enter offline state as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Enter offline state when all tasks have completed.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion" + "taskcompletion" ], "x-ms-enum": { "name": "DisableComputeNodeSchedulingOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter offline state as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Enter offline state when all tasks have completed.", + "name": "taskCompletion" + } + ] } } }, @@ -14693,7 +15042,7 @@ "properties": { "uploadCondition": { "title": "The conditions under which the task output file or set of files should be uploaded.", - "description": "The default is taskCompletion.", + "description": "The default is taskcompletion.", "$ref": "#/definitions/OutputFileUploadCondition" } }, @@ -14749,34 +15098,57 @@ "CertificateState": { "type": "string", "title": "The state of the certificate.", - "description": "Values are:\n\n active - The certificate is available for use in pools.\n deleting - The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools.\n deletefailed - The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.", "enum": [ "active", "deleting", - "deleteFailed" + "deletefailed" ], "x-ms-enum": { "name": "CertificateState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The certificate is available for use in pools." + }, + { + "value": "deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "deletefailed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.", + "name": "deleteFailed" + } + ] } }, "ElevationLevel": { "type": "string", "title": "The elevation level of the user.", - "description": "Values are:\n\n nonAdmin - The user is a standard user without elevated access.\n admin - The user is a user with elevated access and operates with full Administrator permissions.", "enum": [ - "nonAdmin", + "nonadmin", "admin" ], "x-ms-enum": { "name": "ElevationLevel", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "nonadmin", + "description": "The user is a standard user without elevated access.", + "name": "nonAdmin" + }, + { + "value": "admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] } }, "JobScheduleState": { "type": "string", "title": "The state of the job schedule.", - "description": "Values are:\n\n active - The job schedule is active and will create jobs as per its schedule.\n disabled - The user has disabled the schedule. The scheduler will not initiate any new jobs will on this schedule, but any existing active job will continue to run.\n terminating - The schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new jobs for this schedule, nor is any existing job active.\n completed - The schedule has terminated, either by reaching its end time or by the user terminating it explicitly.\n deleting - The user has requested that the schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new jobs for this schedule, and will delete any existing jobs and tasks under the schedule, including any active job. The schedule will be deleted when all jobs and tasks under the schedule have been deleted.", "enum": [ "active", "completed", @@ -14786,13 +15158,34 @@ ], "x-ms-enum": { "name": "JobScheduleState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The job schedule is active and will create jobs as per its schedule." + }, + { + "value": "completed", + "description": "The schedule has terminated, either by reaching its end time or by the user terminating it explicitly." + }, + { + "value": "disabled", + "description": "The user has disabled the schedule. The scheduler will not initiate any new jobs will on this schedule, but any existing active job will continue to run." + }, + { + "value": "terminating", + "description": "The schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new jobs for this schedule, nor is any existing job active." + }, + { + "value": "deleting", + "description": "The user has requested that the schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new jobs for this schedule, and will delete any existing jobs and tasks under the schedule, including any active job. The schedule will be deleted when all jobs and tasks under the schedule have been deleted." + } + ] } }, "JobState": { "type": "string", "title": "The state of the job.", - "description": "Values are:\n\n active - the job is available to have tasks scheduled.\n disabling - a user has requested that the job be disabled, but the disable operation is still in progress (for example, waiting for tasks to terminate).\n disabled - a user has disabled the job. No tasks are running, and no new tasks will be scheduled.\n enabling - a user has requested that the job be enabled, but the enable operation is still in progress.\n terminating - the job is about to complete, either because a Job Manager task has completed or because the user has terminated the job, but the terminate operation is still in progress (for example, because Job Release tasks are running).\n completed - all tasks have terminated, and the system will not accept any more tasks or any further changes to the job.\n deleting - a user has requested that the job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running tasks).", "enum": [ "active", "disabling", @@ -14804,51 +15197,115 @@ ], "x-ms-enum": { "name": "JobState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The job is available to have tasks scheduled." + }, + { + "value": "disabling", + "description": "A user has requested that the job be disabled, but the disable operation is still in progress (for example, waiting for tasks to terminate)." + }, + { + "value": "disabled", + "description": "A user has disabled the job. No tasks are running, and no new tasks will be scheduled." + }, + { + "value": "enabling", + "description": "A user has requested that the job be enabled, but the enable operation is still in progress." + }, + { + "value": "terminating", + "description": "The job is about to complete, either because a Job Manager task has completed or because the user has terminated the job, but the terminate operation is still in progress (for example, because Job Release tasks are running)." + }, + { + "value": "completed", + "description": "All tasks have terminated, and the system will not accept any more tasks or any further changes to the job." + }, + { + "value": "deleting", + "description": "A user has requested that the job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running tasks)." + } + ] } }, "OnAllTasksComplete": { "type": "string", "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "Values are:\n\n noAction - do nothing. The job remains active unless terminated or disabled by some other means.\n terminateJob - terminate the job. The job's terminateReason is set to 'AllTasksComplete'.", "enum": [ - "noAction", - "terminateJob" + "noaction", + "terminatejob" ], "x-ms-enum": { "name": "OnAllTasksComplete", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "terminatejob", + "description": "Terminate the job. The job's terminateReason is set to 'AllTasksComplete'.", + "name": "terminateJob" + } + ] } }, "OnTaskFailure": { "type": "string", "title": "The action the Batch service should take when any task in the job fails.", - "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. Values are:\n\n noAction - do nothing.\n performExitOptionsJobAction - take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.)\n\n The default is noAction.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", "enum": [ - "noAction", - "performExitOptionsJobAction" + "noaction", + "performexitoptionsjobaction" ], "x-ms-enum": { "name": "OnTaskFailure", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "performexitoptionsjobaction", + "description": "Take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.)", + "name": "performExitOptionsJobAction" + } + ] } }, "ErrorCategory": { "type": "string", "title": "The category of the error.", "enum": [ - "userError", - "serverError" + "usererror", + "servererror" ], "x-ms-enum": { "name": "ErrorCategory", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "usererror", + "description": "The error is due to a user issue, such as misconfiguration.", + "name": "userError" + }, + { + "value": "servererror", + "description": "The error is due to an internal server issue.", + "name": "serverError" + } + ] } }, "TaskState": { "type": "string", "title": "The state of the task.", - "description": "Values are:\n\n active - The task is queued and able to run, but is not currently assigned to a compute node. A task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run.\n preparing - The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node.\n running - The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing.\n completed - The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated.", "enum": [ "active", "preparing", @@ -14857,13 +15314,30 @@ ], "x-ms-enum": { "name": "TaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The task is queued and able to run, but is not currently assigned to a compute node. A task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run." + }, + { + "value": "preparing", + "description": "The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node." + }, + { + "value": "running", + "description": "The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing." + }, + { + "value": "completed", + "description": "The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated." + } + ] } }, "SubtaskState": { "type": "string", "title": "The state of the subtask.", - "description": "Values are:\n\n preparing - The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will be eligible to be assigned to a different node.\n running - The subtask is running on a compute node.\n completed - The subtask is no longer eligible to run, usually because the subtask has finished successfully, or the subtask has finished unsuccessfully and has exhausted its retry limit. A subtask is also marked as completed if an error occurred launching the subtask, or when the task has been terminated.", "enum": [ "preparing", "running", @@ -14871,49 +15345,134 @@ ], "x-ms-enum": { "name": "SubtaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "preparing", + "description": "The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node." + }, + { + "value": "running", + "description": "The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing." + }, + { + "value": "completed", + "description": "The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated." + } + ] } }, "ComputeNodeDeallocationOption": { "type": "string", "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", - "description": "Values are:\n\n requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. Remove nodes as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Remove nodes as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.\n retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion", - "retainedData" + "taskcompletion", + "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeDeallocationOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.", + "name": "retainedData" + } + ] } }, "OutputFileUploadCondition": { "type": "string", "title": "The conditions under which a task output file or set of files should be uploaded.", - "description": "Values are:\n\n taskSuccess - Upload the file(s) only after the task process exits with an exit code of 0.\n taskFailure - Upload the file(s) only after the task process exits with a nonzero exit code.\n taskCompletion - Upload the file(s) after the task process exits, no matter what the exit code was.", "enum": [ - "taskSuccess", - "taskFailure", - "taskCompletion" + "tasksuccess", + "taskfailure", + "taskcompletion" ], "x-ms-enum": { "name": "OutputFileUploadCondition", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "tasksuccess", + "description": "Upload the file(s) only after the task process exits with an exit code of 0.", + "name": "taskSuccess" + }, + { + "value": "taskfailure", + "description": "Upload the file(s) only after the task process exits with a nonzero exit code.", + "name": "taskFailure" + }, + { + "value": "taskcompletion", + "description": "Upload the file(s) after the task process exits, no matter what the exit code was.", + "name": "taskCompletion" + } + ] } }, "TaskExecutionResult": { "type": "string", "title": "The result of task execution.", - "description": "Values are:\n\n success - The task ran successfully.\n failure - There was an error during processing of the task. The failure may have occurred before the task process was launched, while the task process was executing, or after the task process exited.", "enum": [ "success", "failure" ], "x-ms-enum": { "name": "TaskExecutionResult", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The task ran successfully.", + "name": "success" + }, + { + "value": "failure", + "description": "There was an error during processing of the task. The failure may have occurred before the task process was launched, while the task process was executing, or after the task process exited.", + "name": "failure" + } + ] + } + }, + "InboundEndpointProtocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "tcp", + "description": "Use TCP for the endpoint.", + "name": "tcp" + }, + { + "value": "udp", + "description": "Use UDP for the endpoint.", + "name": "udp" + } + ] } } }, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json index b8c00a4958dd..67568b3c318d 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json @@ -12,7 +12,7 @@ "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", - "state": "deleteFailed", + "state": "deletefailed", "stateTransitionTime": "2014-07-31T21:12:58.236Z", "previousState": "deleting", "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json index c49d999f6d94..fbd427639159 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json @@ -12,7 +12,7 @@ "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", - "state": "deleteFailed", + "state": "deletefailed", "stateTransitionTime": "2014-07-31T21:12:58.236Z", "previousState": "deleting", "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json index 24f1be80ddbd..770bdd8c2ece 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json @@ -89,7 +89,7 @@ { "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", - "storeLocation": "localMachine", + "storeLocation": "localmachine", "storeName": "Root", "visibility": [ "task" diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json index 1a5397235d37..9a1504f6c9f0 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json @@ -32,8 +32,8 @@ "poolId": "poolId", "terminateReason": "UserTerminate" }, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction" + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" } } } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json index 0cd145b3334d..3d418a5dbb5b 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json @@ -31,8 +31,8 @@ "startTime": "2016-11-19T00:05:25.3309105Z", "poolId": "poolId" }, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction" + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" } ] } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json index cff2e7b5220e..5963c206ac88 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json @@ -45,7 +45,7 @@ "userIdentity": { "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "runExclusive": true @@ -53,7 +53,7 @@ "poolInfo": { "autoPoolSpecification": { "autoPoolIdPrefix": "mypool", - "poolLifetimeOption": "jobSchedule", + "poolLifetimeOption": "jobschedule", "pool": { "vmSize": "small", "cloudServiceConfiguration": { @@ -96,7 +96,7 @@ { "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", - "storeLocation": "localMachine", + "storeLocation": "localmachine", "storeName": "Root", "visibility": [ "task" diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json index d58611df767a..990d879d4d20 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json @@ -20,8 +20,8 @@ "jobSpecification": { "priority": 0, "usesTaskDependencies": false, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction", + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", "constraints": { "maxWallClockTime": "P10675199DT2H48M5.4775807S", "maxTaskRetryCount": 0 diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json index 4b343e94048e..807886be4ef1 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json @@ -21,8 +21,8 @@ "jobSpecification": { "priority": 0, "usesTaskDependencies": false, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction", + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", "constraints": { "maxWallClockTime": "P10675199DT2H48M5.4775807S", "maxTaskRetryCount": 0 @@ -52,8 +52,8 @@ "jobSpecification": { "priority": 0, "usesTaskDependencies": false, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction", + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", "constraints": { "maxWallClockTime": "P10675199DT2H48M5.4775807S", "maxTaskRetryCount": 0 diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json index 36bd026a388d..9f77641967f7 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json @@ -28,7 +28,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json index 96ede9afe506..a6d8d4cd4013 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json @@ -29,7 +29,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, @@ -63,7 +63,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, @@ -97,7 +97,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json index 64f6ffc16dc1..8a97f2c53081 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json @@ -30,7 +30,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json index ab40e3523dd8..abf1070bba6f 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json @@ -31,7 +31,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json index 43d7fea5afa1..a0c773ea8e26 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json @@ -14,7 +14,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } } } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json index b36767f0538e..e8f13b7be097 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json @@ -21,7 +21,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } } } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json index 1b64cf66d686..02fecd7ae8a4 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json @@ -20,7 +20,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "multiInstanceSettings": { diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json index 832a0cb4d9b4..7aadb36bd7b8 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json @@ -21,7 +21,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "constraints": { @@ -46,7 +46,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "constraints": { diff --git a/specification/cognitiveservices/data-plane/EntitySearch/readme.md b/specification/cognitiveservices/data-plane/EntitySearch/readme.md index 93e2b5074d05..517681b1b463 100644 --- a/specification/cognitiveservices/data-plane/EntitySearch/readme.md +++ b/specification/cognitiveservices/data-plane/EntitySearch/readme.md @@ -26,6 +26,6 @@ These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) csharp: namespace: Microsoft.Azure.CognitiveServices.Search.EntitySearch - output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/Search/Generated/EntitySearch + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingEntitySearch/Generated/EntitySearch ``` diff --git a/specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json b/specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json new file mode 100644 index 000000000000..b3c7061240bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json @@ -0,0 +1,468 @@ +{ + "swagger": "2.0", + "info": { + "title": "Spell Check API", + "description": "The Spell Check API - V7 lets you check a text string for spelling and grammar errors.", + "version": "1.0" + }, + "parameters": { + "x-bingapis-sdk": { + "name": "X-BingApis-SDK", + "description": "Activate swagger compliance", + "x-ms-parameter-location": "method", + "required": true, + "type": "string", + "in": "header", + "x-ms-enum": { + "name": "XBingApisSDK", + "modelAsString": true + }, + "enum": [ + "true" + ] + } + }, + "host": "api.cognitive.microsoft.com", + "schemes": [ + "https" + ], + "basePath": "/bing/v7.0", + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/spellcheck": { + "post": { + "summary": "The Bing Spell Check API lets you perform contextual grammar and spell checking. Bing has developed a web-based spell-checker that leverages machine learning and statistical machine translation to dynamically train a constantly evolving and highly contextual algorithm. The spell-checker is based on a massive corpus of web searches and documents.", + "operationId": "SpellChecker", + "tags": [ + "SpellCheck" + ], + "consumes": [ + "application/x-www-form-urlencoded" + ], + "parameters": [ + { + "$ref": "#/parameters/x-bingapis-sdk" + }, + { + "name": "Accept", + "in": "header", + "description": "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.", + "required": false, + "type": "string" + }, + { + "name": "Accept-Language", + "x-ms-client-name": "AcceptLanguage", + "in": "header", + "description": "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the setLang query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the cc query parameter. Bing will use the first supported language it finds from the list, and combine that language with the cc parameter value to determine the market to return results for. If the list does not include a supported language, Bing will find the closest language and market that supports the request, and may use an aggregated or default market for the results instead of a specified one. You should use this header and the cc query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. A user interface string is a string that's used as a label in a user interface. There are very few user interface strings in the JSON response objects. Any links in the response objects to Bing.com properties will apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "Pragma", + "in": "header", + "description": "By default, Bing returns cached content, if available. To prevent Bing from returning cached content, set the Pragma header to no-cache (for example, Pragma: no-cache).", + "required": false, + "type": "string" + }, + { + "name": "User-Agent", + "x-ms-client-name": "UserAgent", + "in": "header", + "description": "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are strongly encouraged to always specify this header. The user-agent should be the same string that any commonly used browser would send. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientID", + "x-ms-client-name": "ClientId", + "in": "header", + "description": "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client IDā€™s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request.", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientIP", + "x-ms-client-name": "ClientIp", + "in": "header", + "description": "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.", + "required": false, + "type": "string" + }, + { + "name": "X-Search-Location", + "x-ms-client-name": "Location", + "in": "header", + "description": "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-Search-ClientIP header, but at a minimum, you should include this header.", + "required": false, + "type": "string" + }, + { + "name": "ActionType", + "in": "query", + "description": "A string that's used by logging to determine whether the request is coming from an interactive session or a page load. The following are the possible values. 1) Editā€”The request is from an interactive session 2) Loadā€”The request is from a page load", + "required": false, + "type": "string", + "enum": [ + "Edit", + "Load" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + { + "name": "AppName", + "in": "query", + "description": "The unique name of your app. The name must be known by Bing. Do not include this parameter unless you have previously contacted Bing to get a unique app name. To get a unique name, contact your Bing Business Development manager.", + "required": false, + "type": "string" + }, + { + "name": "cc", + "x-ms-client-name": "CountryCode", + "in": "query", + "description": "A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusiveā€”do not specify both.", + "required": false, + "type": "string" + }, + { + "name": "ClientMachineName", + "in": "query", + "description": "A unique name of the device that the request is being made from. Generate a unique value for each device (the value is unimportant). The service uses the ID to help debug issues and improve the quality of corrections.", + "required": false, + "type": "string" + }, + { + "name": "DocId", + "in": "query", + "description": "A unique ID that identifies the document that the text belongs to. Generate a unique value for each document (the value is unimportant). The service uses the ID to help debug issues and improve the quality of corrections.", + "required": false, + "type": "string" + }, + { + "name": "mkt", + "x-ms-client-name": "Market", + "in": "query", + "description": "The market where the results come from. You are strongly encouraged to always specify the market, if known. Specifying the market helps Bing route the request and return an appropriate and optimal response. This parameter and the cc query parameter are mutually exclusiveā€”do not specify both.", + "required": false, + "type": "string" + }, + { + "name": "SessionId", + "in": "query", + "description": "A unique ID that identifies this user session. Generate a unique value for each user session (the value is unimportant). The service uses the ID to help debug issues and improve the quality of corrections", + "required": false, + "type": "string" + }, + { + "name": "SetLang", + "in": "query", + "description": "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the Accept-Language header are mutually exclusiveā€”do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "UserId", + "in": "query", + "description": "A unique ID that identifies the user. Generate a unique value for each user (the value is unimportant). The service uses the ID to help debug issues and improve the quality of corrections.", + "required": false, + "type": "string" + }, + { + "name": "Mode", + "in": "formData", + "description": "The type of spelling and grammar checks to perform. The following are the possible values (the values are case insensitive). The default is Proof. 1) Proofā€”Finds most spelling and grammar mistakes. 2) Spellā€”Finds most spelling mistakes but does not find some of the grammar errors that Proof catches (for example, capitalization and repeated words)", + "required": false, + "type": "string", + "enum": [ + "Proof", + "Spell" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true + } + }, + { + "name": "PreContextText", + "in": "formData", + "description": "A string that gives context to the text string. For example, the text string petal is valid. However, if you set preContextText to bike, the context changes and the text string becomes not valid. In this case, the API suggests that you change petal to pedal (as in bike pedal). This text is not checked for grammar or spelling errors. The combined length of the text string, preContextText string, and postContextText string may not exceed 10,000 characters. You may specify this parameter in the query string of a GET request or in the body of a POST request.", + "required": false, + "type": "string" + }, + { + "name": "PostContextText", + "in": "formData", + "description": "A string that gives context to the text string. For example, the text string read is valid. However, if you set postContextText to carpet, the context changes and the text string becomes not valid. In this case, the API suggests that you change read to red (as in red carpet). This text is not checked for grammar or spelling errors. The combined length of the text string, preContextText string, and postContextText string may not exceed 10,000 characters. You may specify this parameter in the query string of a GET request or in the body of a POST request.", + "required": false, + "type": "string" + }, + { + "name": "Text", + "in": "formData", + "description": "The text string to check for spelling and grammar errors. The combined length of the text string, preContextText string, and postContextText string may not exceed 10,000 characters. You may specify this parameter in the query string of a GET request or in the body of a POST request. Because of the query string length limit, you'll typically use a POST request unless you're checking only short strings.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/SpellCheck" + } + }, + "default": { + "description": "An error has occurred. Check the response type and/or status code for more details.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSpellModeRequest.json" + }, + "Successful Proof Mode query": { + "$ref": "./examples/SuccessfulProofModeRequest.json" + } + } + } + } + }, + "definitions": { + "SpellCheck": { + "allOf": [ + { + "$ref": "#/definitions/Answer" + } + ], + "type": "object", + "required": [ + "flaggedTokens" + ], + "properties": { + "flaggedTokens": { + "type": "array", + "items": { + "$ref": "#/definitions/SpellingFlaggedToken" + } + } + } + }, + "Answer": { + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": {} + }, + "SpellingFlaggedToken": { + "x-ms-discriminator-value": "Spelling/FlaggedToken", + "type": "object", + "required": [ + "offset", + "token", + "type" + ], + "properties": { + "offset": { + "type": "integer", + "format": "int32" + }, + "token": { + "type": "string" + }, + "type": { + "type": "string", + "default": "UnknownToken", + "enum": [ + "UnknownToken", + "RepeatedToken" + ], + "x-ms-enum": { + "name": "ErrorType", + "modelAsString": true + } + }, + "suggestions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SpellingTokenSuggestion" + } + }, + "pingUrlSuffix": { + "readOnly": true, + "type": "string" + } + } + }, + "Response": { + "description": "Defines a response. All schemas that could be returned at the root of a response should inherit from this", + "allOf": [ + { + "$ref": "#/definitions/Identifiable" + } + ], + "type": "object", + "properties": {} + }, + "SpellingTokenSuggestion": { + "x-ms-discriminator-value": "Spelling/TokenSuggestion", + "type": "object", + "required": [ + "suggestion" + ], + "properties": { + "suggestion": { + "type": "string" + }, + "score": { + "readOnly": true, + "type": "number", + "format": "double" + }, + "pingUrlSuffix": { + "readOnly": true, + "type": "string" + } + } + }, + "Identifiable": { + "description": "Defines the identity of a resource.", + "allOf": [ + { + "$ref": "#/definitions/ResponseBase" + } + ], + "type": "object", + "properties": { + "id": { + "description": "A String identifier.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "The top-level response that represents a failed request.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "description": "A list of errors that describe the reasons why the request failed.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ResponseBase": { + "discriminator": "_type", + "type": "object", + "required": [ + "_type" + ], + "properties": { + "_type": { + "type": "string" + } + } + }, + "Error": { + "description": "Defines the error that occurred.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "The error code that identifies the category of error.", + "type": "string", + "default": "None", + "enum": [ + "None", + "ServerError", + "InvalidRequest", + "RateLimitExceeded", + "InvalidAuthorization", + "InsufficientAuthorization" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "subCode": { + "description": "The error code that further helps to identify the error.", + "readOnly": true, + "type": "string", + "enum": [ + "UnexpectedError", + "ResourceError", + "NotImplemented", + "ParameterMissing", + "ParameterInvalidValue", + "HttpNotAllowed", + "Blocked", + "AuthorizationMissing", + "AuthorizationRedundancy", + "AuthorizationDisabled", + "AuthorizationExpired" + ], + "x-ms-enum": { + "name": "ErrorSubCode", + "modelAsString": true + } + }, + "message": { + "description": "A description of the error.", + "type": "string" + }, + "moreDetails": { + "description": "A description that provides additional information about the error.", + "readOnly": true, + "type": "string" + }, + "parameter": { + "description": "The parameter in the request that caused the error.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The parameter's value in the request that was not valid.", + "readOnly": true, + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/SpellCheck/V1.0/examples/SuccessfulProofModeRequest.json b/specification/cognitiveservices/data-plane/SpellCheck/V1.0/examples/SuccessfulProofModeRequest.json new file mode 100644 index 000000000000..c0654a6246f7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpellCheck/V1.0/examples/SuccessfulProofModeRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "X-BingApis-SDK": "true", + "Ocp-Apim-Subscription-Key": "{API key}", + "mkt": "en-us", + "Accept": "application/json", + "Accept-language": "en-gb", + "Pragma": "no-cache", + "User-Agent": "{User Agent}", + "X-MS-EdgeClientIP": "{IP AddresS}", + "ActionType": "Edit", + "CountryCode": "US", + "SetLang": "en", + "Text": "nws", + "PreContextText": "daily", + "PostContextText": "paper" + }, + "responses": { + "200": { + "headers": { }, + "body": { + "_type": "SpellCheck", + "flaggedTokens": [{ + "offset": 0, + "token": "nws", + "type": "UnknownToken", + "suggestions": [{ + "suggestion": "news", + "score":0.846818946208462 + }] + }] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/SpellCheck/V1.0/examples/SuccessfulSpellModeRequest.json b/specification/cognitiveservices/data-plane/SpellCheck/V1.0/examples/SuccessfulSpellModeRequest.json new file mode 100644 index 000000000000..ce9ca399bcbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpellCheck/V1.0/examples/SuccessfulSpellModeRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "X-BingApis-SDK": "true", + "Ocp-Apim-Subscription-Key": "{API key}", + "mkt": "en-US", + "Text": "micosoft", + "Mode": "Spell" + }, + "responses": { + "200": { + "headers": { }, + "body": { + "_type": "SpellCheck", + "flaggedTokens": [{ + "offset": 0, + "token": "micosoft", + "type": "UnknownToken", + "suggestions": [{ + "suggestion": "microsoft", + "score": 1 + }] + }] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/SpellCheck/readme.md b/specification/cognitiveservices/data-plane/SpellCheck/readme.md new file mode 100644 index 000000000000..3a9f783b9dae --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpellCheck/readme.md @@ -0,0 +1,32 @@ +# Cognitive Services Spell Check SDK + +> see https://aka.ms/autorest + +Configuration for generating Spell Check SDK. + +The current release is `release_1_0`. + +``` yaml + +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: v1.0/SpellCheck.json +``` + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + namespace: Microsoft.Azure.CognitiveServices.SpellCheck + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/SpellCheck/Generated/ + sync-methods: none +``` + diff --git a/specification/cognitiveservices/data-plane/VideoSearch/v1.0/examples/SuccessfulVideoDetailRequest.json b/specification/cognitiveservices/data-plane/VideoSearch/v1.0/examples/SuccessfulVideoDetailRequest.json index 04b25429fe73..30b8b5cc3caa 100644 --- a/specification/cognitiveservices/data-plane/VideoSearch/v1.0/examples/SuccessfulVideoDetailRequest.json +++ b/specification/cognitiveservices/data-plane/VideoSearch/v1.0/examples/SuccessfulVideoDetailRequest.json @@ -1,1077 +1,1078 @@ { - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "_type": "Api.VideoDetails.VideoDetails", - "instrumentation": {}, - "relatedVideos": { - "value": [ - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CAF3C13D8F95F60859A5CAF3C13D8F95F60859A5", - "name": "Rhymes | Videos For Kids | Kids Cars | Car Cartoons", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.dyd3l1d9Eav64QLZHyL1uAEsCo&pid=Api", - "datePublished": "2017-02-27T13:49:56.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=7hqOHxetPXU", - "hostPageUrl": "https://www.youtube.com/watch?v=7hqOHxetPXU", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=7hqOHxetPXU", - "duration": "PT1H3M45S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.pVkI9pWPPcHzyg_1502783553&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 14467367, - "videoId": "CAF3C13D8F95F60859A5CAF3C13D8F95F60859A5", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=3B3DEE3B4EDAE1D24AF53B3DEE3B4EDAE1D24AF5", - "name": "Video for kids with Police chases & Car Wash Police cars in the mud", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.kijP1zRUBJvQELf5J6GbtgEsCp&pid=Api", - "datePublished": "2017-03-29T06:59:47.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Video For Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=B1-AHKil-RI", - "hostPageUrl": "https://www.youtube.com/watch?v=B1-AHKil-RI", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=B1-AHKil-RI", - "duration": "PT6M52S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.9UrS4dpOO%2b49Ow_1502898462&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 11949800, - "videoId": "3B3DEE3B4EDAE1D24AF53B3DEE3B4EDAE1D24AF5", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=65EF807A95A20A67052C65EF807A95A20A67052C", - "name": "Learning Vehicles Names and Sounds | Emergency Vehicles | Police Car. Fire Truck. Rescue Trucks Kids", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.EuueymUWyMMXZ3KWVmbSEgEsCo&pid=Api", - "datePublished": "2017-02-16T15:01:46.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "ŠœŃƒŠ»ŃŒŃ‚Šø ŠœŃƒŠ»ŃŒŃ‚" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=NiOcekC-0uk", - "hostPageUrl": "https://www.youtube.com/watch?v=NiOcekC-0uk", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=NiOcekC-0uk", - "duration": "PT11M59S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.LAVnCqKVeoDvZQ_1509291753&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 4924148, - "videoId": "65EF807A95A20A67052C65EF807A95A20A67052C", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=02C23F851FDBA1CE621B02C23F851FDBA1CE621B", - "name": "police cars | emergency vehicles | kids car cartoons", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.iYBh1XuxiQcNE_5l9kxxsgEsCo&pid=Api", - "datePublished": "2017-01-04T13:33:20.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Rhymes - Cartoon Videos for Children" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=wTAr0xo2mSs", - "hostPageUrl": "https://www.youtube.com/watch?v=wTAr0xo2mSs", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=wTAr0xo2mSs", - "duration": "PT21M50S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.G2LOodsfhT%2fCAg_1502776800&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 4302392, - "videoId": "02C23F851FDBA1CE621B02C23F851FDBA1CE621B", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=A300CFD5B5A15F979222A300CFD5B5A15F979222", - "name": "Cars Toon - ENGLISH - Mater's Tall Tales - Maters - McQueen - kids movie - Mater Toons - the cars", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.T4lhcFqGO72V9HureeJ9XwEsC3&pid=Api", - "datePublished": "2013-06-26T20:37:08.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "FullHDvideos4me" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=bBH0ele7qdw", - "hostPageUrl": "https://www.youtube.com/watch?v=bBH0ele7qdw", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=bBH0ele7qdw", - "duration": "PT21M21S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.IpKXX6G11c8Aow_1503407537&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 203184571, - "videoId": "A300CFD5B5A15F979222A300CFD5B5A15F979222", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=043C249275B59BEBCAB2043C249275B59BEBCAB2", - "name": "Police Car Chase with Racing Cars Cartoon for children & kids 3D Animation - Cars & Truck Stories", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.cM3N1-K07h-kxzMB_CbzzQEsCo&pid=Api", - "datePublished": "2017-03-07T11:03:24.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Cars & Trucks Stories" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=5nkXCEVuw3s", - "hostPageUrl": "https://www.youtube.com/watch?v=5nkXCEVuw3s", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=5nkXCEVuw3s", - "duration": "PT20M5S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.ssrrm7V1kiQ8BA_1503348629&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 697899, - "videoId": "043C249275B59BEBCAB2043C249275B59BEBCAB2", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=3062675871F017D95F663062675871F017D95F66", - "name": "Learn Vehicles - Fire Truck & Police Car | Colors Transport for Toddlers | Videos for Kids", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.WbdIMuFnZNCFpayu8I3ffAEsCo&pid=Api", - "datePublished": "2016-12-06T10:49:44.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "McQueen Songs" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=um1dO0EvsoM", - "hostPageUrl": "https://www.youtube.com/watch?v=um1dO0EvsoM", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=um1dO0EvsoM", - "duration": "PT13M17S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.Zl%2fZF%2fBxWGdiMA_1507509699&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 12134786, - "videoId": "3062675871F017D95F663062675871F017D95F66", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=9AC1AB024941175018019AC1AB02494117501801", - "name": "Police Cars for Children with Blippi | Educational Videos for Kids", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.QcRXmziUO0Q8QhJBmFfQkwEsCo&pid=Api", - "datePublished": "2017-05-10T08:17:41.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Blippi" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=MILhzvM0cRA", - "hostPageUrl": "https://www.youtube.com/watch?v=MILhzvM0cRA", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=MILhzvM0cRA", - "duration": "PT17M48S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.ARhQF0FJAqvBmg_1500946783&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 13194440, - "videoId": "9AC1AB024941175018019AC1AB02494117501801", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CFCEDCCB05399A028462CFCEDCCB05399A028462", - "name": "Police Car, Police Helicopter - My Town Police : Cars for Kids| Videos for Children - Android Games", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.pmcgfZ1W-mzAETTF9duZQAEsCo&pid=Api", - "datePublished": "2017-04-16T22:27:43.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Games" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=fUm8sgTQ7kg", - "hostPageUrl": "https://www.youtube.com/watch?v=fUm8sgTQ7kg", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=fUm8sgTQ7kg", - "duration": "PT12M2S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.YoQCmjkFy9zOzw_1506927817&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 149103, - "videoId": "CFCEDCCB05399A028462CFCEDCCB05399A028462", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=52458CB016CA4C87C5FB52458CB016CA4C87C5FB", - "name": "Police Car for Children | Kids Truck Video - Police Vehicles", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.Te5ZY-JtEdDO-6IOGQ2XPwEsCo&pid=Api", - "datePublished": "2016-10-05T18:32:18.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "twentytrucks" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=xBmEWiWkx9I", - "hostPageUrl": "https://www.youtube.com/watch?v=xBmEWiWkx9I", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=xBmEWiWkx9I", - "duration": "PT3M55S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.%2b8WHTMoWsIxFUg_1503469069&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 11031696, - "videoId": "52458CB016CA4C87C5FB52458CB016CA4C87C5FB", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=771C8F52E78B54068853771C8F52E78B54068853", - "name": "Police Chase with Racing Cars Monster Trucks & Police Cars Video For Kids", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.gD3YJd4TWHaUSuasaWaWhgEsCp&pid=Api", - "datePublished": "2017-04-01T13:37:49.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Video For Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=w_uDmovoPgo", - "hostPageUrl": "https://www.youtube.com/watch?v=w_uDmovoPgo", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=w_uDmovoPgo", - "duration": "PT1H3M57S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.U4gGVIvnUo8cdw_1504100802&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 2051416, - "videoId": "771C8F52E78B54068853771C8F52E78B54068853", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=89E2CDDB7BBC0015B6E589E2CDDB7BBC0015B6E5", - "name": "Toy Cars for Kids: Semi Truck Car Hauler Set, Monster Truck Wheelie and Bump & Go Sportscar", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.mGOuldxRnDH-KD-hUm_9xAEsCo&pid=Api", - "datePublished": "2016-04-20T07:16:23.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Hulyan Maya" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=f5bt01v01cs", - "hostPageUrl": "https://www.youtube.com/watch?v=f5bt01v01cs", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=f5bt01v01cs", - "duration": "PT21M58S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.5bYVALx7283iiQ_1507047988&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 5574027, - "videoId": "89E2CDDB7BBC0015B6E589E2CDDB7BBC0015B6E5", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=52A2A2B73340232AFE8F52A2A2B73340232AFE8F", - "name": "Car Toy Factory for Kids", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.Cg-wKLPpCHHvQ8mBPoDSmwEsCp&pid=Api", - "datePublished": "2017-02-18T08:51:22.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Video For Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=cUHrekf1R0M", - "hostPageUrl": "https://www.youtube.com/watch?v=cUHrekf1R0M", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=cUHrekf1R0M", - "duration": "PT12M54S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.j%2f4qI0Azt6KiUg_1501215790&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 2073895, - "videoId": "52A2A2B73340232AFE8F52A2A2B73340232AFE8F", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=52671488702FA6AA1B5352671488702FA6AA1B53", - "name": "Learn Colors With Street Vehicles | Color Song | Cartoon Cars For Kids", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.wj6iDg_LaIrJ_AAn0KLDfAEsCo&pid=Api", - "datePublished": "2016-12-29T13:32:19.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=9-FKSNYHkNk", - "hostPageUrl": "https://www.youtube.com/watch?v=9-FKSNYHkNk", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=9-FKSNYHkNk", - "duration": "PT1H7M7S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.Uxuqpi9wiBRnUg_1503900161&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 2805913, - "videoId": "52671488702FA6AA1B5352671488702FA6AA1B53", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=DD5F8E875016010E83CBDD5F8E875016010E83CB", - "name": "Police Car Chase And Stunts Car Videos For Kids", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP._JnuJJTsuww3lnIdX7dTowEsCo&pid=Api", - "datePublished": "2017-03-18T15:22:26.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=E7lT_kPkoiw", - "hostPageUrl": "https://www.youtube.com/watch?v=E7lT_kPkoiw", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=E7lT_kPkoiw", - "duration": "PT1H1M57S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.y4MOARZQh45f3Q_1509274033&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 128569, - "videoId": "DD5F8E875016010E83CBDD5F8E875016010E83CB", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CBB32E0F585269FC8311CBB32E0F585269FC8311", - "name": "The Police Chase with Racing Cars Monster Trucks & Police Cars Video For Kids", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.W-AxCHcnhoKvWBgbfoY4GQEsCo&pid=Api", - "datePublished": "2016-08-30T14:00:33.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Video For Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=rO65QV82xSw", - "hostPageUrl": "https://www.youtube.com/watch?v=rO65QV82xSw", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=rO65QV82xSw", - "duration": "PT28M57S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.EYP8aVJYDy6zyw_1498851522&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 15352561, - "videoId": "CBB32E0F585269FC8311CBB32E0F585269FC8311", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=1969A15F926A972E6B3E1969A15F926A972E6B3E", - "name": "Learn Shapes And Race Monster Trucks - TOYS (Part 3) | Videos For Children", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.3HsitFDq6LUTon6i2tidyQEsCo&pid=Api", - "datePublished": "2015-10-23T02:43:23.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "coilbookā„¢ | Learning For Children" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=M8BFtmQRHq4", - "hostPageUrl": "https://www.youtube.com/watch?v=M8BFtmQRHq4", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=M8BFtmQRHq4", - "duration": "PT14M49S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.Pmsul2qSX6FpGQ_1501880373&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 36696302, - "videoId": "1969A15F926A972E6B3E1969A15F926A972E6B3E", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=94127584DD3BC3A736E694127584DD3BC3A736E6", - "name": "Police Car Compilation | 60mins Video For Kids | learn vehicles | kids videos", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.DHeo4fsxZm69xVGZTZqAKQEsCo&pid=Api", - "datePublished": "2015-06-24T16:41:23.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=SGowPVkyius", - "hostPageUrl": "https://www.youtube.com/watch?v=SGowPVkyius", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=SGowPVkyius", - "duration": "PT1H21M57S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.5janwzvdhHUSlA_1504775176&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 8634626, - "videoId": "94127584DD3BC3A736E694127584DD3BC3A736E6", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=DDA0B071D8C840A10065DDA0B071D8C840A10065", - "name": "CRAZY POLICE CHASE Ford Mustang Toy Cars Kids FUN! Action!", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.tZH0Lda10t42C4DFbjol_gEsCo&pid=Api", - "datePublished": "2016-07-22T06:38:16.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Toy Cars" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=LuXcXGSszJc", - "hostPageUrl": "https://www.youtube.com/watch?v=LuXcXGSszJc", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=LuXcXGSszJc", - "duration": "PT2M32S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.ZQChQMjYcbCg3Q_1509978928&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 4874362, - "videoId": "DDA0B071D8C840A10065DDA0B071D8C840A10065", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=BB4CAABDE8B9B8B0AB73BB4CAABDE8B9B8B0AB73", - "name": "Cars and Trucks Cartoon for Kids. Ambulance. Fire Truck. Police Car. Cartoons for Children", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.OIYDfS6E0o3cKXg8AbGoFwEsCo&pid=Api", - "datePublished": "2016-09-02T08:19:55.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Tiki Taki Cars" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=xtOUO0l38Zk", - "hostPageUrl": "https://www.youtube.com/watch?v=xtOUO0l38Zk", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=xtOUO0l38Zk", - "duration": "PT22M25S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.c6uwuLnovapMuw_1507174721&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 1822363, - "videoId": "BB4CAABDE8B9B8B0AB73BB4CAABDE8B9B8B0AB73", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=124E1F08337093463F28124E1F08337093463F28", - "name": "CARS and TRUCKS Cartoons Compilation for Children - 4 Your Kids", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.yQtIiH60Rr_PwHtizk4hqgEsCo&pid=Api", - "datePublished": "2016-11-04T08:42:32.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "4 your kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=VHbHdOo0iK0", - "hostPageUrl": "https://www.youtube.com/watch?v=VHbHdOo0iK0", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=VHbHdOo0iK0", - "duration": "PT1H38S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.KD9Gk3AzCB9OEg_1504723365&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 5466050, - "videoId": "124E1F08337093463F28124E1F08337093463F28", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=6C72BCB98FE68C18193C6C72BCB98FE68C18193C", - "name": "Sergeant Cooper the Police Car - Real City Heroes (RCH) - Videos For Children", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.nqc9YM60xc6Wi7UnWQVhGAEsCo&pid=Api", - "datePublished": "2015-05-16T13:25:02.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "coilbookā„¢ | Learning For Children" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=DS88TwUvzjM", - "hostPageUrl": "https://www.youtube.com/watch?v=DS88TwUvzjM", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=DS88TwUvzjM", - "duration": "PT12M43S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.PBkYjOaPubxybA_1503505764&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 123196938, - "videoId": "6C72BCB98FE68C18193C6C72BCB98FE68C18193C", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=590717B7442FC8A7B203590717B7442FC8A7B203", - "name": "Police Car cartoon for children | Emergency Vehicles cartoons | Car cartoons for kids", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.l3Pt4peVxrVwzWJbIRNuVwEsCo&pid=Api", - "datePublished": "2016-09-24T07:41:10.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Tiki Taki Cars" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=5npTw1KAY0Q", - "hostPageUrl": "https://www.youtube.com/watch?v=5npTw1KAY0Q", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=5npTw1KAY0Q", - "duration": "PT21M6S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.A7KnyC9EtxcHWQ_1498197456&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 4092778, - "videoId": "590717B7442FC8A7B203590717B7442FC8A7B203", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=1731A812094B6B8B6BF91731A812094B6B8B6BF9", - "name": "Police Car | formation and uses | Police Car Cartoons", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.7_Ig7jxHEAP_sZ80rAYDmwEsCo&pid=Api", - "datePublished": "2016-10-14T15:24:46.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=YwPyRv25wyk", - "hostPageUrl": "https://www.youtube.com/watch?v=YwPyRv25wyk", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=YwPyRv25wyk", - "duration": "PT26M39S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.%2bWuLa0sJEqgxFw_1502211998&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 3418122, - "videoId": "1731A812094B6B8B6BF91731A812094B6B8B6BF9", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CE8FC830097FC068AF93CE8FC830097FC068AF93", - "name": "Car Cartoons for kids. Police Car & Racing Car. Race. Emergency Vehicles for children. Episode 63", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.sJ2ZssHFF-loXyPds7-qbgEsCo&pid=Api", - "datePublished": "2016-04-01T08:09:35.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Tiki Taki Cars" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=s_cGx_GByNQ", - "hostPageUrl": "https://www.youtube.com/watch?v=s_cGx_GByNQ", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=s_cGx_GByNQ", - "duration": "PT20M59S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.k69owH8JMMiPzg_1505868239&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 2610222, - "videoId": "CE8FC830097FC068AF93CE8FC830097FC068AF93", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=713E49A812D8FE2D2973713E49A812D8FE2D2973", - "name": "Tom The Tow Truck and the Police Car in Car City | Trucks cartoon for children šŸš“ šŸšš", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.TyLjzNZpxNCFEqAgcbfVnQEsCo&pid=Api", - "datePublished": "2016-02-10T17:24:37.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Car City" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=3ulurahh5hc", - "hostPageUrl": "https://www.youtube.com/watch?v=3ulurahh5hc", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=3ulurahh5hc", - "duration": "PT4M29S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.cykt%2ftgSqEk%2bcQ_1509280905&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 5312412, - "videoId": "713E49A812D8FE2D2973713E49A812D8FE2D2973", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CABB794EF178D96C41FDCABB794EF178D96C41FD", - "name": "Kids Channel Police Car | Car Videos", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.3x01QFvBFWu1RM7dUrwzrAEsCo&pid=Api", - "datePublished": "2016-11-14T15:05:18.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=ssHriuhOuzc", - "hostPageUrl": "https://www.youtube.com/watch?v=ssHriuhOuzc", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=ssHriuhOuzc", - "duration": "PT26M", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.%2fUFs2XjxTnm7yg_1503330914&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 231053, - "videoId": "CABB794EF178D96C41FDCABB794EF178D96C41FD", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=15E75B6B752C3F5971B815E75B6B752C3F5971B8", - "name": "Police Chase for Children with Police Cars & Racing Cars Video for Kids", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.bl2hojjK68XoUbJsgyOiGwEsCp&pid=Api", - "datePublished": "2017-02-14T14:08:32.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Video For Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=-r7yQo4y1YE", - "hostPageUrl": "https://www.youtube.com/watch?v=-r7yQo4y1YE", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=-r7yQo4y1YE", - "duration": "PT11M4S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.uHFZPyx1a1vnFQ_1507548617&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 1095193, - "videoId": "15E75B6B752C3F5971B815E75B6B752C3F5971B8", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=7DC5A1EAF0A3FA90FD177DC5A1EAF0A3FA90FD17", - "name": "A lot of Cars Toys for Kids Video for Children", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.ezzjOEFPLneEYjgGY-B1VgEsCp&pid=Api", - "datePublished": "2017-03-26T14:29:28.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Video For Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=RAw7egfZUOE", - "hostPageUrl": "https://www.youtube.com/watch?v=RAw7egfZUOE", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=RAw7egfZUOE", - "duration": "PT37M56S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.F%2f2Q%2bqPw6qHFfQ_1503451291&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 794592, - "videoId": "7DC5A1EAF0A3FA90FD177DC5A1EAF0A3FA90FD17", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CA878943791F8E7E84AFCA878943791F8E7E84AF", - "name": "Learn Colours With Cars for Toddlers Kids Children | Videos for Children", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.FqyYMe92eysGYO81u2EOCQEsCo&pid=Api", - "datePublished": "2016-11-17T03:37:26.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "LittleBabyTV" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=J7eU39mAYRU", - "hostPageUrl": "https://www.youtube.com/watch?v=J7eU39mAYRU", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=J7eU39mAYRU", - "duration": "PT47M28S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.r4R%2bjh95Q4mHyg_1504144429&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 14912449, - "videoId": "CA878943791F8E7E84AFCA878943791F8E7E84AF", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=2E9FBE1360CE8941FD202E9FBE1360CE8941FD20", - "name": "Turbo Town | baby cartoons | car cartoon | kids compilation", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.ZWqkGW1du0q_nmWt5qmt0gEsCo&pid=Api", - "datePublished": "2017-01-14T12:11:42.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=z6JpETLLvNM", - "hostPageUrl": "https://www.youtube.com/watch?v=z6JpETLLvNM", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=z6JpETLLvNM", - "duration": "PT1H1M49S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.IP1Bic5gE76fLg_1501904215&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 3404850, - "videoId": "2E9FBE1360CE8941FD202E9FBE1360CE8941FD20", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=E6A931C0701608001C4BE6A931C0701608001C4B", - "name": "100+ cars toys GIANT EGG SURPRISE OPENING Disney Pixar Lightning McQueen kids video Ryan ToysReview", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.Ts-rPrzK6jbVLYPC_WGX9QEsCo&pid=Api", - "datePublished": "2015-06-30T21:22:58.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Ryan ToysReview" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=Tldlt2RhrDw", - "hostPageUrl": "https://www.youtube.com/watch?v=Tldlt2RhrDw", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=Tldlt2RhrDw", - "duration": "PT7M26S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.SxwACBZwwDGp5g_1508275665&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 766400565, - "videoId": "E6A931C0701608001C4BE6A931C0701608001C4B", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=7A3029537B499F3C13D17A3029537B499F3C13D1", - "name": "CAR WASH | COMPILATION | Videos For Children | Videos for kids | Learn Vehicles", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.nTRohDuscWOBLULhe_cUFQEsCo&pid=Api", - "datePublished": "2014-12-17T08:03:32.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=alJU33729mM", - "hostPageUrl": "https://www.youtube.com/watch?v=alJU33729mM", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=alJU33729mM", - "duration": "PT49M49S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.0RM8n0l7Uykweg_1503143742&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 93939180, - "videoId": "7A3029537B499F3C13D17A3029537B499F3C13D1", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=60B34A4A8BDE2A1C938560B34A4A8BDE2A1C9385", - "name": "HUGE POWER WHEELS COLLECTIONS Ride On Cars for Kids Compilations Part 1", - "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.HIpR1tfDK69JnHUHIAm5OwEsCo&pid=Api", - "datePublished": "2016-08-11T21:30:22.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Ryan ToysReview" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=U_x_mp1BGOE", - "hostPageUrl": "https://www.youtube.com/watch?v=U_x_mp1BGOE", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=U_x_mp1BGOE", - "duration": "PT9M2S", - "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.hZMcKt6LSkqzYA_1504426200&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 22633870, - "videoId": "60B34A4A8BDE2A1C938560B34A4A8BDE2A1C9385", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=678638BB913E3784A029678638BB913E3784A029", - "name": "Police Chase Thief Car Videos los angeles - Kids Toys Unboxing - Surprise Eggs Toys for Kids", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.GwEjRjULxt5fkNo-FAV8SwEsCo&pid=Api", - "datePublished": "2017-05-30T23:54:58.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Jugnu Kids - Nursery Rhymes and Kids Songs" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=Nco6E0qjz7A", - "hostPageUrl": "https://www.youtube.com/watch?v=Nco6E0qjz7A", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=Nco6E0qjz7A", - "duration": "PT1H10M45S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.KaCENz6RuziGZw_1508841951&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 5912788, - "videoId": "678638BB913E3784A029678638BB913E3784A029", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=D3A9349991E1B6BD338ED3A9349991E1B6BD338E", - "name": "train car wash | car cartoons for children | kids video", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.Z6963FYweRUTZrcesxfbdwEsCo&pid=Api", - "datePublished": "2016-08-29T09:55:15.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=VxXgMajxyk4", - "hostPageUrl": "https://www.youtube.com/watch?v=VxXgMajxyk4", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=VxXgMajxyk4", - "duration": "PT41M33S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.jjO9tuGRmTSp0w_1501917499&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 7257139, - "videoId": "D3A9349991E1B6BD338ED3A9349991E1B6BD338E", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=2FF0104C87A7ACE641362FF0104C87A7ACE64136", - "name": "Police Car Wash | videos For Children | videos for kids", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.g9jWn5SyL2oZ0eJkyPe7fwEsCo&pid=Api", - "datePublished": "2014-09-05T14:28:23.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Kids Channel - Cartoon Videos for Kids" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=nMDnm5TyG4w", - "hostPageUrl": "https://www.youtube.com/watch?v=nMDnm5TyG4w", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=nMDnm5TyG4w", - "duration": "PT2M32S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.NkHmrKeHTBDwLw_1504053689&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 44940799, - "videoId": "2FF0104C87A7ACE641362FF0104C87A7ACE64136", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=4E26CE671544845D9EB94E26CE671544845D9EB9", - "name": "Police Cars Fire Trucks And Ambulance Responding Compilation Part 6", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.JzHoDzXHMeaj_XW9uHL4qAEsCo&pid=Api", - "datePublished": "2016-04-30T13:21:03.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Demonracer2" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=loSDJk3VjdI", - "hostPageUrl": "https://www.youtube.com/watch?v=loSDJk3VjdI", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=loSDJk3VjdI", - "duration": "PT11M2S", - "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.uZ5dhEQVZ84mTg_1505274246&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 2644389, - "videoId": "4E26CE671544845D9EB94E26CE671544845D9EB9", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=ABDEF167D83FD89F7CC0ABDEF167D83FD89F7CC0", - "name": "The Car Patrol: fire truck and police car šŸš“ in Amber's siren is stolen in Car City šŸš’ Trucks Cartoons", - "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.ef25OP9x1mxQ5v_XzBNTuwEsCo&pid=Api", - "datePublished": "2017-01-10T18:48:27.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Car City" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=uT0MTubFXRQ", - "hostPageUrl": "https://www.youtube.com/watch?v=uT0MTubFXRQ", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=uT0MTubFXRQ", - "duration": "PT33M40S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.wHyf2D%2fYZ%2fHeqw_1502909456&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 6192700, - "videoId": "ABDEF167D83FD89F7CC0ABDEF167D83FD89F7CC0", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=1DBC3BB20E174787AAAC1DBC3BB20E174787AAAC", - "name": "My Red Police Car - My Magic Pet Morphle Compilation with Police Vehicle Videos for Kids!", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.yKZcfXb-kLXrXcmOO9P7RQEsCo&pid=Api", - "datePublished": "2016-09-29T15:52:28.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Morphle TV" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=JvJzQdVnDuU", - "hostPageUrl": "https://www.youtube.com/watch?v=JvJzQdVnDuU", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=JvJzQdVnDuU", - "duration": "PT29M33S", - "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.rKqHRxcOsju8HQ_1501397240&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 27075263, - "videoId": "1DBC3BB20E174787AAAC1DBC3BB20E174787AAAC", - "allowMobileEmbed": false, - "isSuperfresh": false - }, - { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=0BBA09552F8F5C5320CE0BBA09552F8F5C5320CE", - "name": "Car parking cartoon - cars cartoon- cars for kids - trains for children - toy factory cartoon", - "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.OiZe6oUi6joug0nPfE3jTAEsCo&pid=Api", - "datePublished": "2017-07-15T12:06:51.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Toy Factory" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=fRCcbbjEV3U", - "hostPageUrl": "https://www.youtube.com/watch?v=fRCcbbjEV3U", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=fRCcbbjEV3U", - "duration": "PT14M20S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.ziBTXI8vVQm6Cw_1509023063&pid=Api", - "allowHttpsEmbed": true, - "viewCount": 3675116, - "videoId": "0BBA09552F8F5C5320CE0BBA09552F8F5C5320CE", - "allowMobileEmbed": false, - "isSuperfresh": false - } - ] - }, - "videoResult": { - "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=A9A6BF1A1882870A2BF1A9A6BF1A1882870A2BF1", - "name": "Cop Cars Kid Cartoon - The Police Car New Cars for kids & Trucks Cartoons for children", - "description": "Video for children with Cop Cars Kids Cartoon! Enjoy The Police Car New Kids Animation - Cars & Trucks Cartoons for children on the screen! Enjoy best educat...", - "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.IwahJWZR_3EraqgrED0rzwEsCo&pid=Api", - "datePublished": "2017-05-06T08:33:12.0000000", - "publisher": [ - { - "name": "YouTube" - } - ], - "creator": { - "name": "Cars & Trains Cartoons" - }, - "isAccessibleForFree": true, - "contentUrl": "https://www.youtube.com/watch?v=wHpCrFP3WIg", - "hostPageUrl": "https://www.youtube.com/watch?v=wHpCrFP3WIg", - "encodingFormat": "h264", - "hostPageDisplayUrl": "https://www.youtube.com/watch?v=wHpCrFP3WIg", - "width": 1280, - "height": 720, - "duration": "PT1H3M17S", - "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.8SsKh4IYGr%2bmqQ_1506858484&pid=Api", - "embedHtml": "", - "allowHttpsEmbed": true, - "viewCount": 3872833, - "thumbnail": { - "width": 300, - "height": 168 - }, - "videoId": "A9A6BF1A1882870A2BF1A9A6BF1A1882870A2BF1", - "allowMobileEmbed": true, - "isSuperfresh": false + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "_type": "Api.VideoDetails.VideoDetails", + "instrumentation": {}, + "relatedVideos": { + "value": [ + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CAF3C13D8F95F60859A5CAF3C13D8F95F60859A5", + "name": "Rhymes | Videos For Kids | Kids Cars | Car Cartoons", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.dyd3l1d9Eav64QLZHyL1uAEsCo&pid=Api", + "datePublished": "2017-02-27T13:49:56.0000000", + "publisher": [ + { + "name": "YouTube" } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=7hqOHxetPXU", + "hostPageUrl": "https://www.youtube.com/watch?v=7hqOHxetPXU", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=7hqOHxetPXU", + "duration": "PT1H3M45S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.pVkI9pWPPcHzyg_1502783553&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 14467367, + "videoId": "CAF3C13D8F95F60859A5CAF3C13D8F95F60859A5", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=3B3DEE3B4EDAE1D24AF53B3DEE3B4EDAE1D24AF5", + "name": "Video for kids with Police chases & Car Wash Police cars in the mud", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.kijP1zRUBJvQELf5J6GbtgEsCp&pid=Api", + "datePublished": "2017-03-29T06:59:47.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Video For Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=B1-AHKil-RI", + "hostPageUrl": "https://www.youtube.com/watch?v=B1-AHKil-RI", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=B1-AHKil-RI", + "duration": "PT6M52S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.9UrS4dpOO%2b49Ow_1502898462&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 11949800, + "videoId": "3B3DEE3B4EDAE1D24AF53B3DEE3B4EDAE1D24AF5", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=65EF807A95A20A67052C65EF807A95A20A67052C", + "name": "Learning Vehicles Names and Sounds | Emergency Vehicles | Police Car. Fire Truck. Rescue Trucks Kids", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.EuueymUWyMMXZ3KWVmbSEgEsCo&pid=Api", + "datePublished": "2017-02-16T15:01:46.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "ŠœŃƒŠ»ŃŒŃ‚Šø ŠœŃƒŠ»ŃŒŃ‚" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=NiOcekC-0uk", + "hostPageUrl": "https://www.youtube.com/watch?v=NiOcekC-0uk", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=NiOcekC-0uk", + "duration": "PT11M59S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.LAVnCqKVeoDvZQ_1509291753&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 4924148, + "videoId": "65EF807A95A20A67052C65EF807A95A20A67052C", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=02C23F851FDBA1CE621B02C23F851FDBA1CE621B", + "name": "police cars | emergency vehicles | kids car cartoons", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.iYBh1XuxiQcNE_5l9kxxsgEsCo&pid=Api", + "datePublished": "2017-01-04T13:33:20.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Rhymes - Cartoon Videos for Children" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=wTAr0xo2mSs", + "hostPageUrl": "https://www.youtube.com/watch?v=wTAr0xo2mSs", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=wTAr0xo2mSs", + "duration": "PT21M50S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.G2LOodsfhT%2fCAg_1502776800&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 4302392, + "videoId": "02C23F851FDBA1CE621B02C23F851FDBA1CE621B", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=A300CFD5B5A15F979222A300CFD5B5A15F979222", + "name": "Cars Toon - ENGLISH - Mater's Tall Tales - Maters - McQueen - kids movie - Mater Toons - the cars", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.T4lhcFqGO72V9HureeJ9XwEsC3&pid=Api", + "datePublished": "2013-06-26T20:37:08.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "FullHDvideos4me" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=bBH0ele7qdw", + "hostPageUrl": "https://www.youtube.com/watch?v=bBH0ele7qdw", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=bBH0ele7qdw", + "duration": "PT21M21S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.IpKXX6G11c8Aow_1503407537&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 203184571, + "videoId": "A300CFD5B5A15F979222A300CFD5B5A15F979222", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=043C249275B59BEBCAB2043C249275B59BEBCAB2", + "name": "Police Car Chase with Racing Cars Cartoon for children & kids 3D Animation - Cars & Truck Stories", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.cM3N1-K07h-kxzMB_CbzzQEsCo&pid=Api", + "datePublished": "2017-03-07T11:03:24.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Cars & Trucks Stories" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=5nkXCEVuw3s", + "hostPageUrl": "https://www.youtube.com/watch?v=5nkXCEVuw3s", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=5nkXCEVuw3s", + "duration": "PT20M5S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.ssrrm7V1kiQ8BA_1503348629&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 697899, + "videoId": "043C249275B59BEBCAB2043C249275B59BEBCAB2", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=3062675871F017D95F663062675871F017D95F66", + "name": "Learn Vehicles - Fire Truck & Police Car | Colors Transport for Toddlers | Videos for Kids", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.WbdIMuFnZNCFpayu8I3ffAEsCo&pid=Api", + "datePublished": "2016-12-06T10:49:44.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "McQueen Songs" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=um1dO0EvsoM", + "hostPageUrl": "https://www.youtube.com/watch?v=um1dO0EvsoM", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=um1dO0EvsoM", + "duration": "PT13M17S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.Zl%2fZF%2fBxWGdiMA_1507509699&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 12134786, + "videoId": "3062675871F017D95F663062675871F017D95F66", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=9AC1AB024941175018019AC1AB02494117501801", + "name": "Police Cars for Children with Blippi | Educational Videos for Kids", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.QcRXmziUO0Q8QhJBmFfQkwEsCo&pid=Api", + "datePublished": "2017-05-10T08:17:41.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Blippi" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=MILhzvM0cRA", + "hostPageUrl": "https://www.youtube.com/watch?v=MILhzvM0cRA", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=MILhzvM0cRA", + "duration": "PT17M48S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.ARhQF0FJAqvBmg_1500946783&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 13194440, + "videoId": "9AC1AB024941175018019AC1AB02494117501801", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CFCEDCCB05399A028462CFCEDCCB05399A028462", + "name": "Police Car, Police Helicopter - My Town Police : Cars for Kids| Videos for Children - Android Games", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.pmcgfZ1W-mzAETTF9duZQAEsCo&pid=Api", + "datePublished": "2017-04-16T22:27:43.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Games" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=fUm8sgTQ7kg", + "hostPageUrl": "https://www.youtube.com/watch?v=fUm8sgTQ7kg", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=fUm8sgTQ7kg", + "duration": "PT12M2S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.YoQCmjkFy9zOzw_1506927817&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 149103, + "videoId": "CFCEDCCB05399A028462CFCEDCCB05399A028462", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=52458CB016CA4C87C5FB52458CB016CA4C87C5FB", + "name": "Police Car for Children | Kids Truck Video - Police Vehicles", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.Te5ZY-JtEdDO-6IOGQ2XPwEsCo&pid=Api", + "datePublished": "2016-10-05T18:32:18.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "twentytrucks" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=xBmEWiWkx9I", + "hostPageUrl": "https://www.youtube.com/watch?v=xBmEWiWkx9I", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=xBmEWiWkx9I", + "duration": "PT3M55S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.%2b8WHTMoWsIxFUg_1503469069&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 11031696, + "videoId": "52458CB016CA4C87C5FB52458CB016CA4C87C5FB", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=771C8F52E78B54068853771C8F52E78B54068853", + "name": "Police Chase with Racing Cars Monster Trucks & Police Cars Video For Kids", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.gD3YJd4TWHaUSuasaWaWhgEsCp&pid=Api", + "datePublished": "2017-04-01T13:37:49.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Video For Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=w_uDmovoPgo", + "hostPageUrl": "https://www.youtube.com/watch?v=w_uDmovoPgo", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=w_uDmovoPgo", + "duration": "PT1H3M57S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.U4gGVIvnUo8cdw_1504100802&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 2051416, + "videoId": "771C8F52E78B54068853771C8F52E78B54068853", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=89E2CDDB7BBC0015B6E589E2CDDB7BBC0015B6E5", + "name": "Toy Cars for Kids: Semi Truck Car Hauler Set, Monster Truck Wheelie and Bump & Go Sportscar", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.mGOuldxRnDH-KD-hUm_9xAEsCo&pid=Api", + "datePublished": "2016-04-20T07:16:23.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Hulyan Maya" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=f5bt01v01cs", + "hostPageUrl": "https://www.youtube.com/watch?v=f5bt01v01cs", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=f5bt01v01cs", + "duration": "PT21M58S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.5bYVALx7283iiQ_1507047988&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 5574027, + "videoId": "89E2CDDB7BBC0015B6E589E2CDDB7BBC0015B6E5", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=52A2A2B73340232AFE8F52A2A2B73340232AFE8F", + "name": "Car Toy Factory for Kids", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.Cg-wKLPpCHHvQ8mBPoDSmwEsCp&pid=Api", + "datePublished": "2017-02-18T08:51:22.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Video For Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=cUHrekf1R0M", + "hostPageUrl": "https://www.youtube.com/watch?v=cUHrekf1R0M", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=cUHrekf1R0M", + "duration": "PT12M54S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.j%2f4qI0Azt6KiUg_1501215790&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 2073895, + "videoId": "52A2A2B73340232AFE8F52A2A2B73340232AFE8F", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=52671488702FA6AA1B5352671488702FA6AA1B53", + "name": "Learn Colors With Street Vehicles | Color Song | Cartoon Cars For Kids", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.wj6iDg_LaIrJ_AAn0KLDfAEsCo&pid=Api", + "datePublished": "2016-12-29T13:32:19.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=9-FKSNYHkNk", + "hostPageUrl": "https://www.youtube.com/watch?v=9-FKSNYHkNk", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=9-FKSNYHkNk", + "duration": "PT1H7M7S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.Uxuqpi9wiBRnUg_1503900161&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 2805913, + "videoId": "52671488702FA6AA1B5352671488702FA6AA1B53", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=DD5F8E875016010E83CBDD5F8E875016010E83CB", + "name": "Police Car Chase And Stunts Car Videos For Kids", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP._JnuJJTsuww3lnIdX7dTowEsCo&pid=Api", + "datePublished": "2017-03-18T15:22:26.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=E7lT_kPkoiw", + "hostPageUrl": "https://www.youtube.com/watch?v=E7lT_kPkoiw", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=E7lT_kPkoiw", + "duration": "PT1H1M57S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.y4MOARZQh45f3Q_1509274033&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 128569, + "videoId": "DD5F8E875016010E83CBDD5F8E875016010E83CB", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CBB32E0F585269FC8311CBB32E0F585269FC8311", + "name": "The Police Chase with Racing Cars Monster Trucks & Police Cars Video For Kids", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.W-AxCHcnhoKvWBgbfoY4GQEsCo&pid=Api", + "datePublished": "2016-08-30T14:00:33.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Video For Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=rO65QV82xSw", + "hostPageUrl": "https://www.youtube.com/watch?v=rO65QV82xSw", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=rO65QV82xSw", + "duration": "PT28M57S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.EYP8aVJYDy6zyw_1498851522&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 15352561, + "videoId": "CBB32E0F585269FC8311CBB32E0F585269FC8311", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=1969A15F926A972E6B3E1969A15F926A972E6B3E", + "name": "Learn Shapes And Race Monster Trucks - TOYS (Part 3) | Videos For Children", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.3HsitFDq6LUTon6i2tidyQEsCo&pid=Api", + "datePublished": "2015-10-23T02:43:23.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "coilbookā„¢ | Learning For Children" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=M8BFtmQRHq4", + "hostPageUrl": "https://www.youtube.com/watch?v=M8BFtmQRHq4", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=M8BFtmQRHq4", + "duration": "PT14M49S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.Pmsul2qSX6FpGQ_1501880373&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 36696302, + "videoId": "1969A15F926A972E6B3E1969A15F926A972E6B3E", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=94127584DD3BC3A736E694127584DD3BC3A736E6", + "name": "Police Car Compilation | 60mins Video For Kids | learn vehicles | kids videos", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.DHeo4fsxZm69xVGZTZqAKQEsCo&pid=Api", + "datePublished": "2015-06-24T16:41:23.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=SGowPVkyius", + "hostPageUrl": "https://www.youtube.com/watch?v=SGowPVkyius", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=SGowPVkyius", + "duration": "PT1H21M57S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.5janwzvdhHUSlA_1504775176&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 8634626, + "videoId": "94127584DD3BC3A736E694127584DD3BC3A736E6", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=DDA0B071D8C840A10065DDA0B071D8C840A10065", + "name": "CRAZY POLICE CHASE Ford Mustang Toy Cars Kids FUN! Action!", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.tZH0Lda10t42C4DFbjol_gEsCo&pid=Api", + "datePublished": "2016-07-22T06:38:16.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Toy Cars" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=LuXcXGSszJc", + "hostPageUrl": "https://www.youtube.com/watch?v=LuXcXGSszJc", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=LuXcXGSszJc", + "duration": "PT2M32S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.ZQChQMjYcbCg3Q_1509978928&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 4874362, + "videoId": "DDA0B071D8C840A10065DDA0B071D8C840A10065", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=BB4CAABDE8B9B8B0AB73BB4CAABDE8B9B8B0AB73", + "name": "Cars and Trucks Cartoon for Kids. Ambulance. Fire Truck. Police Car. Cartoons for Children", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.OIYDfS6E0o3cKXg8AbGoFwEsCo&pid=Api", + "datePublished": "2016-09-02T08:19:55.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Tiki Taki Cars" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=xtOUO0l38Zk", + "hostPageUrl": "https://www.youtube.com/watch?v=xtOUO0l38Zk", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=xtOUO0l38Zk", + "duration": "PT22M25S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.c6uwuLnovapMuw_1507174721&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 1822363, + "videoId": "BB4CAABDE8B9B8B0AB73BB4CAABDE8B9B8B0AB73", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=124E1F08337093463F28124E1F08337093463F28", + "name": "CARS and TRUCKS Cartoons Compilation for Children - 4 Your Kids", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.yQtIiH60Rr_PwHtizk4hqgEsCo&pid=Api", + "datePublished": "2016-11-04T08:42:32.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "4 your kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=VHbHdOo0iK0", + "hostPageUrl": "https://www.youtube.com/watch?v=VHbHdOo0iK0", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=VHbHdOo0iK0", + "duration": "PT1H38S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.KD9Gk3AzCB9OEg_1504723365&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 5466050, + "videoId": "124E1F08337093463F28124E1F08337093463F28", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=6C72BCB98FE68C18193C6C72BCB98FE68C18193C", + "name": "Sergeant Cooper the Police Car - Real City Heroes (RCH) - Videos For Children", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.nqc9YM60xc6Wi7UnWQVhGAEsCo&pid=Api", + "datePublished": "2015-05-16T13:25:02.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "coilbookā„¢ | Learning For Children" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=DS88TwUvzjM", + "hostPageUrl": "https://www.youtube.com/watch?v=DS88TwUvzjM", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=DS88TwUvzjM", + "duration": "PT12M43S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.PBkYjOaPubxybA_1503505764&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 123196938, + "videoId": "6C72BCB98FE68C18193C6C72BCB98FE68C18193C", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=590717B7442FC8A7B203590717B7442FC8A7B203", + "name": "Police Car cartoon for children | Emergency Vehicles cartoons | Car cartoons for kids", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.l3Pt4peVxrVwzWJbIRNuVwEsCo&pid=Api", + "datePublished": "2016-09-24T07:41:10.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Tiki Taki Cars" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=5npTw1KAY0Q", + "hostPageUrl": "https://www.youtube.com/watch?v=5npTw1KAY0Q", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=5npTw1KAY0Q", + "duration": "PT21M6S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.A7KnyC9EtxcHWQ_1498197456&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 4092778, + "videoId": "590717B7442FC8A7B203590717B7442FC8A7B203", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=1731A812094B6B8B6BF91731A812094B6B8B6BF9", + "name": "Police Car | formation and uses | Police Car Cartoons", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.7_Ig7jxHEAP_sZ80rAYDmwEsCo&pid=Api", + "datePublished": "2016-10-14T15:24:46.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=YwPyRv25wyk", + "hostPageUrl": "https://www.youtube.com/watch?v=YwPyRv25wyk", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=YwPyRv25wyk", + "duration": "PT26M39S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.%2bWuLa0sJEqgxFw_1502211998&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 3418122, + "videoId": "1731A812094B6B8B6BF91731A812094B6B8B6BF9", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CE8FC830097FC068AF93CE8FC830097FC068AF93", + "name": "Car Cartoons for kids. Police Car & Racing Car. Race. Emergency Vehicles for children. Episode 63", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.sJ2ZssHFF-loXyPds7-qbgEsCo&pid=Api", + "datePublished": "2016-04-01T08:09:35.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Tiki Taki Cars" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=s_cGx_GByNQ", + "hostPageUrl": "https://www.youtube.com/watch?v=s_cGx_GByNQ", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=s_cGx_GByNQ", + "duration": "PT20M59S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.k69owH8JMMiPzg_1505868239&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 2610222, + "videoId": "CE8FC830097FC068AF93CE8FC830097FC068AF93", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=713E49A812D8FE2D2973713E49A812D8FE2D2973", + "name": "Tom The Tow Truck and the Police Car in Car City | Trucks cartoon for children", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.TyLjzNZpxNCFEqAgcbfVnQEsCo&pid=Api", + "datePublished": "2016-02-10T17:24:37.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Car City" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=3ulurahh5hc", + "hostPageUrl": "https://www.youtube.com/watch?v=3ulurahh5hc", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=3ulurahh5hc", + "duration": "PT4M29S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.cykt%2ftgSqEk%2bcQ_1509280905&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 5312412, + "videoId": "713E49A812D8FE2D2973713E49A812D8FE2D2973", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CABB794EF178D96C41FDCABB794EF178D96C41FD", + "name": "Kids Channel Police Car | Car Videos", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.3x01QFvBFWu1RM7dUrwzrAEsCo&pid=Api", + "datePublished": "2016-11-14T15:05:18.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=ssHriuhOuzc", + "hostPageUrl": "https://www.youtube.com/watch?v=ssHriuhOuzc", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=ssHriuhOuzc", + "duration": "PT26M", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.%2fUFs2XjxTnm7yg_1503330914&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 231053, + "videoId": "CABB794EF178D96C41FDCABB794EF178D96C41FD", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=15E75B6B752C3F5971B815E75B6B752C3F5971B8", + "name": "Police Chase for Children with Police Cars & Racing Cars Video for Kids", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.bl2hojjK68XoUbJsgyOiGwEsCp&pid=Api", + "datePublished": "2017-02-14T14:08:32.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Video For Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=-r7yQo4y1YE", + "hostPageUrl": "https://www.youtube.com/watch?v=-r7yQo4y1YE", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=-r7yQo4y1YE", + "duration": "PT11M4S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.uHFZPyx1a1vnFQ_1507548617&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 1095193, + "videoId": "15E75B6B752C3F5971B815E75B6B752C3F5971B8", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=7DC5A1EAF0A3FA90FD177DC5A1EAF0A3FA90FD17", + "name": "A lot of Cars Toys for Kids Video for Children", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.ezzjOEFPLneEYjgGY-B1VgEsCp&pid=Api", + "datePublished": "2017-03-26T14:29:28.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Video For Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=RAw7egfZUOE", + "hostPageUrl": "https://www.youtube.com/watch?v=RAw7egfZUOE", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=RAw7egfZUOE", + "duration": "PT37M56S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.F%2f2Q%2bqPw6qHFfQ_1503451291&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 794592, + "videoId": "7DC5A1EAF0A3FA90FD177DC5A1EAF0A3FA90FD17", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=CA878943791F8E7E84AFCA878943791F8E7E84AF", + "name": "Learn Colours With Cars for Toddlers Kids Children | Videos for Children", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.FqyYMe92eysGYO81u2EOCQEsCo&pid=Api", + "datePublished": "2016-11-17T03:37:26.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "LittleBabyTV" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=J7eU39mAYRU", + "hostPageUrl": "https://www.youtube.com/watch?v=J7eU39mAYRU", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=J7eU39mAYRU", + "duration": "PT47M28S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.r4R%2bjh95Q4mHyg_1504144429&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 14912449, + "videoId": "CA878943791F8E7E84AFCA878943791F8E7E84AF", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=2E9FBE1360CE8941FD202E9FBE1360CE8941FD20", + "name": "Turbo Town | baby cartoons | car cartoon | kids compilation", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.ZWqkGW1du0q_nmWt5qmt0gEsCo&pid=Api", + "datePublished": "2017-01-14T12:11:42.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=z6JpETLLvNM", + "hostPageUrl": "https://www.youtube.com/watch?v=z6JpETLLvNM", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=z6JpETLLvNM", + "duration": "PT1H1M49S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.IP1Bic5gE76fLg_1501904215&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 3404850, + "videoId": "2E9FBE1360CE8941FD202E9FBE1360CE8941FD20", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=E6A931C0701608001C4BE6A931C0701608001C4B", + "name": "100+ cars toys GIANT EGG SURPRISE OPENING Disney Pixar Lightning McQueen kids video Ryan ToysReview", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.Ts-rPrzK6jbVLYPC_WGX9QEsCo&pid=Api", + "datePublished": "2015-06-30T21:22:58.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Ryan ToysReview" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=Tldlt2RhrDw", + "hostPageUrl": "https://www.youtube.com/watch?v=Tldlt2RhrDw", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=Tldlt2RhrDw", + "duration": "PT7M26S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.SxwACBZwwDGp5g_1508275665&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 766400565, + "videoId": "E6A931C0701608001C4BE6A931C0701608001C4B", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=7A3029537B499F3C13D17A3029537B499F3C13D1", + "name": "CAR WASH | COMPILATION | Videos For Children | Videos for kids | Learn Vehicles", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.nTRohDuscWOBLULhe_cUFQEsCo&pid=Api", + "datePublished": "2014-12-17T08:03:32.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=alJU33729mM", + "hostPageUrl": "https://www.youtube.com/watch?v=alJU33729mM", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=alJU33729mM", + "duration": "PT49M49S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.0RM8n0l7Uykweg_1503143742&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 93939180, + "videoId": "7A3029537B499F3C13D17A3029537B499F3C13D1", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=60B34A4A8BDE2A1C938560B34A4A8BDE2A1C9385", + "name": "HUGE POWER WHEELS COLLECTIONS Ride On Cars for Kids Compilations Part 1", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OVP.HIpR1tfDK69JnHUHIAm5OwEsCo&pid=Api", + "datePublished": "2016-08-11T21:30:22.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Ryan ToysReview" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=U_x_mp1BGOE", + "hostPageUrl": "https://www.youtube.com/watch?v=U_x_mp1BGOE", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=U_x_mp1BGOE", + "duration": "PT9M2S", + "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.hZMcKt6LSkqzYA_1504426200&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 22633870, + "videoId": "60B34A4A8BDE2A1C938560B34A4A8BDE2A1C9385", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=678638BB913E3784A029678638BB913E3784A029", + "name": "Police Chase Thief Car Videos los angeles - Kids Toys Unboxing - Surprise Eggs Toys for Kids", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.GwEjRjULxt5fkNo-FAV8SwEsCo&pid=Api", + "datePublished": "2017-05-30T23:54:58.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Jugnu Kids - Nursery Rhymes and Kids Songs" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=Nco6E0qjz7A", + "hostPageUrl": "https://www.youtube.com/watch?v=Nco6E0qjz7A", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=Nco6E0qjz7A", + "duration": "PT1H10M45S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.KaCENz6RuziGZw_1508841951&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 5912788, + "videoId": "678638BB913E3784A029678638BB913E3784A029", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=D3A9349991E1B6BD338ED3A9349991E1B6BD338E", + "name": "train car wash | car cartoons for children | kids video", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.Z6963FYweRUTZrcesxfbdwEsCo&pid=Api", + "datePublished": "2016-08-29T09:55:15.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=VxXgMajxyk4", + "hostPageUrl": "https://www.youtube.com/watch?v=VxXgMajxyk4", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=VxXgMajxyk4", + "duration": "PT41M33S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.jjO9tuGRmTSp0w_1501917499&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 7257139, + "videoId": "D3A9349991E1B6BD338ED3A9349991E1B6BD338E", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=2FF0104C87A7ACE641362FF0104C87A7ACE64136", + "name": "Police Car Wash | videos For Children | videos for kids", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.g9jWn5SyL2oZ0eJkyPe7fwEsCo&pid=Api", + "datePublished": "2014-09-05T14:28:23.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Kids Channel - Cartoon Videos for Kids" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=nMDnm5TyG4w", + "hostPageUrl": "https://www.youtube.com/watch?v=nMDnm5TyG4w", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=nMDnm5TyG4w", + "duration": "PT2M32S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.NkHmrKeHTBDwLw_1504053689&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 44940799, + "videoId": "2FF0104C87A7ACE641362FF0104C87A7ACE64136", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=4E26CE671544845D9EB94E26CE671544845D9EB9", + "name": "Police Cars Fire Trucks And Ambulance Responding Compilation Part 6", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.JzHoDzXHMeaj_XW9uHL4qAEsCo&pid=Api", + "datePublished": "2016-04-30T13:21:03.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Demonracer2" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=loSDJk3VjdI", + "hostPageUrl": "https://www.youtube.com/watch?v=loSDJk3VjdI", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=loSDJk3VjdI", + "duration": "PT11M2S", + "motionThumbnailUrl": "https://tse2.mm.bing.net/th?id=OM.uZ5dhEQVZ84mTg_1505274246&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 2644389, + "videoId": "4E26CE671544845D9EB94E26CE671544845D9EB9", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=ABDEF167D83FD89F7CC0ABDEF167D83FD89F7CC0", + "name": "The Car Patrol: fire truck and police car in Amber's siren is stolen in Car City Trucks Cartoons", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OVP.ef25OP9x1mxQ5v_XzBNTuwEsCo&pid=Api", + "datePublished": "2017-01-10T18:48:27.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Car City" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=uT0MTubFXRQ", + "hostPageUrl": "https://www.youtube.com/watch?v=uT0MTubFXRQ", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=uT0MTubFXRQ", + "duration": "PT33M40S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.wHyf2D%2fYZ%2fHeqw_1502909456&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 6192700, + "videoId": "ABDEF167D83FD89F7CC0ABDEF167D83FD89F7CC0", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=1DBC3BB20E174787AAAC1DBC3BB20E174787AAAC", + "name": "My Red Police Car - My Magic Pet Morphle Compilation with Police Vehicle Videos for Kids!", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.yKZcfXb-kLXrXcmOO9P7RQEsCo&pid=Api", + "datePublished": "2016-09-29T15:52:28.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Morphle TV" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=JvJzQdVnDuU", + "hostPageUrl": "https://www.youtube.com/watch?v=JvJzQdVnDuU", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=JvJzQdVnDuU", + "duration": "PT29M33S", + "motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.rKqHRxcOsju8HQ_1501397240&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 27075263, + "videoId": "1DBC3BB20E174787AAAC1DBC3BB20E174787AAAC", + "allowMobileEmbed": false, + "isSuperfresh": false + }, + { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=0BBA09552F8F5C5320CE0BBA09552F8F5C5320CE", + "name": "Car parking cartoon - cars cartoon- cars for kids - trains for children - toy factory cartoon", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.OiZe6oUi6joug0nPfE3jTAEsCo&pid=Api", + "datePublished": "2017-07-15T12:06:51.0000000", + "publisher": [ + { + "name": "YouTube" + } + ], + "creator": { + "name": "Toy Factory" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=fRCcbbjEV3U", + "hostPageUrl": "https://www.youtube.com/watch?v=fRCcbbjEV3U", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=fRCcbbjEV3U", + "duration": "PT14M20S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.ziBTXI8vVQm6Cw_1509023063&pid=Api", + "allowHttpsEmbed": true, + "viewCount": 3675116, + "videoId": "0BBA09552F8F5C5320CE0BBA09552F8F5C5320CE", + "allowMobileEmbed": false, + "isSuperfresh": false + } + ] + }, + "videoResult": { + "webSearchUrl": "https://www.bing.com/videos/search?q=&view=detail&mid=A9A6BF1A1882870A2BF1A9A6BF1A1882870A2BF1", + "name": "Cop Cars Kid Cartoon - The Police Car New Cars for kids & Trucks Cartoons for children", + "description": "Video for children with Cop Cars Kids Cartoon! Enjoy The Police Car New Kids Animation - Cars & Trucks Cartoons for children on the screen! Enjoy best educat...", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.IwahJWZR_3EraqgrED0rzwEsCo&pid=Api", + "datePublished": "2017-05-06T08:33:12.0000000", + "publisher": [ + { + "name": "YouTube" } + ], + "creator": { + "name": "Cars & Trains Cartoons" + }, + "isAccessibleForFree": true, + "contentUrl": "https://www.youtube.com/watch?v=wHpCrFP3WIg", + "hostPageUrl": "https://www.youtube.com/watch?v=wHpCrFP3WIg", + "encodingFormat": "h264", + "hostPageDisplayUrl": "https://www.youtube.com/watch?v=wHpCrFP3WIg", + "width": 1280, + "height": 720, + "duration": "PT1H3M17S", + "motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.8SsKh4IYGr%2bmqQ_1506858484&pid=Api", + "embedHtml": "", + "allowHttpsEmbed": true, + "viewCount": 3872833, + "thumbnail": { + "width": 300, + "height": 168 + }, + "videoId": "A9A6BF1A1882870A2BF1A9A6BF1A1882870A2BF1", + "allowMobileEmbed": true, + "isSuperfresh": false } + } } -} \ No newline at end of file + } +} + diff --git a/specification/cognitiveservices/data-plane/WebSearch/readme.md b/specification/cognitiveservices/data-plane/WebSearch/readme.md index 71ed2ad8c260..5fbe792636f8 100644 --- a/specification/cognitiveservices/data-plane/WebSearch/readme.md +++ b/specification/cognitiveservices/data-plane/WebSearch/readme.md @@ -26,7 +26,7 @@ These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) csharp: namespace: Microsoft.Azure.CognitiveServices.Search.WebSearch - output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/Search/Generated/WebSearch + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingWebSearch/Generated/WebSearch sync-methods: none ``` diff --git a/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json index 085f9f728d25..13339d2db972 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json @@ -4295,7 +4295,7 @@ "properties": { "passName": { "type": "string", - "description": "The pass name. Currently, the only allowable value is oobeSystem.", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", "enum": [ "OobeSystem" ], diff --git a/specification/compute/resource-manager/Microsoft.Compute/2017-09-01/skus.json b/specification/compute/resource-manager/Microsoft.Compute/2017-09-01/skus.json new file mode 100644 index 000000000000..b622669e17e0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/2017-09-01/skus.json @@ -0,0 +1,320 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2017-09-01" + }, + "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": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/skus": { + "get": { + "tags": [ + "Skus", + "AvailabilitySets" + ], + "operationId": "ResourceSkus_List", + "description": "Gets the list of Microsoft.Compute SKUs available for your Subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ResourceSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSkuCosts": { + "properties": { + "meterID": { + "type": "string", + "readOnly": true, + "description": "Used for querying price from commerce." + }, + "quantity": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The multiplier is needed to extend the base metered cost." + }, + "extendedUnit": { + "type": "string", + "readOnly": true, + "description": "An invariant to show the extended unit." + } + }, + "description": "Describes metadata for retrieving price info." + }, + "ResourceSkuCapabilities": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "An invariant to describe the feature." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "An invariant if the feature is measured by quantity." + } + }, + "description": "Describes The SKU capabilites object." + }, + "ResourceSkuRestrictions": { + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of restrictions.", + "enum": [ + "Location" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "readOnly": true, + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" + }, + "size": { + "readOnly": true, + "type": "string", + "description": "The Size of the SKU." + }, + "family": { + "readOnly": true, + "type": "string", + "description": "The Family of this particular SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + }, + "locations": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "apiVersions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The api versions that support this SKU." + }, + "costs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCosts" + }, + "description": "Metadata for retrieving price info." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "description": "A name value pair to describe the capability." + }, + "restrictions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available Compute SKU." + }, + "ResourceSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + } + } + }, + "ResourceSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Compute Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Compute List Skus operation response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/2017-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/2017-12-01/compute.json new file mode 100644 index 000000000000..2c6105866a54 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/2017-12-01/compute.json @@ -0,0 +1,6627 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2017-12-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be create or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineImageResource" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Lists all available virtual machine sizes for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the state of the virtual machine to generalized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "The operation to redeploy a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + } + }, + "description": "The List Availability Set operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size." + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + } + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResultProperties": { + "properties": { + "output": { + "type": "object", + "description": "Operation output data (raw JSON)" + } + }, + "description": "Compute-specific operation properties, including output" + }, + "VirtualMachineCaptureResult": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineCaptureResultProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Resource Id." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

[List all available virtual machine sizes in an availability set](virtualmachines-list-sizes-availability-set.md)

[List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md)

[List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md)", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": false + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": false + } + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of listener.

Possible values are:
**http**

**https**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "type": "string", + "description": "The console screenshot blob URI." + }, + "serialConsoleLogBlobUri": { + "type": "string", + "description": "The Linux serial console log blob Uri." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the virtual machine." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgrade": { + "type": "boolean", + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." + } + }, + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "required": [ + "osDisk" + ], + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot end in \".\"

    **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/definitions/Caching", + "description": "The caching type." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "description": "Specifies the IP configurations of the network interface." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "description": "The virtual machine scale set IP Configuration." + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "ComputeLongRunningOperationProperties": { + "properties": { + "output": { + "type": "object", + "description": "Operation output data (raw JSON)" + } + }, + "description": "Compute-specific operation properties, including output" + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "OperationStatusResponse": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation ID" + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Operation status" + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the operation" + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the operation" + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Api error" + } + }, + "description": "Operation status response" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 82ba31c14ff8..a52d98d8dfea 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,9 +34,21 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2017-03 +tag: package-2017-12 ``` +### Tag: package-2017-12 + +These settings apply only when `--tag=package-2017-12` is specified on the command line. + +``` yaml $(tag) == 'package-2017-12' +input-file: +- Microsoft.Compute/2017-12-01/compute.json +- Microsoft.Compute/2017-09-01/skus.json +- Microsoft.Compute/2017-03-30/disk.json +- Microsoft.Compute/2017-03-30/runCommands.json +- Microsoft.ContainerService/2017-01-31/containerService.json +``` ### Tag: package-2017-03 diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Dataset.json index 775526f4d6ad..4ec719347537 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Dataset.json @@ -1030,6 +1030,318 @@ "$ref": "#/definitions/DatasetCompression" } } + }, + "AmazonMWSObjectDataset" : { + "x-ms-discriminator-value": "AmazonMWSObject", + "description": "Amazon Marketplace Web Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "AzurePostgreSqlTableDataset" : { + "x-ms-discriminator-value": "AzurePostgreSqlTable", + "description": "Azure PostgreSQL dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ConcurObjectDataset" : { + "x-ms-discriminator-value": "ConcurObject", + "description": "Concur Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "CouchbaseTableDataset" : { + "x-ms-discriminator-value": "CouchbaseTable", + "description": "Couchbase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "DrillTableDataset" : { + "x-ms-discriminator-value": "DrillTable", + "description": "Drill server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "EloquaObjectDataset" : { + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GoogleBigQueryObjectDataset" : { + "x-ms-discriminator-value": "GoogleBigQueryObject", + "description": "Google BigQuery service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GreenplumTableDataset" : { + "x-ms-discriminator-value": "GreenplumTable", + "description": "Greenplum Database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HBaseObjectDataset" : { + "x-ms-discriminator-value": "HBaseObject", + "description": "HBase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HiveObjectDataset" : { + "x-ms-discriminator-value": "HiveObject", + "description": "Hive Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HubspotObjectDataset" : { + "x-ms-discriminator-value": "HubspotObject", + "description": "Hubspot Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ImpalaObjectDataset" : { + "x-ms-discriminator-value": "ImpalaObject", + "description": "Impala server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "JiraObjectDataset" : { + "x-ms-discriminator-value": "JiraObject", + "description": "Jira Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MagentoObjectDataset" : { + "x-ms-discriminator-value": "MagentoObject", + "description": "Magento server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MariaDBTableDataset" : { + "x-ms-discriminator-value": "MariaDBTable", + "description": "MariaDB server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MarketoObjectDataset" : { + "x-ms-discriminator-value": "MarketoObject", + "description": "Marketo server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PaypalObjectDataset" : { + "x-ms-discriminator-value": "PaypalObject", + "description": "Paypal Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PhoenixObjectDataset" : { + "x-ms-discriminator-value": "PhoenixObject", + "description": "Phoenix server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PrestoObjectDataset" : { + "x-ms-discriminator-value": "PrestoObject", + "description": "Presto server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "QuickBooksObjectDataset" : { + "x-ms-discriminator-value": "QuickBooksObject", + "description": "QuickBooks server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ServiceNowObjectDataset" : { + "x-ms-discriminator-value": "ServiceNowObject", + "description": "ServiceNow server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ShopifyObjectDataset" : { + "x-ms-discriminator-value": "ShopifyObject", + "description": "Shopify Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SparkObjectDataset" : { + "x-ms-discriminator-value": "SparkObject", + "description": "Spark Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SquareObjectDataset" : { + "x-ms-discriminator-value": "SquareObject", + "description": "Square Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "XeroObjectDataset" : { + "x-ms-discriminator-value": "XeroObject", + "description": "Xero Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ZohoObjectDataset" : { + "x-ms-discriminator-value": "ZohoObject", + "description": "Zoho server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/LinkedService.json index e0c7806f82ae..9d08e7a453e2 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/LinkedService.json @@ -1909,6 +1909,1655 @@ "server" ] }, + "AmazonMWSLinkedService": { + "x-ms-discriminator-value": "AmazonMWS", + "description": "Amazon Marketplace Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonMWSLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonMWSLinkedServiceTypeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)", + "type": "object" + }, + "marketplaceID": { + "description": "The Amazon Marketplace ID you want to retrieve data from. To retrive data from multiple Marketplace IDs, seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", + "type": "object" + }, + "sellerID": { + "description": "The Amazon seller ID.", + "type": "object" + }, + "mwsAuthToken": { + "description": "The Amazon MWS authentication token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessKeyId": { + "description": "The access key id used to access data.", + "type": "object" + }, + "secretKey": { + "description": "The secret key used to access data.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "marketplaceID", + "sellerID", + "accessKeyId" + ] + }, + "AzurePostgreSqlLinkedService": { + "x-ms-discriminator-value": "AzurePostgreSql", + "description": "Azure PostgreSQL linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzurePostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzurePostgreSqlLinkedServiceTypeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "ConcurLinkedService": { + "x-ms-discriminator-value": "Concur", + "description": "Concur Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Concur Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ConcurLinkedServiceTypeProperties": { + "description": "Concur Serivce linked service properties.", + "properties": { + "clientId": { + "description": "Application client_id supplied by Concur App Management.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Concur Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId", + "username" + ] + }, + "CouchbaseLinkedService": { + "x-ms-discriminator-value": "Couchbase", + "description": "Couchbase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Couchbase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CouchbaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CouchbaseLinkedServiceTypeProperties": { + "description": "Couchbase server linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "DrillLinkedService": { + "x-ms-discriminator-value": "Drill", + "description": "Drill server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Drill server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DrillLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DrillLinkedServiceTypeProperties": { + "description": "Drill server linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "EloquaLinkedService": { + "x-ms-discriminator-value": "Eloqua", + "description": "Eloqua server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Eloqua server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EloquaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "EloquaLinkedServiceTypeProperties": { + "description": "Eloqua server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)", + "type": "object" + }, + "username": { + "description": "The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "username" + ] + }, + "GoogleBigQueryLinkedService": { + "x-ms-discriminator-value": "GoogleBigQuery", + "description": "Google BigQuery service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google BigQuery service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleBigQueryLinkedServiceTypeProperties": { + "description": "Google BigQuery service linked service properties.", + "properties": { + "project": { + "description": "The default BigQuery project to query against.", + "type": "object" + }, + "additionalProjects": { + "description": "A comma-separated list of public BigQuery projects to access.", + "type": "object" + }, + "requestGoogleDriveScope": { + "description": "Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.", + "type": "object" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleBigQueryAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "project", + "authenticationType" + ] + }, + "GreenplumLinkedService": { + "x-ms-discriminator-value": "Greenplum", + "description": "Greenplum Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Greenplum Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GreenplumLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GreenplumLinkedServiceTypeProperties": { + "description": "Greenplum Database linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "HBaseLinkedService": { + "x-ms-discriminator-value": "HBase", + "description": "HBase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HBase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HBaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HBaseLinkedServiceTypeProperties": { + "description": "HBase server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the HBase server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism to use to connect to the HBase server.", + "type": "string", + "enum": [ + "Anonymous", + "Basic" + ], + "x-ms-enum": { + "name": "HBaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the HBase instance.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HiveLinkedService": { + "x-ms-discriminator-value": "Hive", + "description": "Hive Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hive Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HiveLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HiveLinkedServiceTypeProperties": { + "description": "Hive Server linked service properties.", + "properties": { + "host": { + "description": "IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).", + "type": "object" + }, + "port": { + "description": "The TCP port that the Hive server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Hive server.", + "type": "string", + "enum": [ + "HiveServer1", + "HiveServer2", + "HiveThriftServer" + ], + "x-ms-enum": { + "name": "HiveServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "HiveThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Hive server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "HiveAuthenticationType", + "modelAsString": true + } + }, + "serviceDiscoveryMode": { + "description": "true to indicate using the ZooKeeper service, false not.", + "type": "object" + }, + "zooKeeperNameSpace": { + "description": "The namespace on ZooKeeper under which Hive Server 2 nodes are added.", + "type": "object" + }, + "useNativeQuery": { + "description": "Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Hive Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Hive server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HubspotLinkedService": { + "x-ms-discriminator-value": "Hubspot", + "description": "Hubspot Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hubspot Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HubspotLinkedServiceTypeProperties": { + "description": "Hubspot Serivce linked service properties.", + "properties": { + "clientId": { + "description": "The client ID associated with your Hubspot application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Hubspot application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token obtained when initiallyĀ authenticatingĀ yourĀ OAuth integration.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "refreshToken": { + "description": "The refresh token obtained when initiallyĀ authenticatingĀ yourĀ OAuth integration.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "ImpalaLinkedService": { + "x-ms-discriminator-value": "Impala", + "description": "Impala server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Impala server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImpalaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ImpalaLinkedServiceTypeProperties": { + "description": "Impala server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Impala server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Impala server uses to listen for client connections. The default value is 21050.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Anonymous", + "SASLUsername", + "UsernameAndPassword" + ], + "x-ms-enum": { + "name": "ImpalaAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to access the Impala server. The default value is anonymous when using SASLUsername.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name when using UsernameAndPassword.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "JiraLinkedService": { + "x-ms-discriminator-value": "Jira", + "description": "Jira Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Jira Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JiraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "JiraLinkedServiceTypeProperties": { + "description": "Jira Serivce linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Jira Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username" + ] + }, + "MagentoLinkedService": { + "x-ms-discriminator-value": "Magento", + "description": "Magento server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Magento server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MagentoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MagentoLinkedServiceTypeProperties": { + "description": "Magento server linked service properties.", + "properties": { + "host": { + "description": "The URL of the Magento instance. (i.e. 192.168.222.110/magento3)", + "type": "object" + }, + "accessToken": { + "description": "The access token from Magento.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "MariaDBLinkedService": { + "x-ms-discriminator-value": "MariaDB", + "description": "MariaDB server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MariaDB server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MariaDBLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MariaDBLinkedServiceTypeProperties": { + "description": "MariaDB server linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "MarketoLinkedService": { + "x-ms-discriminator-value": "Marketo", + "description": "Marketo server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Marketo server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MarketoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MarketoLinkedServiceTypeProperties": { + "description": "Marketo server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)", + "type": "object" + }, + "clientId": { + "description": "The client Id of your Marketo service.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of your Marketo service.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + }, + "PaypalLinkedService": { + "x-ms-discriminator-value": "Paypal", + "description": "Paypal Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Paypal Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PaypalLinkedServiceTypeProperties": { + "description": "Paypal Serivce linked service properties.", + "properties": { + "host": { + "description": "The URLĀ of the PayPal instance. (i.e. api.sandbox.paypal.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your PayPal application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your PayPal application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId" + ] + }, + "PhoenixLinkedService": { + "x-ms-discriminator-value": "Phoenix", + "description": "Phoenix server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Phoenix server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PhoenixLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PhoenixLinkedServiceTypeProperties": { + "description": "Phoenix server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Phoenix server.", + "type": "string", + "enum": [ + "Anonymous", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "PhoenixAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Phoenix server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "PrestoLinkedService": { + "x-ms-discriminator-value": "Presto", + "description": "Presto server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Presto server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrestoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PrestoLinkedServiceTypeProperties": { + "description": "Presto server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Presto server. (i.e. 192.168.222.160)", + "type": "object" + }, + "serverVersion": { + "description": "The version of the Presto server. (i.e. 0.148-t)", + "type": "object" + }, + "catalog": { + "description": "The catalog context for all request against the server.", + "type": "object" + }, + "port": { + "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Presto server.", + "type": "string", + "enum": [ + "Anonymous", + "LDAP" + ], + "x-ms-enum": { + "name": "PrestoAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Presto server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "timeZoneID": { + "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "serverVersion", + "catalog", + "authenticationType" + ] + }, + "QuickBooksLinkedService": { + "x-ms-discriminator-value": "QuickBooks", + "description": "QuickBooks server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "QuickBooks server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuickBooksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "QuickBooksLinkedServiceTypeProperties": { + "description": "QuickBooks server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)", + "type": "object" + }, + "companyId": { + "description": "The company ID of the QuickBooks company to authorize.", + "type": "object" + }, + "accessToken": { + "description": "The access token for OAuth 1.0 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessTokenSecret": { + "description": "The access token secret for OAuth 1.0 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "companyId" + ] + }, + "ServiceNowLinkedService": { + "x-ms-discriminator-value": "ServiceNow", + "description": "ServiceNow server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ServiceNow server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceNowLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ServiceNowLinkedServiceTypeProperties": { + "description": "ServiceNow server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the ServiceNow server. (i.e. ServiceNowData.com)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "OAuth2" + ], + "x-ms-enum": { + "name": "ServiceNowAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name for Basic and OAuth2 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id for OAuth2 authentication.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret for OAuth2 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "authenticationType" + ] + }, + "ShopifyLinkedService": { + "x-ms-discriminator-value": "Shopify", + "description": "Shopify Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Shopify Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ShopifyLinkedServiceTypeProperties": { + "description": "Shopify Serivce linked service properties.", + "properties": { + "host": { + "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", + "type": "object" + }, + "accessToken": { + "description": "The API access token that can be used to access Shopifyā€™s data. The token won't expire if it is offline mode.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "SparkLinkedService": { + "x-ms-discriminator-value": "Spark", + "description": "Spark Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Spark Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SparkLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SparkLinkedServiceTypeProperties": { + "description": "Spark Server linked service properties.", + "properties": { + "host": { + "description": "IP address or host name of the Spark server", + "type": "object" + }, + "port": { + "description": "The TCP port that the Spark server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Spark server.", + "type": "string", + "enum": [ + "SharkServer", + "SharkServer2", + "SparkThriftServer" + ], + "x-ms-enum": { + "name": "SparkServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "SparkThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Spark server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "SparkAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name that you use to access Spark Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Spark server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "port", + "authenticationType" + ] + }, + "SquareLinkedService": { + "x-ms-discriminator-value": "Square", + "description": "Square Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Square Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SquareLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SquareLinkedServiceTypeProperties": { + "description": "Square Serivce linked service properties.", + "properties": { + "host": { + "description": "The URLĀ of the Square instance. (i.e. mystore.mysquare.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your Square application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Square application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "redirectUri": { + "description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)", + "type": "object" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId", + "redirectUri" + ] + }, + "XeroLinkedService": { + "x-ms-discriminator-value": "Xero", + "description": "Xero Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Xero Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XeroLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "XeroLinkedServiceTypeProperties": { + "description": "Xero Serivce linked service properties.", + "properties": { + "host": { + "description": "The endpoint of the Xero server. (i.e. api.xero.com)", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key associated with the Xero application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "privateKey": { + "description": "The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings(\n).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "ZohoLinkedService": { + "x-ms-discriminator-value": "Zoho", + "description": "Zoho server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Zoho server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ZohoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ZohoLinkedServiceTypeProperties": { + "description": "Zoho server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)", + "type": "object" + }, + "accessToken": { + "description": "The access token for Zoho authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint" + ] + }, "HDInsightOnDemandLinkedService": { "x-ms-discriminator-value": "HDInsightOnDemand", "description": "HDInsight ondemand linked service.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Pipeline.json index 166ac835bbd1..07219ff71d54 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Pipeline.json @@ -588,6 +588,396 @@ } } }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, "AmazonRedshiftSource": { "description": "A copy activity source for Amazon Redshift Source.", "type": "object", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Trigger.json index e428ab333549..8d3e7cea460e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/entityTypes/Trigger.json @@ -18,13 +18,6 @@ "description": "Trigger description.", "type": "string" }, - "pipelines": { - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/TriggerPipelineReference" - }, - "description": "Pipelines that need to be started." - }, "runtimeState": { "$ref": "#/definitions/TriggerRuntimeState", "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", @@ -48,12 +41,30 @@ "modelAsString": true } }, + "MultiplePipelineTrigger": { + "x-ms-discriminator-value": "MultiplePipelineTrigger", + "description": "Base class for all triggers that support one to many model for trigger to pipeline.", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipelines": { + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/TriggerPipelineReference" + }, + "description": "Pipelines that need to be started." + } + } + }, "ScheduleTrigger": { "description": "Trigger that creates pipeline runs periodically, on schedule.", "type": "object", "allOf": [ { - "$ref": "#/definitions/Trigger" + "$ref": "#/definitions/MultiplePipelineTrigger" } ], "properties": { @@ -219,7 +230,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/Trigger" + "$ref": "#/definitions/MultiplePipelineTrigger" } ], "properties": { @@ -250,6 +261,97 @@ "required": [ "typeProperties" ] + }, + "TumblingWindowTrigger": { + "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../datafactory.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." + }, + "typeProperties": { + "description": "Tumbling Window Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "frequency": { + "$ref": "#/definitions/TumblingWindowFrequency", + "description": "The frequency of the time windows." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "delay": { + "type": "object", + "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy that will be applied for failed pipeline runs." + } + }, + "required": [ + "frequency", + "interval", + "startTime", + "maxConcurrency" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + }, + "TumblingWindowFrequency": { + "description": "Enumerates possible frequency option for the tumbling window trigger.", + "type": "string", + "enum": [ + "Minute", + "Hour" + ], + "x-ms-enum": { + "name": "TumblingWindowFrequency", + "modelAsString": true + } + }, + "RetryPolicy": { + "description": "Execution policy for an activity.", + "properties": { + "count": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "intervalInSeconds": { + "description": "Interval between retries in seconds. Default is 30.", + "type": "integer", + "minimum": 30, + "maximum": 86400 + } + } } } } diff --git a/specification/operationalinsights/data-plane/readme.md b/specification/operationalinsights/data-plane/readme.md index 7c0448bed58a..881155b9a521 100644 --- a/specification/operationalinsights/data-plane/readme.md +++ b/specification/operationalinsights/data-plane/readme.md @@ -51,8 +51,8 @@ Please also specify `--csharp-sdks-folder=