swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector DataLakeConnector API schemes: - https tags: - name: DataLakeConnector paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/dataLakeConnector : get: operationId: microsoftAzureDatalakeconnectorListbymqresource tags: - DataLakeConnector description: List DataLakeConnectorResource resources by MqResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: mqName in: path description: Name of MQ resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/DataLakeConnectorResourceListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DataLakeConnector_ListByMqResource: $ref: ./examples/DataLakeConnector_ListByMqResource_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/dataLakeConnector/{dataLakeConnectorName} : get: operationId: microsoftAzureDatalakeconnectorGet tags: - DataLakeConnector description: Get a DataLakeConnectorResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: mqName in: path description: Name of MQ resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: dataLakeConnectorName in: path description: Name of MQ dataLakeConnector resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/DataLakeConnectorResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DataLakeConnector_Get: $ref: ./examples/DataLakeConnector_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname put: operationId: microsoftAzureDatalakeconnectorCreateorupdate tags: - DataLakeConnector description: Create a DataLakeConnectorResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: mqName in: path description: Name of MQ resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: dataLakeConnectorName in: path description: Name of MQ dataLakeConnector resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/DataLakeConnectorResource' responses: '200': description: Resource 'DataLakeConnectorResource' update operation succeeded schema: $ref: '#/definitions/DataLakeConnectorResource' '201': description: Resource 'DataLakeConnectorResource' create operation succeeded schema: $ref: '#/definitions/DataLakeConnectorResource' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DataLakeConnector_CreateOrUpdate: $ref: ./examples/DataLakeConnector_CreateOrUpdate_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname patch: operationId: microsoftAzureDatalakeconnectorUpdate tags: - DataLakeConnector description: Update a DataLakeConnectorResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: mqName in: path description: Name of MQ resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: dataLakeConnectorName in: path description: Name of MQ dataLakeConnector resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/DataLakeConnectorResourceUpdate' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/DataLakeConnectorResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DataLakeConnector_Update: $ref: ./examples/DataLakeConnector_Update_MaximumSet_Gen.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname delete: operationId: microsoftAzureDatalakeconnectorDelete tags: - DataLakeConnector description: Delete a DataLakeConnectorResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: mqName in: path description: Name of MQ resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: dataLakeConnectorName in: path description: Name of MQ dataLakeConnector resource required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DataLakeConnector_Delete: $ref: ./examples/DataLakeConnector_Delete_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname definitions: DataLakeFabricStorageUpdate: type: object description: DataLake Fabric Storage details. properties: authentication: $ref: '#/definitions/DataLakeFabricStorageAuthenticationUpdate' description: DataLake fabric storage authentication details. endpoint: type: string description: DataLake fabric storage endpoint to use. fabricPath: $ref: '#/definitions/FabricPathType' description: Fabric path type to use. guids: $ref: '#/definitions/FabricGuidsUpdate' description: Fabric one lake Guids. names: $ref: '#/definitions/FabricNamesUpdate' description: Fabric one lake Names. DataLakeServiceStorageAuthenticationUpdate: type: object description: DataLake Service Storage authentication details. NOTE - Enum only one method is supported. properties: accessTokenSecretName: type: string description: Access token secret name. systemAssignedManagedIdentity: $ref: '#/definitions/ManagedIdentityAuthenticationUpdate' description: Configuration for managed identity authentication. DataLakeFabricStorage: type: object description: DataLake Fabric Storage details. properties: authentication: $ref: '#/definitions/DataLakeFabricStorageAuthentication' description: DataLake fabric storage authentication details. endpoint: type: string description: DataLake fabric storage endpoint to use. fabricPath: $ref: '#/definitions/FabricPathType' description: Fabric path type to use. guids: $ref: '#/definitions/FabricGuids' description: Fabric one lake Guids. names: $ref: '#/definitions/FabricNames' description: Fabric one lake Names. required: - authentication - endpoint - fabricPath DataLakeConnectorResource: type: object description: MQ dataLakeConnector resource properties: properties: $ref: '#/definitions/DataLakeConnectorProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create extendedLocation: $ref: '#/definitions/ExtendedLocationProperty' description: Extended Location x-ms-mutability: - read - create required: - extendedLocation allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource DataLakeLocalStorage: type: object description: DataLake Local Storage details. properties: volumeName: type: string description: Volume name to write to. required: - volumeName MqttProtocol: type: string description: Mqtt Protocol types enum: - v3 - v5 x-ms-enum: name: MqttProtocol modelAsString: true values: - name: v3 value: v3 description: Mqttv3 - name: v5 value: v5 description: Mqttv5 FabricNames: type: object description: Fabric one lake names. properties: lakehouseName: type: string description: Fabric one lake house name. workspaceName: type: string description: Fabric one lake workspace name. required: - lakehouseName - workspaceName LocalBrokerConnectionSpec: type: object description: Mqtt Local Broker ConnectionSpec details properties: authentication: $ref: '#/definitions/LocalBrokerAuthenticationMethods' description: The authentication methods for LocalBroker connection. NOTE - Enum only one method at a time is supported. endpoint: type: string description: The endpoint of local broker to connect to. default: aio-mq-dmqtt-frontend:1883 tls: $ref: '#/definitions/LocalBrokerConnectionTls' description: TLS details for Local broker Connection. DataLakeServiceStorageAuthentication: type: object description: DataLake Service Storage authentication details. NOTE - Enum only one method is supported. properties: accessTokenSecretName: type: string description: Access token secret name. systemAssignedManagedIdentity: $ref: '#/definitions/ManagedIdentityAuthentication' description: Configuration for managed identity authentication. DataLakeConnectorResourceListResult: type: object description: The response of a DataLakeConnectorResource list operation. properties: value: type: array description: The DataLakeConnectorResource items on this page items: $ref: '#/definitions/DataLakeConnectorResource' nextLink: type: string format: uri description: The link to the next page of items required: - value DataLakeDatabaseFormat: type: string description: DataLake possible database formats enum: - delta - parquet x-ms-enum: name: DataLakeDatabaseFormat modelAsString: true values: - name: delta value: delta description: Delta format. - name: parquet value: parquet description: Parquet format. ExtendedLocationProperty: type: object description: ExtendedLocation properties properties: name: type: string description: The name of the extended location. type: $ref: '#/definitions/ExtendedLocationType' description: Type of ExtendedLocation. required: - name - type LocalBrokerConnectionTls: type: object description: Mqtt Local Broker Connection TLS details properties: tlsEnabled: type: boolean description: Tls Enabled on Local Broker Connection. default: false trustedCaCertificateConfigMap: type: string description: Trusted CA certificate config map name for Local Broker. FabricPathType: type: string description: Fabric path type to use. enum: - files - tables x-ms-enum: name: FabricPathType modelAsString: true values: - name: files value: files description: Fabric path type is Files. - name: tables value: tables description: Fabric path type is Tables. DataLakeServiceStorageUpdate: type: object description: DataLake Service Storage details. properties: endpoint: type: string description: DataLake service storage endpoint to use. authentication: $ref: '#/definitions/DataLakeServiceStorageAuthenticationUpdate' description: DataLake service storage authentication details. NOTE - Enum only one method is supported. LocalBrokerAuthenticationMethodsUpdate: type: object description: Mqtt Local Broker Authentication details. Only one method at a time is supported. Default - kubernetes authentication properties: kubernetes: $ref: '#/definitions/LocalBrokerKubernetesAuthentication' description: Kubernetes local broker authentication method. DataLakeTargetStorageUpdate: type: object description: Target storage for the DataLake. NOTE - Enum only storage is supported at a time. properties: datalakeStorage: $ref: '#/definitions/DataLakeServiceStorageUpdate' description: DataLake service storage details. localStorage: $ref: '#/definitions/DataLakeLocalStorageUpdate' description: Local storage details. fabricOneLake: $ref: '#/definitions/DataLakeFabricStorageUpdate' description: Fabric one lake storage details. DataLakeLocalStorageUpdate: type: object description: DataLake Local Storage details. properties: volumeName: type: string description: Volume name to write to. FabricGuids: type: object description: Fabric one lake guids. properties: lakehouseGuid: type: string description: Fabric one lake house guid. workspaceGuid: type: string description: Fabric one lake workspace guid. required: - lakehouseGuid - workspaceGuid DataLakeFabricStorageAuthentication: type: object description: DataLake Fabric Storage authentication details. properties: systemAssignedManagedIdentity: $ref: '#/definitions/ManagedIdentityAuthentication' description: Configuration for managed identity authentication. required: - systemAssignedManagedIdentity DataLakeConnectorResourceUpdateProperties: type: object description: The updatable properties of the DataLakeConnectorResource. properties: databaseFormat: $ref: '#/definitions/DataLakeDatabaseFormat' description: DataLake database format to use. image: $ref: '#/definitions/ContainerImageUpdate' description: The details of DataLakeConnector Docker Image. instances: type: integer format: int32 description: The number of DataLakeConnector pods to spin up. minimum: 0 maximum: 65535 localBrokerConnection: $ref: '#/definitions/LocalBrokerConnectionSpecUpdate' description: The details for connecting with Local Broker. logLevel: type: string description: The log level of the DataLake Connector instances. nodeTolerations: $ref: '#/definitions/NodeTolerationsUpdate' description: The Node Tolerations for the DataLake Connector pods. protocol: $ref: '#/definitions/MqttProtocol' description: The protocol to use for connecting with Brokers. target: $ref: '#/definitions/DataLakeTargetStorageUpdate' description: The protocol to use for connecting with Brokers. NOTE - Enum only storage is supported at at time. DataLakeFabricStorageAuthenticationUpdate: type: object description: DataLake Fabric Storage authentication details. properties: systemAssignedManagedIdentity: $ref: '#/definitions/ManagedIdentityAuthenticationUpdate' description: Configuration for managed identity authentication. LocalBrokerConnectionSpecUpdate: type: object description: Mqtt Local Broker ConnectionSpec details properties: authentication: $ref: '#/definitions/LocalBrokerAuthenticationMethodsUpdate' description: The authentication methods for LocalBroker connection. NOTE - Enum only one method at a time is supported. endpoint: type: string description: The endpoint of local broker to connect to. default: aio-mq-dmqtt-frontend:1883 tls: $ref: '#/definitions/LocalBrokerConnectionTls' description: TLS details for Local broker Connection. ManagedIdentityAuthenticationUpdate: type: object description: Managed identity authentication details. properties: audience: type: string description: Token audience. extensionName: type: string description: Arc Extension name. NodeTolerationsUpdate: type: object description: Defines the Node Tolerations details properties: effect: type: string description: Toleration effect. key: type: string description: Toleration key. operator: type: string description: Toleration operator like 'Exists', 'Equal' etc. value: type: string description: Toleration Value. ContainerImageUpdate: type: object description: Defines the Docker image details properties: pullPolicy: type: string description: Image pull policy. pullSecrets: type: string description: Image pull secrets. repository: type: string description: The Docker image name. tag: type: string description: The Docker image tag. LocalBrokerAuthenticationMethods: type: object description: Mqtt Local Broker Authentication details. Only one method at a time is supported. Default - kubernetes authentication properties: kubernetes: $ref: '#/definitions/LocalBrokerKubernetesAuthentication' description: Kubernetes local broker authentication method. required: - kubernetes ContainerImage: type: object description: Defines the Docker image details properties: pullPolicy: type: string description: Image pull policy. pullSecrets: type: string description: Image pull secrets. repository: type: string description: The Docker image name. tag: type: string description: The Docker image tag. required: - repository - tag NodeTolerations: type: object description: Defines the Node Tolerations details properties: effect: type: string description: Toleration effect. key: type: string description: Toleration key. operator: type: string description: Toleration operator like 'Exists', 'Equal' etc. value: type: string description: Toleration Value. required: - effect - key - operator - value ManagedIdentityAuthentication: type: object description: Managed identity authentication details. properties: audience: type: string description: Token audience. extensionName: type: string description: Arc Extension name. required: - audience DataLakeConnectorResourceUpdate: type: object description: The type used for update operations of the DataLakeConnectorResource. properties: tags: type: object description: Resource tags. additionalProperties: type: string properties: $ref: '#/definitions/DataLakeConnectorResourceUpdateProperties' x-ms-client-flatten: true LocalBrokerKubernetesAuthentication: type: object description: Local Broker Kubernetes Authentication properties: secretPath: type: string description: Secret Path where SAT is mounted. default: /var/run/serviceaccount/localbroker serviceAccountTokenName: type: string description: Token name where SAT is mounted on secret path. default: sat FabricNamesUpdate: type: object description: Fabric one lake names. properties: lakehouseName: type: string description: Fabric one lake house name. workspaceName: type: string description: Fabric one lake workspace name. ProvisioningState: type: string description: The enum defining status of resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: Resource is getting provisioned. - name: Updating value: Updating description: Resource is Updating. - name: Deleting value: Deleting description: Resource is Deleting. - name: Accepted value: Accepted description: Resource has been Accepted. ExtendedLocationType: type: string description: The enum defining type of ExtendedLocation accepted. enum: - CustomLocation x-ms-enum: name: ExtendedLocationType modelAsString: true values: - name: CustomLocation value: CustomLocation description: CustomLocation type DataLakeServiceStorage: type: object description: DataLake Service Storage details. properties: endpoint: type: string description: DataLake service storage endpoint to use. authentication: $ref: '#/definitions/DataLakeServiceStorageAuthentication' description: DataLake service storage authentication details. NOTE - Enum only one method is supported. required: - endpoint - authentication DataLakeConnectorProperties: type: object description: MQ DataLakeConnector Resource properties properties: databaseFormat: $ref: '#/definitions/DataLakeDatabaseFormat' description: DataLake database format to use. image: $ref: '#/definitions/ContainerImage' description: The details of DataLakeConnector Docker Image. instances: type: integer format: int32 description: The number of DataLakeConnector pods to spin up. minimum: 0 maximum: 65535 localBrokerConnection: $ref: '#/definitions/LocalBrokerConnectionSpec' description: The details for connecting with Local Broker. logLevel: type: string description: The log level of the DataLake Connector instances. nodeTolerations: $ref: '#/definitions/NodeTolerations' description: The Node Tolerations for the DataLake Connector pods. protocol: $ref: '#/definitions/MqttProtocol' description: The protocol to use for connecting with Brokers. target: $ref: '#/definitions/DataLakeTargetStorage' description: The protocol to use for connecting with Brokers. NOTE - Enum only storage is supported at at time. provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true required: - databaseFormat - image - protocol - target DataLakeTargetStorage: type: object description: Target storage for the DataLake. NOTE - Enum only storage is supported at a time. properties: datalakeStorage: $ref: '#/definitions/DataLakeServiceStorage' description: DataLake service storage details. localStorage: $ref: '#/definitions/DataLakeLocalStorage' description: Local storage details. fabricOneLake: $ref: '#/definitions/DataLakeFabricStorage' description: Fabric one lake storage details. FabricGuidsUpdate: type: object description: Fabric one lake guids. properties: lakehouseGuid: type: string description: Fabric one lake house guid. workspaceGuid: type: string description: Fabric one lake workspace guid. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'