Microsoft.HybridData (stable:2019-06-01)

2025/09/29 • 29 deleted methods

Operations_List (removed)
Description :  The list of operations for Microsoft.HybridData provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridData/operations
{
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or Sets Name of the operations ,
Required: True ,
}
string ,
display:
{
Description: Gets or sets Display information Contains the localized display information for this particular operation/action ,
Required: False ,
}
{
provider:
{
Description: Gets or sets Provider The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with “Microsoft” for 1st party services. ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets Resource The localized friendly form of the resource type related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing – for examples, please refer to the “name” section. ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets Operation The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing and include the entity/resource to which it applies. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets Description The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Gets or sets Origin The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is “user,system” ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets Properties Reserved for future use ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for the next set of operations. ,
Required: False ,
}
string ,
}
DataManagers_List (removed)
Description :  Lists all the data manager resources available under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridData/dataManagers
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data manager resources. ,
Required: False ,
}
[
{
etag:
{
Description: Etag of the Resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of data stores. ,
Required: False ,
}
string ,
}
DataManagers_ListByResourceGroup (removed)
Description :  Lists all the data manager resources available under the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data manager resources. ,
Required: False ,
}
[
{
etag:
{
Description: Etag of the Resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next set of data stores. ,
Required: False ,
}
string ,
}
DataManagers_Get (removed)
Description :  Gets information about the specified data manager resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Etag of the Resource. ,
Required: False ,
}
string ,
}
DataManagers_Create (removed)
Description :  Creates a new data manager resource with the specified parameters. Existing resources cannot be updated with this API and should instead be updated with the Update data manager resource API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
dataManager:
{
Description: Data manager resource details from request body. ,
Required: True ,
}
{
etag:
{
Description: Etag of the Resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: Etag of the Resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
DataManagers_Delete (removed)
Description :  Deletes a data manager resource in Microsoft Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DataManagers_Update (removed)
Description :  Updates the properties of an existing data manager resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The patch will be performed only if the ETag of the data manager resource on the server matches this value. ,
Required: False ,
}
string ,
dataManagerUpdateParameter:
{
Description: Data manager resource details from request body. ,
Required: True ,
}
{
sku:
{
Description: The sku type. ,
Required: False ,
}
{
name:
{
Description: The sku name. Required for data manager creation, optional for update. ,
Required: False ,
}
string ,
tier:
{
Description: The sku tier. This is based on the SKU name. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
etag:
{
Description: Etag of the Resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
DataServices_ListByDataManager (removed)
Description :  This method gets all the data services.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data services. ,
Required: False ,
}
[
{
properties:
{
Description: DataService properties. ,
Required: True ,
}
{
state:
{
Description: State of the data service. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
supportedDataSinkTypes:
{
Description: Supported data store types which can be used as a sink. ,
Required: False ,
}
[
string ,
]
,
supportedDataSourceTypes:
{
Description: Supported data store types which can be used as a source. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of data services. ,
Required: False ,
}
string ,
}
DataServices_Get (removed)
Description :  Gets the data service that matches the data service name given.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}
{
dataServiceName:
{
Description: The name of the data service that is being queried. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DataService properties. ,
Required: True ,
}
{
state:
{
Description: State of the data service. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
supportedDataSinkTypes:
{
Description: Supported data store types which can be used as a sink. ,
Required: False ,
}
[
string ,
]
,
supportedDataSourceTypes:
{
Description: Supported data store types which can be used as a source. ,
Required: False ,
}
[
string ,
]
,
}
,
}
JobDefinitions_ListByDataService (removed)
Description :  This method gets all the job definitions of the given data service name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions
{
dataServiceName:
{
Description: The data service type of interest. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of job definitions. ,
Required: False ,
}
[
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job definitions. ,
Required: False ,
}
string ,
}
JobDefinitions_Get (removed)
Description :  This method gets job definition object by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}
{
dataServiceName:
{
Description: The data service name of the job definition ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The job definition name that is being queried. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
JobDefinitions_CreateOrUpdate (removed)
Description :  Creates or updates a job definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}
{
dataServiceName:
{
Description: The data service type of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The job definition name to be created or updated. ,
Required: True ,
}
string ,
jobDefinition:
{
Description: Job Definition object to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
JobDefinitions_Delete (removed)
Description :  This method deletes the given job definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}
{
dataServiceName:
{
Description: The data service type of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The job definition name to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_ListByJobDefinition (removed)
Description :  This method gets all the jobs of a given job definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs
{
dataServiceName:
{
Description: The name of the data service of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the job definition for which jobs are needed. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of jobs. ,
Required: False ,
}
[
{
status:
{
Description: Status of the job. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Time at which the job ended in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Job properties. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable. ,
Enum:
{
NotCancellable: No description available. ,
Cancellable: No description available. ,
}
,
Required: True ,
}
enum ,
bytesProcessed:
{
Description: Number of bytes processed by the job as of now. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsProcessed:
{
Description: Number of items processed by the job as of now ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesToProcess:
{
Description: Number of bytes to be processed by the job in total. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemsToProcess:
{
Description: Number of items to be processed by the job in total ,
Format: int64 ,
Required: False ,
}
integer ,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
jobStages:
{
Description: List of stages that ran in the job ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. This is optional ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
jobDefinition:
{
Description: JobDefinition at the time of the run ,
Required: False ,
}
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
itemDetailsLink:
{
Description: Item Details Link to download files or see details ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: Name of the data source on which the job was triggered. ,
Required: False ,
}
string ,
dataSinkName:
{
Description: Name of the data sink on which the job was triggered. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of jobs. ,
Required: False ,
}
string ,
}
Jobs_Get (removed)
Description :  This method gets a data manager job given the jobId.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}
{
dataServiceName:
{
Description: The name of the data service of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the job definition of the job. ,
Required: True ,
}
string ,
jobId:
{
Description: The job id of the job queried. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$expand:
{
Description: $expand is supported on details parameter for job, which provides details on the job stages. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the job. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Time at which the job ended in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Job properties. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable. ,
Enum:
{
NotCancellable: No description available. ,
Cancellable: No description available. ,
}
,
Required: True ,
}
enum ,
bytesProcessed:
{
Description: Number of bytes processed by the job as of now. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsProcessed:
{
Description: Number of items processed by the job as of now ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesToProcess:
{
Description: Number of bytes to be processed by the job in total. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemsToProcess:
{
Description: Number of items to be processed by the job in total ,
Format: int64 ,
Required: False ,
}
integer ,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
jobStages:
{
Description: List of stages that ran in the job ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. This is optional ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
jobDefinition:
{
Description: JobDefinition at the time of the run ,
Required: False ,
}
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
itemDetailsLink:
{
Description: Item Details Link to download files or see details ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: Name of the data source on which the job was triggered. ,
Required: False ,
}
string ,
dataSinkName:
{
Description: Name of the data sink on which the job was triggered. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
}
Jobs_Cancel (removed)
Description :  Cancels the given job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/cancel
{
dataServiceName:
{
Description: The name of the data service of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the job definition of the job. ,
Required: True ,
}
string ,
jobId:
{
Description: The job id of the job queried. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_Resume (removed)
Description :  Resumes the given job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/resume
{
dataServiceName:
{
Description: The name of the data service of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: The name of the job definition of the job. ,
Required: True ,
}
string ,
jobId:
{
Description: The job id of the job queried. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
JobDefinitions_Run (removed)
Description :  This method runs a job instance of the given job definition.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/run
{
dataServiceName:
{
Description: The data service type of the job definition. ,
Required: True ,
}
string ,
jobDefinitionName:
{
Description: Name of the job definition. ,
Required: True ,
}
string ,
runParameters:
{
Description: Run time parameters for the job definition. ,
Required: True ,
}
{
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_ListByDataService (removed)
Description :  This method gets all the jobs of a data service type in a given resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobs
{
dataServiceName:
{
Description: The name of the data service of interest. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of jobs. ,
Required: False ,
}
[
{
status:
{
Description: Status of the job. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Time at which the job ended in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Job properties. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable. ,
Enum:
{
NotCancellable: No description available. ,
Cancellable: No description available. ,
}
,
Required: True ,
}
enum ,
bytesProcessed:
{
Description: Number of bytes processed by the job as of now. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsProcessed:
{
Description: Number of items processed by the job as of now ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesToProcess:
{
Description: Number of bytes to be processed by the job in total. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemsToProcess:
{
Description: Number of items to be processed by the job in total ,
Format: int64 ,
Required: False ,
}
integer ,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
jobStages:
{
Description: List of stages that ran in the job ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. This is optional ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
jobDefinition:
{
Description: JobDefinition at the time of the run ,
Required: False ,
}
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
itemDetailsLink:
{
Description: Item Details Link to download files or see details ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: Name of the data source on which the job was triggered. ,
Required: False ,
}
string ,
dataSinkName:
{
Description: Name of the data sink on which the job was triggered. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of jobs. ,
Required: False ,
}
string ,
}
DataStores_ListByDataManager (removed)
Description :  Gets all the data stores/repositories in the given resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of data stores. ,
Required: False ,
}
[
{
properties:
{
Description: DataStore properties. ,
Required: True ,
}
{
repositoryId:
{
Description: Arm Id for the manager resource to which the data source is associated. This is optional. ,
Required: False ,
}
string ,
state:
{
Description: State of the data source. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
extendedProperties:
{
Description: A generic json used differently by each data source type. ,
Required: False ,
}
object ,
dataStoreTypeId:
{
Description: The arm id of the data store type. ,
Required: True ,
}
string ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of data stores. ,
Required: False ,
}
string ,
}
DataStores_Get (removed)
Description :  This method gets the data store/repository by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}
{
dataStoreName:
{
Description: The data store/repository name queried. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DataStore properties. ,
Required: True ,
}
{
repositoryId:
{
Description: Arm Id for the manager resource to which the data source is associated. This is optional. ,
Required: False ,
}
string ,
state:
{
Description: State of the data source. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
extendedProperties:
{
Description: A generic json used differently by each data source type. ,
Required: False ,
}
object ,
dataStoreTypeId:
{
Description: The arm id of the data store type. ,
Required: True ,
}
string ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
DataStores_CreateOrUpdate (removed)
Description :  Creates or updates the data store/repository in the data manager.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}
{
dataStoreName:
{
Description: The data store/repository name to be created or updated. ,
Required: True ,
}
string ,
dataStore:
{
Description: The data store/repository object to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: DataStore properties. ,
Required: True ,
}
{
repositoryId:
{
Description: Arm Id for the manager resource to which the data source is associated. This is optional. ,
Required: False ,
}
string ,
state:
{
Description: State of the data source. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
extendedProperties:
{
Description: A generic json used differently by each data source type. ,
Required: False ,
}
object ,
dataStoreTypeId:
{
Description: The arm id of the data store type. ,
Required: True ,
}
string ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DataStore properties. ,
Required: True ,
}
{
repositoryId:
{
Description: Arm Id for the manager resource to which the data source is associated. This is optional. ,
Required: False ,
}
string ,
state:
{
Description: State of the data source. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
extendedProperties:
{
Description: A generic json used differently by each data source type. ,
Required: False ,
}
object ,
dataStoreTypeId:
{
Description: The arm id of the data store type. ,
Required: True ,
}
string ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
DataStores_Delete (removed)
Description :  This method deletes the given data store/repository.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}
{
dataStoreName:
{
Description: The data store/repository name to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
DataStoreTypes_ListByDataManager (removed)
Description :  Gets all the data store/repository types that the resource supports.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStoreTypes
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of DataStoreType. ,
Required: False ,
}
[
{
properties:
{
Description: DataStoreType properties. ,
Required: True ,
}
{
repositoryType:
{
Description: Arm type for the manager resource to which the data source type is associated. This is optional. ,
Required: False ,
}
string ,
state:
{
Description: State of the data store type. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
supportedDataServicesAsSink:
{
Description: Supported data services where it can be used as a sink. ,
Required: False ,
}
[
string ,
]
,
supportedDataServicesAsSource:
{
Description: Supported data services where it can be used as a source. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of data store types. ,
Required: False ,
}
string ,
}
DataStoreTypes_Get (removed)
Description :  Gets the data store/repository type given its name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStoreTypes/{dataStoreTypeName}
{
dataStoreTypeName:
{
Description: The data store/repository type name for which details are needed. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DataStoreType properties. ,
Required: True ,
}
{
repositoryType:
{
Description: Arm type for the manager resource to which the data source type is associated. This is optional. ,
Required: False ,
}
string ,
state:
{
Description: State of the data store type. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
supportedDataServicesAsSink:
{
Description: Supported data services where it can be used as a sink. ,
Required: False ,
}
[
string ,
]
,
supportedDataServicesAsSource:
{
Description: Supported data services where it can be used as a source. ,
Required: False ,
}
[
string ,
]
,
}
,
}
JobDefinitions_ListByDataManager (removed)
Description :  This method gets all the job definitions of the given data manager resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobDefinitions
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of job definitions. ,
Required: False ,
}
[
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of job definitions. ,
Required: False ,
}
string ,
}
Jobs_ListByDataManager (removed)
Description :  This method gets all the jobs at the data manager resource level.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobs
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
$filter:
{
Description: OData Filter options ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of jobs. ,
Required: False ,
}
[
{
status:
{
Description: Status of the job. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Time at which the job was started in UTC ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Time at which the job ended in UTC ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: Job properties. ,
Required: True ,
}
{
isCancellable:
{
Description: Describes whether the job is cancellable. ,
Enum:
{
NotCancellable: No description available. ,
Cancellable: No description available. ,
}
,
Required: True ,
}
enum ,
bytesProcessed:
{
Description: Number of bytes processed by the job as of now. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsProcessed:
{
Description: Number of items processed by the job as of now ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytesToProcess:
{
Description: Number of bytes to be processed by the job in total. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemsToProcess:
{
Description: Number of items to be processed by the job in total ,
Format: int64 ,
Required: False ,
}
integer ,
details:
{
Description: Details of a job run. This field will only be sent for expand details filter. ,
Required: False ,
}
{
jobStages:
{
Description: List of stages that ran in the job ,
Required: False ,
}
[
{
stageName:
{
Description: Name of the job stage. ,
Required: False ,
}
string ,
stageStatus:
{
Description: Status of the job stage. ,
Enum:
{
None: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
WaitingForAction: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Cancelling: No description available. ,
PartiallySucceeded: No description available. ,
}
,
Required: True ,
}
enum ,
jobStageDetails:
{
Description: Job Stage Details ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details for the stage. This is optional ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
jobDefinition:
{
Description: JobDefinition at the time of the run ,
Required: False ,
}
{
properties:
{
Description: JobDefinition properties. ,
Required: True ,
}
{
dataSourceId:
{
Description: Data Source Id associated to the job definition. ,
Required: True ,
}
string ,
dataSinkId:
{
Description: Data Sink Id associated to the job definition. ,
Required: True ,
}
string ,
schedules:
{
Description: Schedule for running the job definition ,
Required: False ,
}
[
{
name:
{
Description: Name of the schedule. ,
Required: False ,
}
string ,
policyList:
{
Description: A list of repetition intervals in ISO 8601 format. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
state:
{
Description: State of the job definition. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Supported: No description available. ,
}
,
Required: True ,
}
enum ,
lastModifiedTime:
{
Description: Last modified time of the job definition. ,
Format: date-time ,
Required: False ,
}
string ,
runLocation:
{
Description: This is the preferred geo location for the job to run. ,
Enum:
{
none: No description available. ,
australiaeast: No description available. ,
australiasoutheast: No description available. ,
brazilsouth: No description available. ,
canadacentral: No description available. ,
canadaeast: No description available. ,
centralindia: No description available. ,
centralus: No description available. ,
eastasia: No description available. ,
eastus: No description available. ,
eastus2: No description available. ,
japaneast: No description available. ,
japanwest: No description available. ,
koreacentral: No description available. ,
koreasouth: No description available. ,
southeastasia: No description available. ,
southcentralus: No description available. ,
southindia: No description available. ,
northcentralus: No description available. ,
northeurope: No description available. ,
uksouth: No description available. ,
ukwest: No description available. ,
westcentralus: No description available. ,
westeurope: No description available. ,
westindia: No description available. ,
westus: No description available. ,
westus2: No description available. ,
}
,
Required: False ,
}
enum ,
userConfirmation:
{
Description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. ,
Enum:
{
NotRequired: No description available. ,
Required: No description available. ,
}
,
Required: False ,
}
enum ,
dataServiceInput:
{
Description: A generic json used differently by each data service type. ,
Required: False ,
}
object ,
customerSecrets:
{
Description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. ,
Required: False ,
}
[
{
keyIdentifier:
{
Description: The identifier to the data service input object which this secret corresponds to. ,
Required: True ,
}
string ,
keyValue:
{
Description: It contains the encrypted customer secret. ,
Required: True ,
}
string ,
algorithm:
{
Description: The encryption algorithm used to encrypt data. ,
Enum:
{
None: No description available. ,
RSA1_5: No description available. ,
RSA_OAEP: No description available. ,
PlainText: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
errorDetails:
{
Description: Error details for failure. This is optional. ,
Required: False ,
}
[
{
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
recommendedAction:
{
Description: Recommended action for the error. ,
Required: False ,
}
string ,
exceptionMessage:
{
Description: Contains the non localized exception message ,
Required: False ,
}
string ,
}
,
]
,
itemDetailsLink:
{
Description: Item Details Link to download files or see details ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: Name of the data source on which the job was triggered. ,
Required: False ,
}
string ,
dataSinkName:
{
Description: Name of the data sink on which the job was triggered. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Top level error for the job. ,
Required: False ,
}
{
code:
{
Description: Error code that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of jobs. ,
Required: False ,
}
string ,
}
PublicKeys_ListByDataManager (removed)
Description :  This method gets the list view of public keys, however it will only have one element.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/publicKeys
{
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of public keys. ,
Required: False ,
}
[
{
properties:
{
Description: Public key property. ,
Required: True ,
}
{
dataServiceLevel1Key:
{
Description: Level one public key for encryption ,
Required: True ,
}
{
keyModulus:
{
Description: Modulus of the encryption key. ,
Required: True ,
}
string ,
keyExponent:
{
Description: Exponent of the encryption key. ,
Required: True ,
}
string ,
encryptionChunkSizeInBytes:
{
Description: The maximum byte size that can be encrypted by the key. For a key size larger than the size, break into chunks and encrypt each chunk, append each encrypted chunk with : to mark the end of the chunk. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
dataServiceLevel2Key:
{
Description: Level two public key for encryption ,
Required: True ,
}
{
keyModulus:
{
Description: Modulus of the encryption key. ,
Required: True ,
}
string ,
keyExponent:
{
Description: Exponent of the encryption key. ,
Required: True ,
}
string ,
encryptionChunkSizeInBytes:
{
Description: The maximum byte size that can be encrypted by the key. For a key size larger than the size, break into chunks and encrypt each chunk, append each encrypted chunk with : to mark the end of the chunk. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link for the next set of public keys. ,
Required: False ,
}
string ,
}
PublicKeys_Get (removed)
Description :  This method gets the public keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/publicKeys/{publicKeyName}
{
publicKeyName:
{
Description: Name of the public key. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name ,
Required: True ,
}
string ,
dataManagerName:
{
Description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Public key property. ,
Required: True ,
}
{
dataServiceLevel1Key:
{
Description: Level one public key for encryption ,
Required: True ,
}
{
keyModulus:
{
Description: Modulus of the encryption key. ,
Required: True ,
}
string ,
keyExponent:
{
Description: Exponent of the encryption key. ,
Required: True ,
}
string ,
encryptionChunkSizeInBytes:
{
Description: The maximum byte size that can be encrypted by the key. For a key size larger than the size, break into chunks and encrypt each chunk, append each encrypted chunk with : to mark the end of the chunk. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
dataServiceLevel2Key:
{
Description: Level two public key for encryption ,
Required: True ,
}
{
keyModulus:
{
Description: Modulus of the encryption key. ,
Required: True ,
}
string ,
keyExponent:
{
Description: Exponent of the encryption key. ,
Required: True ,
}
string ,
encryptionChunkSizeInBytes:
{
Description: The maximum byte size that can be encrypted by the key. For a key size larger than the size, break into chunks and encrypt each chunk, append each encrypted chunk with : to mark the end of the chunk. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}