DataPlaneAccountClient (preview:2019-11-01)

2025/12/05 • 14 new methods

Accounts_GetAccountProperties (new)
Description :  Get an account
Reference :  Link ¶

⚼ Request

GET:  /
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
identity:
{
Description: Identity Info on the tracked resource ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: Gets or sets the location. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Gets or sets the type. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
{
capacity:
{
Description: Gets or sets the sku capacity. Possible values include: 4, 16 ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets the sku name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
type:
{
Description: Gets or sets the type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_UpdateAccountProperties (new)
Description :  Updates an account
Reference :  Link ¶

⚼ Request

PATCH:  /
{
accountUpdateParameters:
{
Required: True ,
}
{
friendlyName:
{
Description: The friendly name for the azure resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
identity:
{
Description: Identity Info on the tracked resource ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: Gets or sets the location. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties. ,
Required: False ,
}
{
cloudConnectors:
{
Description: Cloud connectors. External cloud identifier used as part of scanning configuration. ,
Required: False ,
}
{
awsExternalId:
{
Description: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Gets the time at which the entity was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Gets the creator of the entity. ,
Required: False ,
}
string ,
createdByObjectId:
{
Description: Gets the creators of the entity's object id. ,
Required: False ,
}
string ,
endpoints:
{
Description: The URIs that are the public endpoints of the account. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: Gets the resource identifiers of the managed resources. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the private endpoint connections information. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
properties:
{
Description: The connection identifier. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The private endpoint information. ,
Required: False ,
}
{
id:
{
Description: The private endpoint identifier. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: The required actions. ,
Required: False ,
}
string ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Gets or sets the type. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Gets or sets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
SoftDeleting: No description available. ,
SoftDeleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets the public network access. ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
{
capacity:
{
Description: Gets or sets the sku capacity. Possible values include: 4, 16 ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets the sku name. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
type:
{
Description: Gets or sets the type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_GetAccessKeys (new)
Description :  List the authorization keys associated with this account.
Reference :  Link ¶

⚼ Request

POST:  /listkeys
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
atlasKafkaPrimaryEndpoint:
{
Description: Gets or sets the primary connection string. ,
Required: False ,
}
string ,
atlasKafkaSecondaryEndpoint:
{
Description: Gets or sets the secondary connection string. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Accounts_RegenerateAccessKey (new)
Description :  Regenerate the authorization keys associated with this data catalog.
Reference :  Link ¶

⚼ Request

POST:  /regeneratekeys
{
keyOptions:
{
Required: True ,
}
{
keyType:
{
Description: The access key type. ,
Enum:
{
PrimaryAtlasKafkaKey: No description available. ,
SecondaryAtlasKafkaKey: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
atlasKafkaPrimaryEndpoint:
{
Description: Gets or sets the primary connection string. ,
Required: False ,
}
string ,
atlasKafkaSecondaryEndpoint:
{
Description: Gets or sets the secondary connection string. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Collections_GetCollection (new)
Description :  Get a collection
Reference :  Link ¶

⚼ Request

GET:  /collections/{collectionName}
{
collectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
collectionProvisioningState:
{
Description: Gets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the collection. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
parentCollection:
{
Description: Gets or sets the parent collection reference. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Collections_CreateOrUpdateCollection (new)
Description :  Creates or updates a collection entity.
Reference :  Link ¶

⚼ Request

PUT:  /collections/{collectionName}
{
collectionName:
{
Required: True ,
}
string ,
collection:
{
Required: True ,
}
{
collectionProvisioningState:
{
Description: Gets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the collection. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
parentCollection:
{
Description: Gets or sets the parent collection reference. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
collectionProvisioningState:
{
Description: Gets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the collection. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
parentCollection:
{
Description: Gets or sets the parent collection reference. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Collections_DeleteCollection (new)
Description :  Deletes a Collection entity.
Reference :  Link ¶

⚼ Request

DELETE:  /collections/{collectionName}
{
collectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Collections_ListCollections (new)
Description :  List the collections in the account.
Reference :  Link ¶

⚼ Request

GET:  /collections
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
collectionProvisioningState:
{
Description: Gets the state of the provisioning. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Moving: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name of the collection. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
parentCollection:
{
Description: Gets or sets the parent collection reference. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Collections_ListChildCollectionNames (new)
Description :  Lists the child collections names in the collection.
Reference :  Link ¶

⚼ Request

GET:  /collections/{collectionName}/getChildCollectionNames
{
collectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
friendlyName:
{
Description: Gets or sets the friendly name of the collection. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
Collections_GetCollectionPath (new)
Description :  Gets the parent name and parent friendly name chains that represent the collection path.
Reference :  Link ¶

⚼ Request

GET:  /collections/{collectionName}/getCollectionPath
{
collectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
parentFriendlyNameChain:
{
Description: The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent. ,
Required: False ,
}
[
string ,
]
,
parentNameChain:
{
Description: The names of ancestors starting from the default (root) collection and ending with the immediate parent. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
ResourceSetRules_GetResourceSetRule (new)
Description :  Get a resource set config service model.
Reference :  Link ¶

⚼ Request

GET:  /resourceSetRuleConfigs/defaultResourceSetRuleConfig
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
advancedResourceSet:
{
Description: Gets or sets the advanced resource set property of the account. ,
Required: False ,
}
{
modifiedAt:
{
Description: Date at which ResourceSetProcessing property of the account is updated. ,
Format: date-time ,
Required: False ,
}
string ,
resourceSetProcessing:
{
Description: The advanced resource property of the account. ,
Enum:
{
Default: No description available. ,
Advanced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the rule ,
Required: False ,
}
string ,
pathPatternConfig:
{
Description: The configuration rules for path pattern extraction. ,
Required: False ,
}
{
acceptedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
complexReplacers:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
typeName:
{
Required: False ,
}
string ,
}
,
]
,
createdBy:
{
Required: True ,
}
string ,
enableDefaultPatterns:
{
Required: True ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
normalizationRules:
{
Required: False ,
}
[
{
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
dynamicReplacement:
{
Required: False ,
}
boolean ,
entityTypes:
{
Required: False ,
}
[
string ,
]
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
version:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
regexReplacers:
{
Required: False ,
}
[
{
condition:
{
Required: False ,
}
string ,
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: True ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
doNotReplaceRegex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
}
,
]
,
rejectedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
scopedRules:
{
Required: False ,
}
[
{
bindingUrl:
{
Required: True ,
}
string ,
rules:
{
Required: False ,
}
[
{
displayName:
{
Required: False ,
}
string ,
isResourceSet:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
qualifiedName:
{
Required: True ,
}
string ,
}
,
]
,
storeType:
{
Required: True ,
}
string ,
}
,
]
,
version:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
ResourceSetRules_CreateOrUpdateResourceSetRule (new)
Description :  Creates or updates an resource set config.
Reference :  Link ¶

⚼ Request

PUT:  /resourceSetRuleConfigs/defaultResourceSetRuleConfig
{
resourceSetRuleConfig:
{
Required: True ,
}
{
advancedResourceSet:
{
Description: Gets or sets the advanced resource set property of the account. ,
Required: False ,
}
{
modifiedAt:
{
Description: Date at which ResourceSetProcessing property of the account is updated. ,
Format: date-time ,
Required: False ,
}
string ,
resourceSetProcessing:
{
Description: The advanced resource property of the account. ,
Enum:
{
Default: No description available. ,
Advanced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the rule ,
Required: False ,
}
string ,
pathPatternConfig:
{
Description: The configuration rules for path pattern extraction. ,
Required: False ,
}
{
acceptedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
complexReplacers:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
typeName:
{
Required: False ,
}
string ,
}
,
]
,
createdBy:
{
Required: True ,
}
string ,
enableDefaultPatterns:
{
Required: True ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
normalizationRules:
{
Required: False ,
}
[
{
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
dynamicReplacement:
{
Required: False ,
}
boolean ,
entityTypes:
{
Required: False ,
}
[
string ,
]
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
version:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
regexReplacers:
{
Required: False ,
}
[
{
condition:
{
Required: False ,
}
string ,
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: True ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
doNotReplaceRegex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
}
,
]
,
rejectedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
scopedRules:
{
Required: False ,
}
[
{
bindingUrl:
{
Required: True ,
}
string ,
rules:
{
Required: False ,
}
[
{
displayName:
{
Required: False ,
}
string ,
isResourceSet:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
qualifiedName:
{
Required: True ,
}
string ,
}
,
]
,
storeType:
{
Required: True ,
}
string ,
}
,
]
,
version:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
advancedResourceSet:
{
Description: Gets or sets the advanced resource set property of the account. ,
Required: False ,
}
{
modifiedAt:
{
Description: Date at which ResourceSetProcessing property of the account is updated. ,
Format: date-time ,
Required: False ,
}
string ,
resourceSetProcessing:
{
Description: The advanced resource property of the account. ,
Enum:
{
Default: No description available. ,
Advanced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the rule ,
Required: False ,
}
string ,
pathPatternConfig:
{
Description: The configuration rules for path pattern extraction. ,
Required: False ,
}
{
acceptedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
complexReplacers:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
typeName:
{
Required: False ,
}
string ,
}
,
]
,
createdBy:
{
Required: True ,
}
string ,
enableDefaultPatterns:
{
Required: True ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
normalizationRules:
{
Required: False ,
}
[
{
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
dynamicReplacement:
{
Required: False ,
}
boolean ,
entityTypes:
{
Required: False ,
}
[
string ,
]
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
version:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
regexReplacers:
{
Required: False ,
}
[
{
condition:
{
Required: False ,
}
string ,
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: True ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
doNotReplaceRegex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
}
,
]
,
rejectedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
scopedRules:
{
Required: False ,
}
[
{
bindingUrl:
{
Required: True ,
}
string ,
rules:
{
Required: False ,
}
[
{
displayName:
{
Required: False ,
}
string ,
isResourceSet:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
qualifiedName:
{
Required: True ,
}
string ,
}
,
]
,
storeType:
{
Required: True ,
}
string ,
}
,
]
,
version:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
ResourceSetRules_DeleteResourceSetRule (new)
Description :  Deletes a ResourceSetRuleConfig resource.
Reference :  Link ¶

⚼ Request

DELETE:  /resourceSetRuleConfigs/defaultResourceSetRuleConfig
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}
ResourceSetRules_ListResourceSetRules (new)
Description :  Get a resource set config service model.
Reference :  Link ¶

⚼ Request

GET:  /resourceSetRuleConfigs
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Total item count. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type results. ,
Required: True ,
}
[
{
advancedResourceSet:
{
Description: Gets or sets the advanced resource set property of the account. ,
Required: False ,
}
{
modifiedAt:
{
Description: Date at which ResourceSetProcessing property of the account is updated. ,
Format: date-time ,
Required: False ,
}
string ,
resourceSetProcessing:
{
Description: The advanced resource property of the account. ,
Enum:
{
Default: No description available. ,
Advanced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: The name of the rule ,
Required: False ,
}
string ,
pathPatternConfig:
{
Description: The configuration rules for path pattern extraction. ,
Required: False ,
}
{
acceptedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
complexReplacers:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
typeName:
{
Required: False ,
}
string ,
}
,
]
,
createdBy:
{
Required: True ,
}
string ,
enableDefaultPatterns:
{
Required: True ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
normalizationRules:
{
Required: False ,
}
[
{
description:
{
Required: False ,
}
string ,
disabled:
{
Required: False ,
}
boolean ,
dynamicReplacement:
{
Required: False ,
}
boolean ,
entityTypes:
{
Required: False ,
}
[
string ,
]
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
version:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
regexReplacers:
{
Required: False ,
}
[
{
condition:
{
Required: False ,
}
string ,
createdBy:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
disabled:
{
Required: True ,
}
boolean ,
disableRecursiveReplacerApplication:
{
Required: False ,
}
boolean ,
doNotReplaceRegex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
regex:
{
Required: False ,
}
{
maxDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
maxLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDashes:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigits:
{
Format: int32 ,
Required: False ,
}
integer ,
minDigitsOrLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minDots:
{
Format: int32 ,
Required: False ,
}
integer ,
minHex:
{
Format: int32 ,
Required: False ,
}
integer ,
minLetters:
{
Format: int32 ,
Required: False ,
}
integer ,
minUnderscores:
{
Format: int32 ,
Required: False ,
}
integer ,
options:
{
Format: int32 ,
Required: False ,
}
integer ,
regexStr:
{
Required: False ,
}
string ,
}
,
replaceWith:
{
Required: False ,
}
string ,
}
,
]
,
rejectedPatterns:
{
Required: False ,
}
[
{
createdBy:
{
Required: False ,
}
string ,
filterType:
{
Enum:
{
Pattern: No description available. ,
Regex: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
modifiedBy:
{
Required: False ,
}
string ,
name:
{
Required: True ,
}
string ,
path:
{
Required: True ,
}
string ,
}
,
]
,
scopedRules:
{
Required: False ,
}
[
{
bindingUrl:
{
Required: True ,
}
string ,
rules:
{
Required: False ,
}
[
{
displayName:
{
Required: False ,
}
string ,
isResourceSet:
{
Required: False ,
}
boolean ,
lastUpdatedTimestamp:
{
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
qualifiedName:
{
Required: True ,
}
string ,
}
,
]
,
storeType:
{
Required: True ,
}
string ,
}
,
]
,
version:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Gets or sets the error. ,
Required: False ,
}
string ,
}