azure-native.customerinsights.Prediction
Explore with Pulumi AI
The prediction resource format.
Uses Azure REST API version 2017-04-26. In version 2.x of the Azure Native provider, it used API version 2017-04-26.
Create Prediction Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Prediction(name: string, args: PredictionArgs, opts?: CustomResourceOptions);
@overload
def Prediction(resource_name: str,
args: PredictionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Prediction(resource_name: str,
opts: Optional[ResourceOptions] = None,
mappings: Optional[PredictionMappingsArgs] = None,
negative_outcome_expression: Optional[str] = None,
score_label: Optional[str] = None,
scope_expression: Optional[str] = None,
hub_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
primary_profile_type: Optional[str] = None,
positive_outcome_expression: Optional[str] = None,
auto_analyze: Optional[bool] = None,
involved_relationships: Optional[Sequence[str]] = None,
involved_kpi_types: Optional[Sequence[str]] = None,
prediction_name: Optional[str] = None,
description: Optional[Mapping[str, str]] = None,
involved_interaction_types: Optional[Sequence[str]] = None,
grades: Optional[Sequence[PredictionGradesArgs]] = None,
display_name: Optional[Mapping[str, str]] = None)
func NewPrediction(ctx *Context, name string, args PredictionArgs, opts ...ResourceOption) (*Prediction, error)
public Prediction(string name, PredictionArgs args, CustomResourceOptions? opts = null)
public Prediction(String name, PredictionArgs args)
public Prediction(String name, PredictionArgs args, CustomResourceOptions options)
type: azure-native:customerinsights:Prediction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. PredictionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. PredictionArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. PredictionArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. PredictionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. PredictionArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var predictionResource = new AzureNative.CustomerInsights.Prediction("predictionResource", new()
{
Mappings = new AzureNative.CustomerInsights.Inputs.PredictionMappingsArgs
{
Grade = "string",
Reason = "string",
Score = "string",
},
NegativeOutcomeExpression = "string",
ScoreLabel = "string",
ScopeExpression = "string",
HubName = "string",
ResourceGroupName = "string",
PrimaryProfileType = "string",
PositiveOutcomeExpression = "string",
AutoAnalyze = false,
InvolvedRelationships = new[]
{
"string",
},
InvolvedKpiTypes = new[]
{
"string",
},
PredictionName = "string",
Description =
{
{ "string", "string" },
},
InvolvedInteractionTypes = new[]
{
"string",
},
Grades = new[]
{
new AzureNative.CustomerInsights.Inputs.PredictionGradesArgs
{
GradeName = "string",
MaxScoreThreshold = 0,
MinScoreThreshold = 0,
},
},
DisplayName =
{
{ "string", "string" },
},
});
example, err := customerinsights.NewPrediction(ctx, "predictionResource", &customerinsights.PredictionArgs{
Mappings: &customerinsights.PredictionMappingsArgs{
Grade: pulumi.String("string"),
Reason: pulumi.String("string"),
Score: pulumi.String("string"),
},
NegativeOutcomeExpression: pulumi.String("string"),
ScoreLabel: pulumi.String("string"),
ScopeExpression: pulumi.String("string"),
HubName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
PrimaryProfileType: pulumi.String("string"),
PositiveOutcomeExpression: pulumi.String("string"),
AutoAnalyze: pulumi.Bool(false),
InvolvedRelationships: pulumi.StringArray{
pulumi.String("string"),
},
InvolvedKpiTypes: pulumi.StringArray{
pulumi.String("string"),
},
PredictionName: pulumi.String("string"),
Description: pulumi.StringMap{
"string": pulumi.String("string"),
},
InvolvedInteractionTypes: pulumi.StringArray{
pulumi.String("string"),
},
Grades: customerinsights.PredictionGradesArray{
&customerinsights.PredictionGradesArgs{
GradeName: pulumi.String("string"),
MaxScoreThreshold: pulumi.Int(0),
MinScoreThreshold: pulumi.Int(0),
},
},
DisplayName: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var predictionResource = new Prediction("predictionResource", PredictionArgs.builder()
.mappings(PredictionMappingsArgs.builder()
.grade("string")
.reason("string")
.score("string")
.build())
.negativeOutcomeExpression("string")
.scoreLabel("string")
.scopeExpression("string")
.hubName("string")
.resourceGroupName("string")
.primaryProfileType("string")
.positiveOutcomeExpression("string")
.autoAnalyze(false)
.involvedRelationships("string")
.involvedKpiTypes("string")
.predictionName("string")
.description(Map.of("string", "string"))
.involvedInteractionTypes("string")
.grades(PredictionGradesArgs.builder()
.gradeName("string")
.maxScoreThreshold(0)
.minScoreThreshold(0)
.build())
.displayName(Map.of("string", "string"))
.build());
prediction_resource = azure_native.customerinsights.Prediction("predictionResource",
mappings={
"grade": "string",
"reason": "string",
"score": "string",
},
negative_outcome_expression="string",
score_label="string",
scope_expression="string",
hub_name="string",
resource_group_name="string",
primary_profile_type="string",
positive_outcome_expression="string",
auto_analyze=False,
involved_relationships=["string"],
involved_kpi_types=["string"],
prediction_name="string",
description={
"string": "string",
},
involved_interaction_types=["string"],
grades=[{
"grade_name": "string",
"max_score_threshold": 0,
"min_score_threshold": 0,
}],
display_name={
"string": "string",
})
const predictionResource = new azure_native.customerinsights.Prediction("predictionResource", {
mappings: {
grade: "string",
reason: "string",
score: "string",
},
negativeOutcomeExpression: "string",
scoreLabel: "string",
scopeExpression: "string",
hubName: "string",
resourceGroupName: "string",
primaryProfileType: "string",
positiveOutcomeExpression: "string",
autoAnalyze: false,
involvedRelationships: ["string"],
involvedKpiTypes: ["string"],
predictionName: "string",
description: {
string: "string",
},
involvedInteractionTypes: ["string"],
grades: [{
gradeName: "string",
maxScoreThreshold: 0,
minScoreThreshold: 0,
}],
displayName: {
string: "string",
},
});
type: azure-native:customerinsights:Prediction
properties:
autoAnalyze: false
description:
string: string
displayName:
string: string
grades:
- gradeName: string
maxScoreThreshold: 0
minScoreThreshold: 0
hubName: string
involvedInteractionTypes:
- string
involvedKpiTypes:
- string
involvedRelationships:
- string
mappings:
grade: string
reason: string
score: string
negativeOutcomeExpression: string
positiveOutcomeExpression: string
predictionName: string
primaryProfileType: string
resourceGroupName: string
scopeExpression: string
scoreLabel: string
Prediction Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Prediction resource accepts the following input properties:
- Auto
Analyze This property is required. bool - Whether do auto analyze.
- Hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- Mappings
This property is required. Pulumi.Azure Native. Customer Insights. Inputs. Prediction Mappings - Definition of the link mapping of prediction.
- Negative
Outcome Expression This property is required. string - Negative outcome expression.
- Positive
Outcome Expression This property is required. string - Positive outcome expression.
- Primary
Profile Type This property is required. string - Primary profile type.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Scope
Expression This property is required. string - Scope expression.
- Score
Label This property is required. string - Score label.
- Description Dictionary<string, string>
- Description of the prediction.
- Display
Name Dictionary<string, string> - Display name of the prediction.
- Grades
List<Pulumi.
Azure Native. Customer Insights. Inputs. Prediction Grades> - The prediction grades.
- Involved
Interaction List<string>Types - Interaction types involved in the prediction.
- Involved
Kpi List<string>Types - KPI types involved in the prediction.
- Involved
Relationships List<string> - Relationships involved in the prediction.
- Prediction
Name string - Name of the prediction.
- Auto
Analyze This property is required. bool - Whether do auto analyze.
- Hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- Mappings
This property is required. PredictionMappings Args - Definition of the link mapping of prediction.
- Negative
Outcome Expression This property is required. string - Negative outcome expression.
- Positive
Outcome Expression This property is required. string - Positive outcome expression.
- Primary
Profile Type This property is required. string - Primary profile type.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Scope
Expression This property is required. string - Scope expression.
- Score
Label This property is required. string - Score label.
- Description map[string]string
- Description of the prediction.
- Display
Name map[string]string - Display name of the prediction.
- Grades
[]Prediction
Grades Args - The prediction grades.
- Involved
Interaction []stringTypes - Interaction types involved in the prediction.
- Involved
Kpi []stringTypes - KPI types involved in the prediction.
- Involved
Relationships []string - Relationships involved in the prediction.
- Prediction
Name string - Name of the prediction.
- auto
Analyze This property is required. Boolean - Whether do auto analyze.
- hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- mappings
This property is required. PredictionMappings - Definition of the link mapping of prediction.
- negative
Outcome Expression This property is required. String - Negative outcome expression.
- positive
Outcome Expression This property is required. String - Positive outcome expression.
- primary
Profile Type This property is required. String - Primary profile type.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
Expression This property is required. String - Scope expression.
- score
Label This property is required. String - Score label.
- description Map<String,String>
- Description of the prediction.
- display
Name Map<String,String> - Display name of the prediction.
- grades
List<Prediction
Grades> - The prediction grades.
- involved
Interaction List<String>Types - Interaction types involved in the prediction.
- involved
Kpi List<String>Types - KPI types involved in the prediction.
- involved
Relationships List<String> - Relationships involved in the prediction.
- prediction
Name String - Name of the prediction.
- auto
Analyze This property is required. boolean - Whether do auto analyze.
- hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- mappings
This property is required. PredictionMappings - Definition of the link mapping of prediction.
- negative
Outcome Expression This property is required. string - Negative outcome expression.
- positive
Outcome Expression This property is required. string - Positive outcome expression.
- primary
Profile Type This property is required. string - Primary profile type.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
Expression This property is required. string - Scope expression.
- score
Label This property is required. string - Score label.
- description {[key: string]: string}
- Description of the prediction.
- display
Name {[key: string]: string} - Display name of the prediction.
- grades
Prediction
Grades[] - The prediction grades.
- involved
Interaction string[]Types - Interaction types involved in the prediction.
- involved
Kpi string[]Types - KPI types involved in the prediction.
- involved
Relationships string[] - Relationships involved in the prediction.
- prediction
Name string - Name of the prediction.
- auto_
analyze This property is required. bool - Whether do auto analyze.
- hub_
name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- mappings
This property is required. PredictionMappings Args - Definition of the link mapping of prediction.
- negative_
outcome_ expression This property is required. str - Negative outcome expression.
- positive_
outcome_ expression This property is required. str - Positive outcome expression.
- primary_
profile_ type This property is required. str - Primary profile type.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope_
expression This property is required. str - Scope expression.
- score_
label This property is required. str - Score label.
- description Mapping[str, str]
- Description of the prediction.
- display_
name Mapping[str, str] - Display name of the prediction.
- grades
Sequence[Prediction
Grades Args] - The prediction grades.
- involved_
interaction_ Sequence[str]types - Interaction types involved in the prediction.
- involved_
kpi_ Sequence[str]types - KPI types involved in the prediction.
- involved_
relationships Sequence[str] - Relationships involved in the prediction.
- prediction_
name str - Name of the prediction.
- auto
Analyze This property is required. Boolean - Whether do auto analyze.
- hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- mappings
This property is required. Property Map - Definition of the link mapping of prediction.
- negative
Outcome Expression This property is required. String - Negative outcome expression.
- positive
Outcome Expression This property is required. String - Positive outcome expression.
- primary
Profile Type This property is required. String - Primary profile type.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
Expression This property is required. String - Scope expression.
- score
Label This property is required. String - Score label.
- description Map<String>
- Description of the prediction.
- display
Name Map<String> - Display name of the prediction.
- grades List<Property Map>
- The prediction grades.
- involved
Interaction List<String>Types - Interaction types involved in the prediction.
- involved
Kpi List<String>Types - KPI types involved in the prediction.
- involved
Relationships List<String> - Relationships involved in the prediction.
- prediction
Name String - Name of the prediction.
Outputs
All input properties are implicitly available as output properties. Additionally, the Prediction resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Provisioning
State string - Provisioning state.
- System
Generated Pulumi.Entities Azure Native. Customer Insights. Outputs. Prediction Response System Generated Entities - System generated entities.
- Tenant
Id string - The hub name.
- Type string
- Resource type.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Provisioning
State string - Provisioning state.
- System
Generated PredictionEntities Response System Generated Entities - System generated entities.
- Tenant
Id string - The hub name.
- Type string
- Resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioning
State String - Provisioning state.
- system
Generated PredictionEntities Response System Generated Entities - System generated entities.
- tenant
Id String - The hub name.
- type String
- Resource type.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name.
- provisioning
State string - Provisioning state.
- system
Generated PredictionEntities Response System Generated Entities - System generated entities.
- tenant
Id string - The hub name.
- type string
- Resource type.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name.
- provisioning_
state str - Provisioning state.
- system_
generated_ Predictionentities Response System Generated Entities - System generated entities.
- tenant_
id str - The hub name.
- type str
- Resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioning
State String - Provisioning state.
- system
Generated Property MapEntities - System generated entities.
- tenant
Id String - The hub name.
- type String
- Resource type.
Supporting Types
PredictionGrades, PredictionGradesArgs
- Grade
Name string - Name of the grade.
- Max
Score intThreshold - Maximum score threshold.
- Min
Score intThreshold - Minimum score threshold.
- Grade
Name string - Name of the grade.
- Max
Score intThreshold - Maximum score threshold.
- Min
Score intThreshold - Minimum score threshold.
- grade
Name String - Name of the grade.
- max
Score IntegerThreshold - Maximum score threshold.
- min
Score IntegerThreshold - Minimum score threshold.
- grade
Name string - Name of the grade.
- max
Score numberThreshold - Maximum score threshold.
- min
Score numberThreshold - Minimum score threshold.
- grade_
name str - Name of the grade.
- max_
score_ intthreshold - Maximum score threshold.
- min_
score_ intthreshold - Minimum score threshold.
- grade
Name String - Name of the grade.
- max
Score NumberThreshold - Maximum score threshold.
- min
Score NumberThreshold - Minimum score threshold.
PredictionMappings, PredictionMappingsArgs
PredictionResponseGrades, PredictionResponseGradesArgs
- Grade
Name string - Name of the grade.
- Max
Score intThreshold - Maximum score threshold.
- Min
Score intThreshold - Minimum score threshold.
- Grade
Name string - Name of the grade.
- Max
Score intThreshold - Maximum score threshold.
- Min
Score intThreshold - Minimum score threshold.
- grade
Name String - Name of the grade.
- max
Score IntegerThreshold - Maximum score threshold.
- min
Score IntegerThreshold - Minimum score threshold.
- grade
Name string - Name of the grade.
- max
Score numberThreshold - Maximum score threshold.
- min
Score numberThreshold - Minimum score threshold.
- grade_
name str - Name of the grade.
- max_
score_ intthreshold - Maximum score threshold.
- min_
score_ intthreshold - Minimum score threshold.
- grade
Name String - Name of the grade.
- max
Score NumberThreshold - Maximum score threshold.
- min
Score NumberThreshold - Minimum score threshold.
PredictionResponseMappings, PredictionResponseMappingsArgs
PredictionResponseSystemGeneratedEntities, PredictionResponseSystemGeneratedEntitiesArgs
- Generated
Interaction List<string>Types - Generated interaction types.
- Generated
Kpis Dictionary<string, string> - Generated KPIs.
- Generated
Links List<string> - Generated links.
- Generated
Interaction []stringTypes - Generated interaction types.
- Generated
Kpis map[string]string - Generated KPIs.
- Generated
Links []string - Generated links.
- generated
Interaction List<String>Types - Generated interaction types.
- generated
Kpis Map<String,String> - Generated KPIs.
- generated
Links List<String> - Generated links.
- generated
Interaction string[]Types - Generated interaction types.
- generated
Kpis {[key: string]: string} - Generated KPIs.
- generated
Links string[] - Generated links.
- generated_
interaction_ Sequence[str]types - Generated interaction types.
- generated_
kpis Mapping[str, str] - Generated KPIs.
- generated_
links Sequence[str] - Generated links.
- generated
Interaction List<String>Types - Generated interaction types.
- generated
Kpis Map<String> - Generated KPIs.
- generated
Links List<String> - Generated links.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:customerinsights:Prediction sdkTestHub/sdktest /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/predictions/{predictionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0