Paramètres et types [SPFSDK][VMROLE]

 

S’applique à : Windows Azure Pack

Les paramètres sont utilisés par différentes propriétés d’objet. Les paramètres sont décrits par un nom, un type spécifié et une description utile. Pour utiliser un paramètre sur une propriété, utilisez la syntaxe [param.parameter_name]. La valeur du paramètre identifié est utilisée lorsque l’objet est lu ou exécuté, ce qui dépend de son contexte.

Paramètre

Il existe généralement trois parties à un paramètre. Tout d’abord, le paramètre est déclaré quelque part, comme dans un objet ResourceDefinition [SPFSDK][VMROLE] ou un objet ResourceExtension [SPFSDK][VMROLE]. Ensuite, les valeurs d’un paramètre sont fournies en externe à partir de la déclaration, telles que ResourceConfiguration [SPFSDK][VMROLE]. Enfin, un paramètre est utilisé par une autre propriété d’objet.

Déclaration

Syntaxe

{
    "Name": "Name of the parameter",
    "Type": "Type of parameter ",
    "Description": "Description for the parameter"
}

Propriétés

Nom	Type	Obligatoire	Valeur par défaut	Description
Nom	String	Oui	None	Le nom du paramètre.
Type	String	Oui	None	Type de paramètre. La section Types de paramètres décrit les types de paramètres disponibles.
Description	String	Non	null	Nom de l’éditeur de cette extension de ressource.

Utilisation

L’exemple de code suivant montre comment déclarer un paramètre dans un objet ResourceExtension [SPFSDK][VMROLE] pour contenir le nom d’une instance de Microsoft SQL Server.

{
    ... other properties ...

    "ResourceExtensionParameters": [
        {
            "Name": "SQLInstance",
            "Type": "string",
            "Description": "The name of the SQL Server instance."
        }
    ],

    ... other properties ...
}

Tout au long du modèle objet ResourceExtension [SPFSDK][VMROLE], un paramètre peut être référencé. Pour référencer un paramètre, utilisez une syntaxe d’identificateur spéciale : [param.parameter_name]. L’exemple suivant montre comment un ResourceExtension [SPFSDK][VMROLE]. ExtensionSettings [SPFSDK][VMROLE]. ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE]. SQLProfile [SPFSDK][VMROLE]. L’objet SQLDeployment utilise le paramètre précédent.

{
    "SQLDeployments": [
        {
            "DeploymentName": "SQL Deployment 1",
            "InstanceName": "[Param.SQLInstance]",
            "InstanceID": "[Param.SQLInstance]",
            "EnableNamedPipes": false,
            "EnableTCP": true,
            "MediaSource": "c:\\SQLMediaPath\\sqlsetup.exe",
            "ProductKey": "abcdefghijklmnopqrstuvwxyz",
            "SQLAuthenticationType": "WindowsAuthentication",
            "SQLSysAdminMemberList": "domain\\user",
            "DeploymentTimeOutInSeconds": 3600,
            "SQLConfigurationPayloadId": "61A33949-46CE-4d0f-921F-A0059DA9AD1F",
            "SAPassword": "MySAPassword",

            "SQLDeploymentCredential": "domain\\user:password",
            "SQLAgentServiceCredential": "NT AUTHORITY\\System:",
            "SQLServiceCredential": "NT AUTHORITY\\NetworkService:",
            "SQLReportingServiceCredential": "domain\\user:password"
        }
    ]
}

Maintenant que l’extension de ressource est configurée, vous pouvez fournir une valeur pour le paramètre via VirtualMachineRole. Propriété ParameterValues de l’objet ResourceConfiguration [SPFSDK][VMROLE].

{
    "Version" : "1.0.0.0",

    "ParameterValues" : "{    
                \"SQLInstance\" : \"HomeSQLServer\"
    }"
}

Types de paramètres

Les sections suivantes représentent les types de paramètres disponibles :

• String

• Int

• Boolean

• Informations d'identification

• SecureString

String

• Valeur
  Toute valeur de chaîne.

• Exemple de déclaration

  "ResourceParameters" : [ 
      {
          "Name" : "ComputerNamePattern",
          "Type" : "String",
          "Description" : "Computer Name Pattern"
      }
  ]
  

• Exemple de configuration

  "ParameterValues" : "{
      \"ComputerNamePattern\" : \"web-###\"
  }"
  

Int

• Valeur
  Toute valeur entière.

• Exemple de déclaration

  "ResourceParameters" : [ 
      {
          "Name" : "DefaultInstanceCount",
          "Type" : "Int",
          "Description" : "Default number of instances"
      }
  ]
  

• Exemple de configuration

  "ParameterValues" : "{
      \"DefaultInstanceCount\" : 5
  }"
  

Boolean

• Valeur
  true ou false.

• Exemple de déclaration

  "ResourceParameters" : [ 
      {
          "Name" : "EnableTCP",
          "Type" : "Boolean",
          "Description" : "When True, enables TCP"
      }
  ]
  

• Exemple de configuration

  "ParameterValues" : "{
      \"EnableTCP\" : false
  }"
  

Informations d'identification

• Valeur
  Combinaison nom d’utilisateur et mot de passe au format user:password .

• Exemple de déclaration

  "ResourceParameters" : [ 
      {
          "Name" : "JoinDomainCreds",
          "Type" : "Credential",
          "Description" : "The credentials to join the domain",
      }
  ]
  

• Exemple de configuration

  ParameterValues Example
  "ParameterValues" : "{
      \"JoinDomainCreds\" : \"myuser:mypassword\"
  }"
  

SecureString

• Valeur
  Toute valeur de chaîne. Si GET, retourne la valeur de chaîne de __**__.

• Exemple de déclaration

  "ResourceParameters" : [ 
      {
          "Name" : "CreditCard",
          "Type" : "SecureString",
          "Description" : "Credit card number",
      }
  ]
  

• Exemple de configuration

  "ParameterValues" : "{
      \"CreditCard\" : \"0000-0000-0000-0000\"
  }"
  

Voir aussi

Référence JSON du rôle de machine virtuelle [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
ResourceConfiguration [SPFSDK][VMROLE]