UserInputRequiredParameterMetadata

UserInputRequiredParameterMetadata
UserInputRequiredParameterMetadata

The UserInputRequiredParameterMetadata data object represents policy option metadata information for configuration data.

The Profile Engine saves configuration data from the user input options in the host AnswerFile. See the ExecuteHostProfile and ApplyHostConfig_Task methods.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "id": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string",
        "messageCatalogKeyPrefix": "string",
        "messageArg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "parameter": [
        {
            "_typeName": "string",
            "id": {
                "_typeName": "string",
                "label": "string",
                "summary": "string",
                "key": "string",
                "messageCatalogKeyPrefix": "string",
                "messageArg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ]
            },
            "type": "string",
            "optional": false,
            "defaultValue": {
                "_typeName": "string"
            },
            "hidden": false,
            "securitySensitive": false,
            "readOnly": false,
            "parameterRelations": [
                {
                    "_typeName": "string",
                    "relationTypes": [
                        "string"
                    ],
                    "values": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "path": {
                        "_typeName": "string",
                        "profilePath": "string",
                        "policyId": "string",
                        "parameterId": "string",
                        "policyOptionId": "string"
                    },
                    "minCount": 0,
                    "maxCount": 0
                }
            ]
        }
    ],
    "userInputParameter": [
        {
            "_typeName": "string",
            "id": {
                "_typeName": "string",
                "label": "string",
                "summary": "string",
                "key": "string",
                "messageCatalogKeyPrefix": "string",
                "messageArg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ]
            },
            "type": "string",
            "optional": false,
            "defaultValue": {
                "_typeName": "string"
            },
            "hidden": false,
            "securitySensitive": false,
            "readOnly": false,
            "parameterRelations": [
                {
                    "_typeName": "string",
                    "relationTypes": [
                        "string"
                    ],
                    "values": [
                        {
                            "_typeName": "string"
                        }
                    ],
                    "path": {
                        "_typeName": "string",
                        "profilePath": "string",
                        "policyId": "string",
                        "parameterId": "string",
                        "policyOptionId": "string"
                    },
                    "minCount": 0,
                    "maxCount": 0
                }
            ]
        }
    ]
}
userInputParameter
Optional

Metadata for user input options.