Versions Compared

Key

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


REST API Connection configuration guidelines can be found here.

Azure Identity Connector's Connection type must always be specified as "azure-identity".

Properties specific to the Azure Identity Connector's Connection are described below.


Panel
titleOn this page

Table of Contents

Azure Identity Connection Properties


FieldRequiredDefaultMultipleNotesExample
propertiesYes-NoConfiguration object
tenantDomainYes-NoThe Azure tenant domain to be used."myTenantDomain.onmicrosoft.com"
identityCacheSizeNo-NoThe maximum number of identities to be cached.150
maxProcessThreadsNo10NoThe maximum number of processing threads for the identity extraction process.15
useProxyNofalseNoEnables the use of a proxy to get access to Azure endpoints.true
proxyHostIf useProxy is  set to true-NoThe address of the proxy to be used."http://myproxy.mycompany.com"
proxyPortIf useProxy is  set to true-NoThe port of the proxy to be used.9027
socketTimeoutNo"60000ms"NoSocket timeout value."100s120s"
connectTimeoutNo"60000ms"NoConnection timeout value"100s120s"
connectionRequestTimeoutNo"60000ms"NoConnection request timeout value"100s120s"
maxConnectionsNo150NoMaximum number of connection to the different Azure endpoints used.200
maxConnectionsPerRouteNo15NoMaximum number of connection to a specific Azure endpoint.20



Usage example


Saga_json
TitlePOST /aspire/_api/credentials
{
    "credential":"aa1bc268-8b54-4ea3-b43d-a15b665d04de",
    "type": "azure-identity",
    "description": "Azure Identity Connection Test",
    "properties": {
		"tenantDomain":"myTenantDomain.onmicrosoft.com",
        "identityCacheSize": "100",
        "maxProcessThreads": "10",
        "useProxy": "false",
        "socketTimeout" : "60s",
        "connectTimeout" : "60s",
        "connectionRequestTimeout" : "60s",
        "maxConnections" : "100",
        "maxConnectionsPerRoute" : "10"
    }
}