Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The

...

Azure Identity Connector can be configured by using the

...

REST API.

...

The following  pages describe the necessary objects to be created:

  • Connection
  • Connector
  • Seed

Bellow are the examples of how to create the Connection and the Seed. For the Connector please check this page.

Panel
titleOn this page

Table of Contents

Create Connection

...

[ ]

...

[ ]

...

Example

Saga_json
TitlePOST aspire/_api/connections
{
    "type": "filesystem",
    "description": "FileSystem Test Connector",
    "properties": {
        "url": "C:\\Directory",
        "ignoreSymLinks": true,
        "stopOnScanError": true,
        "indexContainers": true,
        "scanExcludedItems": true,
        "ignoreSymLinks": true,
        "includes": ".*\\.txt",
        "excludes": ".*\\.png",
        "staticAcl": [{
                "name": "test-user",
                "domain": "test-domain",
                "entity": "user",
                "access": "allow"
            }, {
                "name": "test-group",
                "domain": "",
                "entity": "group",
                "access": "deny"
            }
        ]
    }
}

Update connection

...

[ ]

...

[ ]

...

Example

Saga_json
TitlePUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0
{
    "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
    "type": "filesystem",
    "description": "FileSystem Test Connector",
    "properties": {
        "url": "C:\\Directory",
        "ignoreSymLinks": true,
        "stopOnScanError": true,
        "indexContainers": true,
        "scanRecursively": true,
        "scanExcludedItems": true,
        "includes": ".*\\.txt",
        "excludes": ".*\\.png",
        "staticAcl": [{
                "name": "test-user",
                "domain": "test-domain",
                "entity": "user",
                "access": "allow"
            }, {
                "name": "test-group",
                "domain": "",
                "entity": "group",
                "access": "deny"
            }
        ]
    }
}

Create Seed

...

Example

Saga_json
TitlePOST aspire/_api/seeds
{
    "type": "filesystem",
    "seed": "directory",
    "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
    "description": "FileSystem_Test_Seed",
    "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
    "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag1", "tag2"],
    "properties": {
        "seed": "directory"
    }
}

Update Seed

...

Example

...

TitlePUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

...


Credentials

Configure the Credentials to be used by the Connection object  when using the Aspire REST API.

Connection

Configure the Connection to be used by the Azure Identity Connector when using the Aspire REST API.

Connector

Configure the Azure Identity Connector properties when using the Aspire REST API.

Seed

Configure the Seed for the different Azure Identity Connectors when using the Aspire REST API.

...