openapi-directory/api/azure.com/datafactory-IntegrationRuntime.json

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

{"openapi":"3.0.0","info":{"title":"DataFactoryManagementClient","version":"2017-09-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"datafactory-IntegrationRuntime","x-tags":["Azure","Microsoft"]},"paths":{},"servers":[{"url":"https://azure.local"}],"components":{"schemas":{"IntegrationRuntime":{"additionalProperties":{"type":"object"},"description":"Azure Data Factory nested object which serves as a compute resource for activities.","discriminator":{"propertyName":"type"},"properties":{"description":{"description":"Integration runtime description.","type":"string"},"type":{"$ref":"#/components/schemas/IntegrationRuntimeType"}},"required":["type"],"type":"object"},"IntegrationRuntimeAuthKeys":{"description":"The integration runtime authentication keys.","properties":{"authKey1":{"description":"The primary integration runtime authentication key.","type":"string"},"authKey2":{"description":"The secondary integration runtime authentication key.","type":"string"}},"type":"object"},"IntegrationRuntimeAutoUpdate":{"description":"The state of integration runtime auto update.","enum":["On","Off"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeAutoUpdate"}},"IntegrationRuntimeComputeProperties":{"additionalProperties":{"type":"object"},"description":"The compute resource properties for managed integration runtime.","properties":{"location":{"description":"The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities","type":"string"},"maxParallelExecutionsPerNode":{"description":"Maximum parallel executions count per node for managed integration runtime.","minimum":1,"type":"integer"},"nodeSize":{"description":"The node size requirement to managed integration runtime.","type":"string"},"numberOfNodes":{"description":"The required number of nodes for managed integration runtime.","minimum":1,"type":"integer"},"vNetProperties":{"$ref":"#/components/schemas/IntegrationRuntimeVNetProperties"}},"type":"object"},"IntegrationRuntimeConnectionInfo":{"additionalProperties":{"type":"object"},"description":"Connection information for encrypting the on-premises data source credentials.","properties":{"hostServiceUri":{"description":"The on-premises integration runtime host URL.","readOnly":true,"type":"string"},"identityCertThumbprint":{"description":"The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.","readOnly":true,"type":"string"},"isIdentityCertExprired":{"description":"Whether the identity certificate is expired.","readOnly":true,"type":"boolean"},"publicKey":{"description":"The public key for encrypting a credential when transferring the credential to the integration runtime.","readOnly":true,"type":"string"},"serviceToken":{"description":"The token generated in service. Callers use this token to authenticate to integration runtime.","readOnly":true,"type":"string"},"version":{"description":"The integration runtime version.","readOnly":true,"type":"string"}},"type":"object"},"IntegrationRuntimeCustomSetupScriptProperties":{"description":"Custom setup script properties for a managed dedicated integration runtime.","properties":{"blobContainerUri":{"description":"The URI of the Azure blob container that contains the custom setup script.","type":"string"},"sasToken":{"allOf":[{"description":"The base definition of a secret type.","discriminator":{"propertyName":"type"},"properties":{"type":{"description":"Type of the secret.","type":"string"}},"required":["type"],"type":"object"}],"description":"Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.","properties":{"value":{"description":"Value of secure string.","type":"string"}},"required":["value"],"type":"object","x-ms-discriminator-value":"SecureString"}},"type":"object"},"IntegrationRuntimeMonitoringData":{"description":"Get monitoring data response.","properties":{"name":{"description":"Integration runtime name.","type":"string"},"nodes":{"description":"Integration runtime node monitoring data.","items":{"$ref":"#/components/schemas/IntegrationRuntimeNodeMonitoringData"},"type":"array"}},"type":"object"},"IntegrationRuntimeNodeIpAddress":{"description":"The IP address of self-hosted integration runtime node.","properties":{"ipAddress":{"description":"The IP address of self-hosted integration runtime node.","readOnly":true,"type":"string"}},"type":"object"},"IntegrationRuntimeNodeMonitoringData":{"additionalProperties":{"type":"object"},"description":"Monitoring data for integration runtime node.","properties":{"availableMemoryInMB":{"description":"Available memory (MB) on the integration runtime node.","readOnly":true,"type":"integer"},"concurrentJobsLimit":{"description":"Maximum concurrent jobs on the integration runtime node.","readOnly":true,"type":"integer"},"concurrentJobsRunning":{"description":"The number of jobs currently running on the integration runtime node.","readOnly":true,"type":"integer"},"cpuUtilization":{"description":"CPU percentage on the integration runtime node.","readOnly":true,"type":"integer"},"maxConcurrentJobs":{"description":"The maximum concurrent jobs in this integration runtime.","readOnly":true,"type":"integer"},"nodeName":{"description":"Name of the integration runtime node.","readOnly":true,"type":"string"},"receivedBytes":{"description":"Received bytes on the integration runtime node.","readOnly":true,"type":"number"},"sentBytes":{"description":"Sent bytes on the integration runtime node.","readOnly":true,"type":"number"}},"type":"object"},"IntegrationRuntimeRegenerateKeyParameters":{"description":"Parameters to regenerate the authentication key.","properties":{"keyName":{"description":"The name of the authentication key to regenerate.","enum":["authKey1","authKey2"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeAuthKeyName"}}},"type":"object"},"IntegrationRuntimeSsisCatalogInfo":{"additionalProperties":{"type":"object"},"description":"Catalog information for managed dedicated integration runtime.","properties":{"catalogAdminPassword":{"allOf":[{"description":"The base definition of a secret type.","discriminator":{"propertyName":"type"},"properties":{"type":{"description":"Type of the secret.","type":"string"}},"required":["type"],"type":"object"}],"description":"Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.","properties":{"value":{"description":"Value of secure string.","type":"string"}},"required":["value"],"type":"object","x-ms-discriminator-value":"SecureString"},"catalogAdminUserName":{"description":"The administrator user name of catalog database.","maxLength":128,"minLength":1,"type":"string"},"catalogPricingTier":{"description":"The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/","enum":["Basic","Standard","Premium","PremiumRS"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeSsisCatalogPricingTier"}},"catalogServerEndpoint":{"description":"The catalog database server URL.","type":"string"}},"type":"object"},"IntegrationRuntimeSsisProperties":{"additionalProperties":{"type":"object"},"description":"SSIS properties for managed integration runtime.","properties":{"catalogInfo":{"$ref":"#/components/schemas/IntegrationRuntimeSsisCatalogInfo"},"customSetupScriptProperties":{"$ref":"#/components/schemas/IntegrationRuntimeCustomSetupScriptProperties"},"edition":{"description":"The edition for the SSIS Integration Runtime","enum":["Standard","Enterprise"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeEdition"}},"licenseType":{"description":"License type for bringing your own license scenario.","enum":["BasePrice","LicenseIncluded"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeLicenseType"}}},"type":"object"},"IntegrationRuntimeState":{"description":"The state of integration runtime.","enum":["Initial","Stopped","Started","Starting","Stopping","NeedRegistration","Online","Limited","Offline","AccessDenied"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeState"}},"IntegrationRuntimeStatus":{"additionalProperties":{"type":"object"},"description":"Integration runtime status.","discriminator":{"propertyName":"type"},"properties":{"dataFactoryName":{"description":"The data factory name which the integration runtime belong to.","readOnly":true,"type":"string"},"state":{"$ref":"#/components/schemas/IntegrationRuntimeState"},"type":{"$ref":"#/components/schemas/IntegrationRuntimeType"}},"type":"object"},"IntegrationRuntimeType":{"description":"The type of integration runtime.","enum":["Managed","SelfHosted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeType"}},"IntegrationRuntimeVNetProperties":{"additionalProperties":{"type":"object"},"description":"VNet properties for managed integration runtime.","properties":{"subnet":{"description":"The name of the subnet this integration runtime will join.","type":"string"},"vNetId":{"description":"The ID of the VNet that this integration runtime will join.","type":"string"}},"type":"object"},"LinkedIntegrationRuntime":{"description":"The linked integration runtime information.","properties":{"createTime":{"description":"The creating time of the linked integration runtime.","format":"date-time","readOnly":true,"type":"string"},"dataFactoryLocation":{"description":"The location of the data factory for which the linked integration runtime belong to.","readOnly":true,"type":"string"},"dataFactoryName":{"description":"The name of the data factory for which the linked integration runtime belong to.","readOnly":true,"type":"string"},"name":{"description":"The name of the linked integration runtime.","readOnly":true,"type":"string"},"subscriptionId":{"description":"The subscription ID for which the linked integration runtime belong to.","readOnly":true,"type":"string"}},"type":"object"},"LinkedIntegrationRuntimeKeyAuthorization":{"allOf":[{"$ref":"#/components/schemas/LinkedIntegrationRuntimeType"}],"description":"The key authorization type integration runtime.","properties":{"key":{"allOf":[{"description":"The base definition of a secret type.","discriminator":{"propertyName":"type"},"properties":{"type":{"description":"Type of the secret.","type":"string"}},"required":["type"],"type":"object"}],"description":"Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.","properties":{"value":{"description":"Value of secure string.","type":"string"}},"required":["value"],"type":"object","x-ms-discriminator-value":"SecureString"}},"required":["key"],"type":"object","x-ms-discriminator-value":"Key"},"LinkedIntegrationRuntimeRbacAuthorization":{"allOf":[{"$ref":"#/components/schemas/LinkedIntegrationRuntimeType"}],"description":"The role based access control (RBAC) authorization type integration runtime.","properties":{"resourceId":{"description":"The resource identifier of the integration runtime to be shared.","type":"string"}},"required":["resourceId"],"type":"object","x-ms-discriminator-value":"RBAC"},"LinkedIntegrationRuntimeType":{"description":"The base definition of a linked integration runtime.","discriminator":{"propertyName":"authorizationType"},"properties":{"authorizationType":{"description":"The authorization type for integration runtime sharing.","type":"string"}},"required":["authorizationType"],"type":"object"},"ManagedIntegrationRuntime":{"allOf":[{"$ref":"#/components/schemas/IntegrationRuntime"}],"description":"Managed integration runtime, including managed elastic and managed dedicated integration runtimes.","properties":{"state":{"$ref":"#/components/schemas/IntegrationRuntimeState"},"typeProperties":{"$ref":"#/components/schemas/ManagedIntegrationRuntimeTypeProperties"}},"required":["typeProperties"],"type":"object","x-ms-discriminator-value":"Managed"},"ManagedIntegrationRuntimeError":{"additionalProperties":{"type":"object"},"description":"Error definition for managed integration runtime.","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"Error message.","readOnly":true,"type":"string"},"parameters":{"description":"Managed integration runtime error parameters.","items":{"description":"Error message parameters.","type":"string"},"readOnly":true,"type":"array"},"time":{"description":"The time when the error occurred.","format":"date-time","readOnly":true,"type":"string"}}},"ManagedIntegrationRuntimeNode":{"additionalProperties":{"type":"object"},"description":"Properties of integration runtime node.","properties":{"errors":{"description":"The errors that occurred on this integration runtime node.","items":{"$ref":"#/components/schemas/ManagedIntegrationRuntimeError"},"type":"array"},"nodeId":{"description":"The managed integration runtime node id.","readOnly":true,"type":"string"},"status":{"description":"The managed integration runtime node status.","enum":["Starting","Available","Recycling","Unavailable"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ManagedIntegrationRuntimeNodeStatus"}}}},"ManagedIntegrationRuntimeOperationResult":{"additionalProperties":{"type":"object"},"description":"Properties of managed integration runtime operation result.","properties":{"activityId":{"description":"The activity id for the operation request.","readOnly":true,"type":"string"},"errorCode":{"description":"The error code.","readOnly":true,"type":"string"},"parameters":{"description":"Managed integration runtime error parameters.","items":{"description":"Error message parameters.","type":"string"},"readOnly":true,"type":"array"},"result":{"description":"The operation result.","readOnly":true,"type":"string"},"startTime":{"description":"The start time of the operation.","format":"date-time","readOnly":true,"type":"string"},"type":{"description":"The operation type. Could be start or stop.","readOnly":true,"type":"string"}}},"ManagedIntegrationRuntimeStatus":{"allOf":[{"$ref":"#/components/schemas/IntegrationRuntimeStatus"}],"description":"Managed integration runtime status.","properties":{"typeProperties":{"$ref":"#/components/schemas/ManagedIntegrationRuntimeStatusTypeProperties"}},"required":["typeProperties"],"type":"object","x-ms-discriminator-value":"Managed"},"ManagedIntegrationRuntimeStatusTypeProperties":{"description":"Managed integration runtime status type properties.","properties":{"createTime":{"description":"The time at which the integration runtime was created, in ISO8601 format.","format":"date-time","readOnly":true,"type":"string"},"lastOperation":{"$ref":"#/components/schemas/ManagedIntegrationRuntimeOperationResult"},"nodes":{"description":"The list of nodes for managed integration runtime.","items":{"$ref":"#/components/schemas/ManagedIntegrationRuntimeNode"},"readOnly":true,"type":"array"},"otherErrors":{"description":"The errors that occurred on this integration runtime.","items":{"$ref":"#/components/schemas/ManagedIntegrationRuntimeError"},"readOnly":true,"type":"array"}},"type":"object"},"ManagedIntegrationRuntimeTypeProperties":{"description":"Managed integration runtime type properties.","properties":{"computeProperties":{"$ref":"#/components/schemas/IntegrationRuntimeComputeProperties"},"ssisProperties":{"$ref":"#/components/schemas/IntegrationRuntimeSsisProperties"}},"type":"object"},"SelfHostedIntegrationRuntime":{"allOf":[{"$ref":"#/components/schemas/IntegrationRuntime"}],"description":"Self-hosted integration runtime.","properties":{"typeProperties":{"$ref":"#/components/schemas/SelfHostedIntegrationRuntimeTypeProperties"}},"type":"object","x-ms-discriminator-value":"SelfHosted"},"SelfHostedIntegrationRuntimeNode":{"additionalProperties":{"type":"object"},"description":"Properties of Self-hosted integration runtime node.","properties":{"capabilities":{"additionalProperties":{"type":"string"},"description":"The integration runtime capabilities dictionary","readOnly":true,"type":"object"},"concurrentJobsLimit":{"description":"Maximum concurrent jobs on the integration runtime node.","readOnly":true,"type":"integer"},"expiryTime":{"description":"The time at which the integration runtime will expire in ISO8601 format.","format":"date-time","readOnly":true,"type":"string"},"hostServiceUri":{"description":"URI for the host machine of the integration runtime.","readOnly":true,"type":"string"},"isActiveDispatcher":{"description":"Indicates whether this node is the active dispatcher for integration runtime requests.","readOnly":true,"type":"boolean"},"lastConnectTime":{"description":"The most recent time at which the integration runtime was connected in ISO8601 format.","format":"date-time","readOnly":true,"type":"string"},"lastEndUpdateTime":{"description":"The last time for the integration runtime node update end.","format":"date-time","readOnly":true,"type":"string"},"lastStartTime":{"description":"The time the node last started up.","format":"date-time","readOnly":true,"type":"string"},"lastStartUpdateTime":{"description":"The last time for the integration runtime node update start.","format":"date-time","readOnly":true,"type":"string"},"lastStopTime":{"description":"The integration runtime node last stop time.","format":"date-time","readOnly":true,"type":"string"},"lastUpdateResult":{"description":"The result of the last integration runtime node update.","enum":["None","Succeed","Fail"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeUpdateResult"}},"machineName":{"description":"Machine name of the integration runtime node.","readOnly":true,"type":"string"},"maxConcurrentJobs":{"description":"The maximum concurrent jobs in this integration runtime.","readOnly":true,"type":"integer"},"nodeName":{"description":"Name of the integration runtime node.","readOnly":true,"type":"string"},"registerTime":{"description":"The time at which the integration runtime node was registered in ISO8601 format.","format":"date-time","readOnly":true,"type":"string"},"status":{"description":"Status of the integration runtime node.","enum":["NeedRegistration","Online","Limited","Offline","Upgrading","Initializing","InitializeFailed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"SelfHostedIntegrationRuntimeNodeStatus"}},"version":{"description":"Version of the integration runtime node.","readOnly":true,"type":"string"},"versionStatus":{"description":"Status of the integration runtime node version.","readOnly":true,"type":"string"}}},"SelfHostedIntegrationRuntimeStatus":{"allOf":[{"$ref":"#/components/schemas/IntegrationRuntimeStatus"}],"description":"Self-hosted integration runtime status.","properties":{"typeProperties":{"$ref":"#/components/schemas/SelfHostedIntegrationRuntimeStatusTypeProperties"}},"required":["typeProperties"],"type":"object","x-ms-discriminator-value":"SelfHosted"},"SelfHostedIntegrationRuntimeStatusTypeProperties":{"description":"Self-hosted integration runtime status type properties.","properties":{"autoUpdate":{"$ref":"#/components/schemas/IntegrationRuntimeAutoUpdate"},"autoUpdateETA":{"description":"The estimated time when the self-hosted integration runtime will be updated.","format":"date-time","readOnly":true,"type":"string"},"capabilities":{"additionalProperties":{"type":"string"},"description":"Object with additional information about integration runtime capabilities.","readOnly":true,"type":"object"},"createTime":{"description":"The time at which the integration runtime was created, in ISO8601 format.","format":"date-time","readOnly":true,"type":"string"},"internalChannelEncryption":{"description":"It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).","enum":["NotSet","SslEncrypted","NotEncrypted"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationRuntimeInternalChannelEncryptionMode"}},"latestVersion":{"description":"The latest version on download center.","readOnly":true,"type":"string"},"links":{"description":"The list of linked integration runtimes that are created to share with this integration runtime.","items":{"$ref":"#/components/schemas/LinkedIntegrationRuntime"},"type":"array"},"localTimeZoneOffset":{"description":"The local time zone offset in hours.","readOnly":true,"type":"string"},"nodes":{"description":"The list of nodes for this integration runtime.","items":{"$ref":"#/components/schemas/SelfHostedIntegrationRuntimeNode"},"type":"array"},"pushedVersion":{"description":"The version that the integration runtime is going to update to.","readOnly":true,"type":"string"},"scheduledUpdateDate":{"description":"The date at which the integration runtime will be scheduled to update, in ISO8601 format.","format":"date-time","readOnly":true,"type":"string"},"serviceUrls":{"description":"The URLs for the services used in integration runtime backend service.","items":{"description":"The service URL","type":"string"},"readOnly":true,"type":"array"},"taskQueueId":{"description":"The task queue id of the integration runtime.","readOnly":true,"type":"string"},"updateDelayOffset":{"description":"The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours","readOnly":true,"type":"string"},"version":{"description":"Version of the integration runtime.","readOnly":true,"type":"string"},"versionStatus":{"description":"Status of the integration runtime version.","readOnly":true,"type":"string"}},"type":"object"},"SelfHostedIntegrationRuntimeTypeProperties":{"description":"The self-hosted integration runtime properties.","properties":{"linkedInfo":{"$ref":"#/components/schemas/LinkedIntegrationRuntimeType"}},"type":"object"},"SsisObjectMetadata":{"description":"SSIS object metadata.","discriminator":{"propertyName":"type"},"properties":{"description":{"description":"Metadata description.","type":"string"},"id":{"description":"Metadata id.","format":"int64","type":"integer"},"name":{"description":"Metadata name.","type":"string"},"type":{"$ref":"#/components/schemas/SsisObjectMetadataType"}},"type":"object"},"SsisObjectMetadataListResponse":{"description":"A list of SSIS object metadata.","properties":{"nextLink":{"description":"The link to the next page of results, if any remaining results exist.","type":"string"},"value":{"description":"List of SSIS object metadata.","items":{"$ref":"#/components/schemas/SsisObjectMetadata"},"type":"array"}},"type":"object"},"SsisObjectMetadataType":{"description":"The type of SSIS object metadata.","enum":["Folder","Project","Package","Environment"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SsisObjectMetadataType"}}}}}