Microsoft.NetworkAnalytics (stable:2023-11-15)

2025/02/06 • 22 deleted methods

Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NetworkAnalytics/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_ListBySubscription (removed)
Description :  List data products by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkAnalytics/dataProducts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataProduct items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProductsCatalogs_ListBySubscription (removed)
Description :  List data catalog by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkAnalytics/dataProductsCatalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataProductsCatalog items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The data catalog provisioning state. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publishers:
{
Description: The data product publisher information. ,
Required: True ,
}
[
{
publisherName:
{
Description: Name of the publisher. ,
Required: True ,
}
string ,
dataProducts:
{
Description: Data product information. ,
Required: True ,
}
[
{
dataProductName:
{
Description: Name of data product. ,
Required: True ,
}
string ,
description:
{
Description: Description about data product. ,
Required: True ,
}
string ,
dataProductVersions:
{
Description: Version information of data product. ,
Required: True ,
}
[
{
version:
{
Description: Version of data product ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_ListByResourceGroup (removed)
Description :  List data products by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataProduct items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_Get (removed)
Description :  Retrieve data product resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_Create (removed)
Description :  Create data product resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The data product resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_Update (removed)
Description :  Update data product resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceGuid:
{
Description: The resource GUID property of the data product resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publisher:
{
Description: Data product publisher name. ,
Required: True ,
}
string ,
product:
{
Description: Product name of data product. ,
Required: True ,
}
string ,
majorVersion:
{
Description: Major version of data product. ,
Required: True ,
}
string ,
owners:
{
Description: List of name or email associated with data product resource deployment. ,
Required: False ,
}
[
string ,
]
,
redundancy:
{
Description: Flag to enable or disable redundancy for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
purviewAccount:
{
Description: Purview account url for data product to connect to. ,
Required: False ,
}
string ,
purviewCollection:
{
Description: Purview collection url for data product to connect to. ,
Required: False ,
}
string ,
privateLinksEnabled:
{
Description: Flag to enable or disable private link for data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Flag to enable or disable public access of data product resource. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerManagedKeyEncryptionEnabled:
{
Description: Flag to enable customer managed key encryption for data product. ,
Enum:
{
Enabled: Field to enable a setting. ,
Disabled: Field to disable a setting. ,
}
,
Required: False ,
}
enum ,
customerEncryptionKey:
{
Description: Customer managed encryption key details for data product. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: True ,
}
string ,
}
,
networkacls:
{
Description: Network rule set for data product. ,
Required: False ,
}
{
virtualNetworkRule:
{
Description: Virtual Network Rule ,
Required: True ,
}
[
{
id:
{
Description: Resource ID of a subnet ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: False ,
}
string ,
state:
{
Description: Gets the state of virtual network rule. ,
Required: False ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rule with specific IP or IP range in CIDR format. ,
Required: True ,
}
[
{
value:
{
Description: IP Rules Value ,
Required: False ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Required: True ,
}
string ,
}
,
]
,
allowedQueryIpRangeList:
{
Description: The list of query ips in the format of CIDR allowed to connect to query/visualization endpoint. ,
Required: True ,
}
[
string ,
]
,
defaultAction:
{
Description: Default Action ,
Enum:
{
Allow: Represents allow action. ,
Deny: Represents deny action. ,
}
,
Required: True ,
}
enum ,
}
,
managedResourceGroupConfiguration:
{
Description: Managed resource group configuration. ,
Required: False ,
}
{
name:
{
Description: Name of managed resource group ,
Required: True ,
}
string ,
location:
{
Description: Managed Resource Group location ,
Required: True ,
}
string ,
}
,
availableMinorVersions:
{
Description: List of available minor versions of the data product resource. ,
Required: False ,
}
[
string ,
]
,
currentMinorVersion:
{
Description: Current configured minor version of the data product resource. ,
Required: False ,
}
string ,
documentation:
{
Description: Documentation link for the data product based on definition file. ,
Required: False ,
}
string ,
consumptionEndpoints:
{
Description: Resource links which exposed to the customer to query the data. ,
Required: False ,
}
{
ingestionUrl:
{
Description: Ingestion url to upload the data. ,
Required: False ,
}
string ,
ingestionResourceId:
{
Description: Resource Id of ingestion endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
fileAccessUrl:
{
Description: Url to consume file type. ,
Required: False ,
}
string ,
fileAccessResourceId:
{
Description: Resource Id of file access endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
queryUrl:
{
Description: Url to consume the processed data. ,
Required: False ,
}
string ,
queryResourceId:
{
Description: Resource Id of query endpoint. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
keyVaultUrl:
{
Description: Key vault url. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_Delete (removed)
Description :  Delete data product resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_AddUserRole (removed)
Description :  Assign role to the data product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/addUserRole
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
roleId:
{
Description: Role Id of the Built-In Role ,
Required: True ,
}
string ,
principalId:
{
Description: Object ID of the AAD principal or security-group. ,
Required: True ,
}
string ,
userName:
{
Description: User name. ,
Required: True ,
}
string ,
dataTypeScope:
{
Description: Data Type Scope at which the role assignment is created. ,
Required: True ,
}
[
string ,
]
,
principalType:
{
Description: Type of the principal Id: User, Group or ServicePrincipal ,
Required: True ,
}
string ,
role:
{
Description: Data Product role to be assigned to a user. ,
Enum:
{
Reader: Field to specify user of type Reader. ,
SensitiveReader: Field to specify user of type SensitiveReader. This user has privileged access to read sensitive data of a data product. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
roleId:
{
Description: Role Id of the Built-In Role ,
Required: True ,
}
string ,
principalId:
{
Description: Object ID of the AAD principal or security-group. ,
Required: True ,
}
string ,
userName:
{
Description: User name. ,
Required: True ,
}
string ,
dataTypeScope:
{
Description: Data Type Scope at which the role assignment is created. ,
Required: True ,
}
[
string ,
]
,
principalType:
{
Description: Type of the principal Id: User, Group or ServicePrincipal ,
Required: True ,
}
string ,
role:
{
Description: Data Product role to be assigned to a user. ,
Enum:
{
Reader: Field to specify user of type Reader. ,
SensitiveReader: Field to specify user of type SensitiveReader. This user has privileged access to read sensitive data of a data product. ,
}
,
Required: True ,
}
enum ,
roleAssignmentId:
{
Description: Id of role assignment request ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_ListByDataProduct (removed)
Description :  List data type by parent resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataType items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
stateReason:
{
Description: Reason for the state of data type. ,
Required: False ,
}
string ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
visualizationUrl:
{
Description: Url for data visualization. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_Get (removed)
Description :  Retrieve data type resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes/{dataTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
dataTypeName:
{
Description: The data type name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
stateReason:
{
Description: Reason for the state of data type. ,
Required: False ,
}
string ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
visualizationUrl:
{
Description: Url for data visualization. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_Create (removed)
Description :  Create data type resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes/{dataTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
dataTypeName:
{
Description: The data type name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
stateReason:
{
Description: Reason for the state of data type. ,
Required: False ,
}
string ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
visualizationUrl:
{
Description: Url for data visualization. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
stateReason:
{
Description: Reason for the state of data type. ,
Required: False ,
}
string ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
visualizationUrl:
{
Description: Url for data visualization. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The data type resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
stateReason:
{
Description: Reason for the state of data type. ,
Required: False ,
}
string ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
visualizationUrl:
{
Description: Url for data visualization. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_Update (removed)
Description :  Update data type resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes/{dataTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
dataTypeName:
{
Description: The data type name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Latest provisioning state of data product. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of data type. ,
Enum:
{
Stopped: Field to specify stopped state. ,
Running: Field to specify running state. ,
}
,
Required: False ,
}
enum ,
stateReason:
{
Description: Reason for the state of data type. ,
Required: False ,
}
string ,
storageOutputRetention:
{
Description: Field for storage output retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseCacheRetention:
{
Description: Field for database cache retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
databaseRetention:
{
Description: Field for database data retention in days. ,
Format: int32 ,
Required: False ,
}
integer ,
visualizationUrl:
{
Description: Url for data visualization. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_Delete (removed)
Description :  Delete data type resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes/{dataTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
dataTypeName:
{
Description: The data type name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_DeleteData (removed)
Description :  Delete data for data type.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes/{dataTypeName}/deleteData
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
dataTypeName:
{
Description: The data type name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataTypes_GenerateStorageContainerSasToken (removed)
Description :  Generate sas token for storage container.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/dataTypes/{dataTypeName}/generateStorageContainerSasToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
dataTypeName:
{
Description: The data type name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
startTimeStamp:
{
Description: Sas token start timestamp. ,
Format: date-time ,
Required: True ,
}
string ,
expiryTimeStamp:
{
Description: Sas token expiry timestamp. ,
Format: date-time ,
Required: True ,
}
string ,
ipAddress:
{
Description: Ip Address ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
storageContainerSasToken:
{
Description: Field to specify storage container sas token. ,
Format: password ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_GenerateStorageAccountSasToken (removed)
Description :  Generate sas token for storage account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/generateStorageAccountSasToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
startTimeStamp:
{
Description: Sas token start timestamp. ,
Format: date-time ,
Required: True ,
}
string ,
expiryTimeStamp:
{
Description: Sas token expiry timestamp. ,
Format: date-time ,
Required: True ,
}
string ,
ipAddress:
{
Description: Ip Address ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
storageAccountSasToken:
{
Description: Field to specify storage account sas token. ,
Format: password ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_ListRolesAssignments (removed)
Description :  List user roles associated with the data product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/listRolesAssignments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
count:
{
Description: Count of role assignments. ,
Format: int32 ,
Required: True ,
}
integer ,
roleAssignmentResponse:
{
Description: list of role assignments ,
Required: True ,
}
[
{
roleId:
{
Description: Role Id of the Built-In Role ,
Required: True ,
}
string ,
principalId:
{
Description: Object ID of the AAD principal or security-group. ,
Required: True ,
}
string ,
userName:
{
Description: User name. ,
Required: True ,
}
string ,
dataTypeScope:
{
Description: Data Type Scope at which the role assignment is created. ,
Required: True ,
}
[
string ,
]
,
principalType:
{
Description: Type of the principal Id: User, Group or ServicePrincipal ,
Required: True ,
}
string ,
role:
{
Description: Data Product role to be assigned to a user. ,
Enum:
{
Reader: Field to specify user of type Reader. ,
SensitiveReader: Field to specify user of type SensitiveReader. This user has privileged access to read sensitive data of a data product. ,
}
,
Required: True ,
}
enum ,
roleAssignmentId:
{
Description: Id of role assignment request ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_RemoveUserRole (removed)
Description :  Remove role from the data product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/removeUserRole
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
roleId:
{
Description: Role Id of the Built-In Role ,
Required: True ,
}
string ,
principalId:
{
Description: Object ID of the AAD principal or security-group. ,
Required: True ,
}
string ,
userName:
{
Description: User name. ,
Required: True ,
}
string ,
dataTypeScope:
{
Description: Data Type Scope at which the role assignment is created. ,
Required: True ,
}
[
string ,
]
,
principalType:
{
Description: Type of the principal Id: User, Group or ServicePrincipal ,
Required: True ,
}
string ,
role:
{
Description: Data Product role to be assigned to a user. ,
Enum:
{
Reader: Field to specify user of type Reader. ,
SensitiveReader: Field to specify user of type SensitiveReader. This user has privileged access to read sensitive data of a data product. ,
}
,
Required: True ,
}
enum ,
roleAssignmentId:
{
Description: Id of role assignment request ,
Required: True ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProducts_RotateKey (removed)
Description :  Initiate key rotation on Data Product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProducts/{dataProductName}/rotateKey
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dataProductName:
{
Description: The data product resource name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
keyVaultUrl:
{
Description: key vault url. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProductsCatalogs_ListByResourceGroup (removed)
Description :  List data catalog by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProductsCatalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataProductsCatalog items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The data catalog provisioning state. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publishers:
{
Description: The data product publisher information. ,
Required: True ,
}
[
{
publisherName:
{
Description: Name of the publisher. ,
Required: True ,
}
string ,
dataProducts:
{
Description: Data product information. ,
Required: True ,
}
[
{
dataProductName:
{
Description: Name of data product. ,
Required: True ,
}
string ,
description:
{
Description: Description about data product. ,
Required: True ,
}
string ,
dataProductVersions:
{
Description: Version information of data product. ,
Required: True ,
}
[
{
version:
{
Description: Version of data product ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataProductsCatalogs_Get (removed)
Description :  Retrieve data type resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkAnalytics/dataProductsCatalogs/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The data catalog provisioning state. ,
Enum:
{
Succeeded: Represents a succeeded operation. ,
Failed: Represents a failed operation. ,
Canceled: Represents a canceled operation. ,
Provisioning: Represents a pending operation. ,
Updating: Represents a pending operation. ,
Deleting: Represents an operation under deletion. ,
Accepted: Represents an accepted operation. ,
}
,
Required: False ,
}
enum ,
publishers:
{
Description: The data product publisher information. ,
Required: True ,
}
[
{
publisherName:
{
Description: Name of the publisher. ,
Required: True ,
}
string ,
dataProducts:
{
Description: Data product information. ,
Required: True ,
}
[
{
dataProductName:
{
Description: Name of data product. ,
Required: True ,
}
string ,
description:
{
Description: Description about data product. ,
Required: True ,
}
string ,
dataProductVersions:
{
Description: Version information of data product. ,
Required: True ,
}
[
{
version:
{
Description: Version of data product ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}