Parametrar och typer [SPFSDK][VMROLE]

 

Gäller för: Windows Azure Pack

Parametrar används av olika objektegenskaper. Parametrarna beskrivs med ett namn, en angiven typ och en användbar beskrivning. Om du vill använda en parameter i en egenskap använder du syntaxen [param.parameter_name]. Värdet för den identifierade parametern används när objektet läse eller körs, vilket beror på dess kontext.

Parameter

Det finns vanligtvis tre delar till en parameter. Först deklareras parametern någonstans, som i ett ResourceDefinition-objekt [SPFSDK][VMROLE] eller ett ResourceExtension-objekt [SPFSDK][VMROLE]. För det andra anges värdena för en parameter externt från deklarationen, till exempel ResourceConfiguration [SPFSDK][VMROLE]. Slutligen används en parameter av en annan objektegenskap.

Förklaring

Syntax

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

Egenskaper

Namn	Typ	Obligatorisk	Standardvärde	Beskrivning
Name	Sträng	Yes	Ingen	Namnet på parametern .
Typ	Sträng	Yes	Ingen	Typ av parameter. I avsnittet Parametertyper beskrivs tillgängliga parametertyper.
Beskrivning	Sträng	No	null	Utgivarnamnet för det här resurstillägget.

Användning

Följande kodexempel visar hur du deklarerar en parameter i ett ResourceExtension-objekt [SPFSDK][VMROLE] för att lagra namnet på en instans av Microsoft SQL Server.

{
    ... other properties ...

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

    ... other properties ...
}

I objektmodellen ResourceExtension [SPFSDK][VMROLE] kan du referera till en parameter. Om du vill referera till en parameter använder du en särskild identifierarsyntax: [param.parameter_name]. I följande exempel visas hur en ResourceExtension [SPFSDK][VMROLE]. ExtensionSettings [SPFSDK][VMROLE]. ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE]. SQLProfile [SPFSDK][VMROLE]. SQLDeployment-objektet använder den föregående parametern.

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

Nu när resurstillägget har konfigurerats kan du ange ett värde för parametern via VirtualMachineRole.ResourceConfiguration [SPFSDK][VMROLE] objektets ParameterValues-egenskap.

{
    "Version" : "1.0.0.0",

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

Parametertyper

Följande avsnitt representerar tillgängliga parametertyper:

• Sträng

• Int

• Boolesk

• Autentiseringsuppgift

• SecureString

Sträng

• Värde
  Valfritt strängvärde.

• Exempel på deklaration

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

• Konfigurationsexempel

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

Int

• Värde
  Alla heltalsvärden.

• Exempel på deklaration

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

• Konfigurationsexempel

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

Boolesk

• Värde
  sant eller falskt.

• Exempel på deklaration

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

• Konfigurationsexempel

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

Autentiseringsuppgift

• Värde
  En kombination av användarnamn och lösenord i formatet user:password .

• Exempel på deklaration

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

• Konfigurationsexempel

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

SecureString

• Värde
  Valfritt strängvärde. Om GET returnerar strängvärdet __**__.

• Exempel på deklaration

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

• Konfigurationsexempel

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

Se även

JSON-referens för VM-roll [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
ResourceConfiguration [SPFSDK][VMROLE]