Azure.Analytics.Purview.Account (preview:2023-10-01)

2025/12/05 • 26 deleted methods

Accounts_GetAccountProperties (removed)
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: The Managed Identity of the resource ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
location:
{
Description: Gets or sets the location. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
properties:
{
Description: The account properties ,
Required: False ,
}
{
accountStatus:
{
Description: The account status. ,
Required: False ,
}
{
accountProvisioningState:
{
Description: Gets the account status code. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Updating: 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 ,
errorDetails:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
,
cloudConnectors:
{
Description: External Cloud Service connectors ,
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 ,
defaultDomain:
{
Description: Gets or sets the default domain in the account. ,
Required: False ,
}
string ,
endpoints:
{
Description: The account endpoints ,
Required: False ,
}
{
catalog:
{
Description: Gets the catalog endpoint. ,
Required: False ,
}
string ,
scan:
{
Description: Gets the scan endpoint. ,
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
ingestionStorage:
{
Description: Ingestion Storage Account Info ,
Required: False ,
}
{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
primaryEndpoint:
{
Description: Gets or sets the primary endpoint. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Gets or sets the public network access setting ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: The managed resources in customer subscription. ,
Required: False ,
}
{
eventHubNamespace:
{
Description: Gets the managed event hub namespace resource identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. ,
Required: False ,
}
string ,
storageAccount:
{
Description: Gets the managed storage account resource identifier. ,
Required: False ,
}
string ,
}
,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
mergeInfo:
{
Description: The public Account Merge Info model. ,
Required: False ,
}
{
accountLocation:
{
Description: The account location of the *other* account in the merge operation. ,
Required: False ,
}
string ,
accountName:
{
Description: The account name of the *other* account in the merge operation. ,
Required: False ,
}
string ,
accountResourceGroupName:
{
Description: The resource group name of the *other* account in the merge operation. ,
Required: False ,
}
string ,
accountSubscriptionId:
{
Description: The subscription id of the *other* account in the merge operation. ,
Required: False ,
}
string ,
mergeStatus:
{
Description: The status of the merge operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
typeOfAccount:
{
Description: The type of account this account is for the merge operation. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: A private endpoint connection properties class. ,
Required: False ,
}
{
privateEndpoint:
{
Description: A private endpoint class. ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: The Sku ,
Required: False ,
}
{
capacity:
{
Description: Gets or sets the sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets the sku name. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
type:
{
Description: Gets or sets the type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Accounts_UpdateAccountProperties (removed)
Description :  Updates an account
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
identity:
{
Description: The Managed Identity of the resource ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
location:
{
Description: Gets or sets the location. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
properties:
{
Description: The account properties ,
Required: False ,
}
{
accountStatus:
{
Description: The account status. ,
Required: False ,
}
{
accountProvisioningState:
{
Description: Gets the account status code. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Updating: 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 ,
errorDetails:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
,
cloudConnectors:
{
Description: External Cloud Service connectors ,
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 ,
defaultDomain:
{
Description: Gets or sets the default domain in the account. ,
Required: False ,
}
string ,
endpoints:
{
Description: The account endpoints ,
Required: False ,
}
{
catalog:
{
Description: Gets the catalog endpoint. ,
Required: False ,
}
string ,
scan:
{
Description: Gets the scan endpoint. ,
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
ingestionStorage:
{
Description: Ingestion Storage Account Info ,
Required: False ,
}
{
id:
{
Description: Gets or sets the Id. ,
Required: False ,
}
string ,
primaryEndpoint:
{
Description: Gets or sets the primary endpoint. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Gets or sets the public network access setting ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedEventHubState:
{
Description: Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. ,
Enum:
{
NotSpecified: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
managedResourceGroupName:
{
Description: Gets or sets the managed resource group name ,
Required: False ,
}
string ,
managedResources:
{
Description: The managed resources in customer subscription. ,
Required: False ,
}
{
eventHubNamespace:
{
Description: Gets the managed event hub namespace resource identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. ,
Required: False ,
}
string ,
storageAccount:
{
Description: Gets the managed storage account resource identifier. ,
Required: False ,
}
string ,
}
,
managedResourcesPublicNetworkAccess:
{
Description: Gets or sets the public network access for managed resources ,
Enum:
{
NotSpecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
mergeInfo:
{
Description: The public Account Merge Info model. ,
Required: False ,
}
{
accountLocation:
{
Description: The account location of the *other* account in the merge operation. ,
Required: False ,
}
string ,
accountName:
{
Description: The account name of the *other* account in the merge operation. ,
Required: False ,
}
string ,
accountResourceGroupName:
{
Description: The resource group name of the *other* account in the merge operation. ,
Required: False ,
}
string ,
accountSubscriptionId:
{
Description: The subscription id of the *other* account in the merge operation. ,
Required: False ,
}
string ,
mergeStatus:
{
Description: The status of the merge operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
typeOfAccount:
{
Description: The type of account this account is for the merge operation. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: A private endpoint connection properties class. ,
Required: False ,
}
{
privateEndpoint:
{
Description: A private endpoint class. ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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: The Sku ,
Required: False ,
}
{
capacity:
{
Description: Gets or sets the sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets or sets the sku name. ,
Enum:
{
Standard: No description available. ,
Free: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
type:
{
Description: Gets or sets the type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Accounts_GetAccessKeys (removed)
Description :  Lists the connection strings that allow connecting with the Managed Event Hub, if it is provisioned. Those connection strings are aimed to receive messages from the ATLAS_ENTITIES hub or to send messages to the ATLAS_HOOK hub.
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Accounts_RegenerateAccessKeys (removed)
Description :  Regenerates either the primary or secondary key of the Managed Event Hub, if it is provisioned.
Reference :  Link ¶

⚼ Request

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

⚐ 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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Collections_GetCollection (removed)
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 ,
domain:
{
Description: Gets the domain. ,
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: Reference to a Collection. ,
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 ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Collections_CreateOrUpdateCollection (removed)
Description :  Creates or updates a collection entity.
Reference :  Link ¶

⚼ Request

PUT:  /collections/{collectionName}
{
collectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
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 ,
domain:
{
Description: Gets the domain. ,
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: Reference to a Collection. ,
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 ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
domain:
{
Description: Gets the domain. ,
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: Reference to a Collection. ,
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 ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Collections_DeleteCollection (removed)
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Collections_ListCollections (removed)
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 ,
domain:
{
Description: Gets the domain. ,
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: Reference to a Collection. ,
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 ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Collections_ListChildCollectionNames (removed)
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Collections_GetCollectionPath (removed)
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 ,
$skipToken:
{
Required: False ,
}
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactAssignments_GetContactAssignment (removed)
Description :  Get a contactAssignment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
assignmentId:
{
Description: Gets or sets the id of the assignment. ,
Format: uuid ,
Required: False ,
}
string ,
contactGroup:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
principalId:
{
Description: Gets or sets the principal Id. ,
Required: False ,
}
string ,
scope:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactAssignments_CreateOrUpdateContactAssignment (removed)
Description :  Creates or updates a contactAssignment entity.
Reference :  Link ¶

⚼ Request

PUT:  /contactAssignments/{contactAssignmentId}
{
contactAssignmentId:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
assignmentId:
{
Description: Gets or sets the id of the assignment. ,
Format: uuid ,
Required: False ,
}
string ,
contactGroup:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
principalId:
{
Description: Gets or sets the principal Id. ,
Required: False ,
}
string ,
scope:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
assignmentId:
{
Description: Gets or sets the id of the assignment. ,
Format: uuid ,
Required: False ,
}
string ,
contactGroup:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
principalId:
{
Description: Gets or sets the principal Id. ,
Required: False ,
}
string ,
scope:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactAssignments_DeleteContactAssignment (removed)
Description :  Deletes a ContactAssignment entity.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactAssignments_ListContactAssignments (removed)
Description :  List the contactAssignments in the account.
Reference :  Link ¶

⚼ Request

GET:  /contactAssignments
{
scope:
{
Required: False ,
}
string ,
contactGroupDefinition:
{
Required: False ,
}
string ,
referenceType:
{
Required: False ,
}
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 ,
}
[
{
assignmentId:
{
Description: Gets or sets the id of the assignment. ,
Format: uuid ,
Required: False ,
}
string ,
contactGroup:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
principalId:
{
Description: Gets or sets the principal Id. ,
Required: False ,
}
string ,
scope:
{
Description: Entity reference type. ,
Required: False ,
}
{
referenceName:
{
Description: Gets or sets the reference name. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the reference type property. ,
Enum:
{
Unknown: No description available. ,
CollectionReference: No description available. ,
ContactGroupDefinitionReference: No description available. ,
DatasourceReference: No description available. ,
ScanReference: No description available. ,
AdaptiveScopeReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactAssignments_ListScopedContactGroupNames (removed)
Description :  Gets the distinct list of contact group names for the provided scope.
Reference :  Link ¶

⚼ Request

GET:  /getScopedContactGroupNames
{
scope:
{
Required: False ,
}
string ,
referenceType:
{
Required: False ,
}
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 ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactGroupDefinitions_GetContactGroupDefinition (removed)
Description :  Get a contactGroupDefinition
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
contactGroupType:
{
Description: Gets or sets the contact group definition type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactGroupDefinitions_CreateOrUpdateContactGroupDefinition (removed)
Description :  Creates or updates a contact group definition entity.
Reference :  Link ¶

⚼ Request

PUT:  /contactGroupDefinitions/{contactGroupDefinitionName}
{
contactGroupDefinitionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
contactGroupType:
{
Description: Gets or sets the contact group definition type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
contactGroupType:
{
Description: Gets or sets the contact group definition type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactGroupDefinitions_DeleteContactGroupDefinition (removed)
Description :  Deletes a ContactGroupDefinition entity.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ContactGroupDefinitions_ListContactGroupDefinitions (removed)
Description :  List the contactGroupDefinitions in the account.
Reference :  Link ¶

⚼ Request

GET:  /contactGroupDefinitions
{
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 ,
}
[
{
contactGroupType:
{
Description: Gets or sets the contact group definition type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Gets or sets the friendly name. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Domains_GetDomain (removed)
Description :  Get a domain
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
containerType:
{
Description: Gets the container type. ,
Enum:
{
Domain: No description available. ,
Collection: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
environment:
{
Description: Gets the environment of the domain. ,
Enum:
{
Prod: No description available. ,
Test: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: Gets or sets the friendly name of the domain. ,
Required: False ,
}
string ,
identity:
{
Description: The Managed Identity of the resource ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
mergeInfo:
{
Description: The public Domain Merge Info model. ,
Required: False ,
}
{
accountLocation:
{
Description: The account location of the source account in the merge operation. ,
Required: False ,
}
string ,
accountName:
{
Description: The account name of the source account in the merge operation. ,
Required: False ,
}
string ,
accountResourceGroupName:
{
Description: The resource group name of the source account in the merge operation. ,
Required: False ,
}
string ,
accountSubscriptionId:
{
Description: The subscription id of the source account in the merge operation. ,
Required: False ,
}
string ,
mergeStatus:
{
Description: The status of the merge operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
Domains_ListDomains (removed)
Description :  List the domains in the account.
Reference :  Link ¶

⚼ Request

GET:  /domains
{
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 ,
}
[
{
containerType:
{
Description: Gets the container type. ,
Enum:
{
Domain: No description available. ,
Collection: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
environment:
{
Description: Gets the environment of the domain. ,
Enum:
{
Prod: No description available. ,
Test: No description available. ,
}
,
Required: False ,
}
enum ,
friendlyName:
{
Description: Gets or sets the friendly name of the domain. ,
Required: False ,
}
string ,
identity:
{
Description: The Managed Identity of the resource ,
Required: False ,
}
{
principalId:
{
Description: Service principal object Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: User Assigned Identities ,
Required: False ,
}
object ,
}
,
mergeInfo:
{
Description: The public Domain Merge Info model. ,
Required: False ,
}
{
accountLocation:
{
Description: The account location of the source account in the merge operation. ,
Required: False ,
}
string ,
accountName:
{
Description: The account name of the source account in the merge operation. ,
Required: False ,
}
string ,
accountResourceGroupName:
{
Description: The resource group name of the source account in the merge operation. ,
Required: False ,
}
string ,
accountSubscriptionId:
{
Description: The subscription id of the source account in the merge operation. ,
Required: False ,
}
string ,
mergeStatus:
{
Description: The status of the merge operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
provisioningState:
{
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 ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of the last modification the resource (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ExposureControl_GetFeatures (removed)
Description :  Gets details from a list of features.
Reference :  Link ¶

⚼ Request

POST:  /features
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
features:
{
Description: Set of features ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
features:
{
Description: Features with enabled status ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ResourceSetRules_GetResourceSetRule (removed)
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: The resource set processing 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:
{
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ResourceSetRules_CreateOrUpdateResourceSetRule (removed)
Description :  Creates or updates an resource set config.
Reference :  Link ¶

⚼ Request

PUT:  /resourceSetRuleConfigs/defaultResourceSetRuleConfig
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
advancedResourceSet:
{
Description: The resource set processing 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:
{
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 (200)

{
advancedResourceSet:
{
Description: The resource set processing 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:
{
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ResourceSetRules_DeleteResourceSetRule (removed)
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}
ResourceSetRules_ListResourceSetRules (removed)
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: The resource set processing 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:
{
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: Default error model ,
Required: False ,
}
{
code:
{
Description: Gets or sets the code. ,
Required: False ,
}
string ,
details:
{
Description: Gets or sets the details. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Gets or sets the messages. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the target. ,
Required: False ,
}
string ,
}
,
}