Modeling - Create Or Update

Service:

Intelligent Recommendations

API Version:

2022-02-01

Creates or updates Modeling resource.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecommendationsService/accounts/{accountName}/modeling/{modelingName}?api-version=2022-02-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the RecommendationsService Account resource.
modelingName	path	True	string	The name of the Modeling resource.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties		Properties	Modeling resource properties.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	ModelingResource	Successful.
201 Created	ModelingResource	Modeling resource is being created or updated.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account.

Examples

Create or update Modeling resource

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.RecommendationsService/accounts/sampleAccount/modeling/c1?api-version=2022-02-01

{
  "location": "West US",
  "tags": {
    "Environment": "Prod"
  },
  "properties": {
    "features": "Standard",
    "frequency": "High",
    "size": "Medium",
    "inputData": {
      "connectionString": "https://storageAccount.blob.core.windows.net/container/root"
    }
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.RecommendationsService/accounts/sampleAccount/modeling/c1",
  "name": "c1",
  "type": "Microsoft.RecommendationsService/accounts/modeling",
  "location": "West US",
  "tags": {
    "Environment": "Prod"
  },
  "systemData": {},
  "properties": {
    "features": "Standard",
    "frequency": "High",
    "size": "Medium",
    "inputData": {
      "connectionString": "https://storageAccount.blob.core.windows.net/container/root"
    },
    "provisioningState": "Succeeded"
  }
}

Status code:

201

{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rg/providers/Microsoft.RecommendationsService/accounts/sampleAccount/modeling/c1",
  "name": "c1",
  "type": "Microsoft.RecommendationsService/accounts/modeling",
  "location": "West US",
  "tags": {
    "Environment": "Prod"
  },
  "systemData": {},
  "properties": {
    "features": "Standard",
    "frequency": "High",
    "size": "Medium",
    "inputData": {
      "connectionString": "https://storageAccount.blob.core.windows.net/container/root"
    },
    "provisioningState": "Accepted"
  }
}

Definitions

Name	Description
AccountConfiguration	Account configuration. This can only be set at RecommendationsService Account creation.
CorsRule	CORS details.
createdByType	The type of identity that created the resource.
EndpointAuthentication	Service endpoints authentication details.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ModelingFeatures	Modeling features controls the set of supported scenarios\models being computed. This can only be set at Modeling creation.
ModelingFrequency	Modeling frequency controls the modeling compute frequency.
ModelingInputData	The configuration to raw CDM data to be used as Modeling resource input.
ModelingResource	Modeling resource details.
ModelingSize	Modeling size controls the maximum supported input data size.
principalType	AAD principal type.
Properties	Account resource properties.
systemData	Metadata pertaining to creation and last modification of the resource.

AccountConfiguration

Account configuration. This can only be set at RecommendationsService Account creation.

Name	Type	Description
Capacity	string
Free	string

CorsRule

CORS details.

Name	Type	Description
allowedHeaders	string[]	The request headers that the origin domain may specify on the CORS request.
allowedMethods	string[]	The methods (HTTP request verbs) that the origin domain may use for a CORS request.
allowedOrigins	string[]	The origin domains that are permitted to make a request against the service via CORS.
exposedHeaders	string[]	The response headers to expose to CORS clients.
maxAgeInSeconds	integer	The number of seconds that the client/browser should cache a preflight response.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndpointAuthentication

Service endpoints authentication details.

Name	Type	Description
aadTenantID	string	AAD tenant ID.
principalID	string	AAD principal ID.
principalType	principalType	AAD principal type.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ModelingFeatures

Modeling features controls the set of supported scenarios\models being computed. This can only be set at Modeling creation.

Name	Type	Description
Basic	string
Premium	string
Standard	string

ModelingFrequency

Modeling frequency controls the modeling compute frequency.

Name	Type	Description
High	string
Low	string
Medium	string

ModelingInputData

The configuration to raw CDM data to be used as Modeling resource input.

Name	Type	Description
connectionString	string	Connection string to raw input data.

ModelingResource

Modeling resource details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	Properties	Modeling resource properties.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ModelingSize

Modeling size controls the maximum supported input data size.

Name	Type	Description
Large	string
Medium	string
Small	string

principalType

AAD principal type.

Name	Type	Description
Application	string
User	string

Properties

Account resource properties.

Name	Type	Description
configuration	AccountConfiguration	Account configuration. This can only be set at RecommendationsService Account creation.
cors	CorsRule[]	The list of CORS details.
endpointAuthentications	EndpointAuthentication[]	The list of service endpoints authentication details.
provisioningState	string	The resource provisioning state.
reportsConnectionString	string	Connection string to write Accounts reports to.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.