Parametry a typy [SPFSDK][VMROLE]

 

Platí pro: Windows Azure Pack

Parametry jsou používány různými vlastnostmi objektu. Parametry jsou popsány názvem, zadaným typem a užitečným popisem. Pokud chcete pro vlastnost použít parametr, použijte syntaxi [param.parameter_name]. Hodnota identifikovaného parametru se používá při čtení nebo spuštění objektu, který závisí na jeho kontextu.

Parametr

Parametr má obvykle tři části. Nejprve je parametr deklarován někde, jako v objektu ResourceDefinition [SPFSDK][VMROLE] nebo resourceExtension [SPFSDK][VMROLE]. Za druhé se hodnoty parametru poskytují externě z deklarace, například ResourceConfiguration [SPFSDK][VMROLE].. A nakonec je parametr používán jinou vlastností objektu.

Deklarace

Syntax

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

Vlastnosti

Název	Typ	Vyžadováno	Výchozí hodnota	Popis
Název	Řetězec	Yes	Žádné	Název parametru
Typ	Řetězec	Yes	Žádné	Typ parametru. Oddíl Typy parametrů popisuje dostupné typy parametrů.
Description	Řetězec	No	null	Název vydavatele tohoto rozšíření prostředku.

Využití

Následující příklad kódu ukazuje, jak deklarovat parametr v objektu ResourceExtension [SPFSDK][VMROLE] pro uložení názvu instance Microsoft SQL Server.

{
    ... other properties ...

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

    ... other properties ...
}

V rámci objektového modelu ResourceExtension [SPFSDK][VMROLE] lze na parametr odkazovat. Pokud chcete odkazovat na parametr, použijte speciální syntaxi identifikátoru: [param.parameter_name]. Následující příklad ukazuje, jak ResourceExtension [SPFSDK][VMROLE]. ExtensionSettings [SPFSDK][VMROLE]. ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE]. SQLProfile [SPFSDK][VMROLE]. Objekt SQLDeployment používá předchozí parametr.

{
    "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"
        }
    ]
}

Teď, když je rozšíření prostředků nakonfigurované, můžete zadat hodnotu parametru prostřednictvím VirtualMachineRole.ResourceConfiguration [SPFSDK][VMROLE] vlastnost ParameterValues objektu.

{
    "Version" : "1.0.0.0",

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

Typy parametrů

Následující části představují dostupné typy parametrů:

• Řetězec

• Int

• Logická hodnota

• Přihlašovací údaj

• Securestring

Řetězec

• Hodnota
  Jakákoli hodnota řetězce.

• Příklad deklarace

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

• Příklad konfigurace

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

Int

• Hodnota
  Libovolná celočíselná hodnota.

• Příklad deklarace

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

• Příklad konfigurace

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

Logická hodnota

• Hodnota
  true nebo false.

• Příklad deklarace

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

• Příklad konfigurace

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

Přihlašovací údaj

• Hodnota
  Kombinace uživatelského jména a hesla ve formátu user:password .

• Příklad deklarace

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

• Příklad konfigurace

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

Securestring

• Hodnota
  Jakákoli hodnota řetězce. Pokud funkce GET, vrátí řetězcovou hodnotu __**__.

• Příklad deklarace

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

• Příklad konfigurace

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

Viz také

Referenční informace k kódu JSON role virtuálního počítače [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
ResourceConfiguration [SPFSDK][VMROLE]