Partilhar via


Parâmetros e tipos [SPFSDK][VMROLE]

 

Aplica-se a: Windows Azure Pack

Os parâmetros são usados por várias propriedades de objetos. Os parâmetros são descritos por um nome, um tipo especificado e uma descrição útil. Para utilizar um parâmetro numa propriedade, utilize a sintaxe [param.parameter_name ]. O valor do parâmetro identificado é usado quando o objeto é lido ou executado, o que depende do seu contexto.

Parâmetro

Geralmente há três partes para um parâmetro. Em primeiro lugar, o parâmetro é declarado em algum lugar, como num objeto de Identificação de Recursos [SPFSDK][VMROLE] ou num objeto ResourceExtension [SPFSDK][VMROLE] . Em segundo lugar, os valores de um parâmetro são fornecidos externamente a partir da declaração, como a Configuração de Recursos [SPFSDK][VMROLE]. E, finalmente, um parâmetro é usado por outra propriedade de objeto.

Declaração

Syntax

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

Propriedades

Nome

Tipo

Necessário

Valor predefinido

Description

Name

String

Yes

Nenhuma

O nome do parâmetro.

Tipo

String

Yes

Nenhuma

O tipo de parâmetro. A secção De Tipos de Parâmetros descreve os tipos de parâmetros disponíveis.

Description

String

No

nulo

O nome editor desta extensão de recursos.

Utilização

O exemplo de código que se segue demonstra como declarar um parâmetro num objeto de Extensão de Recursos [SPFSDK][VMROLE] para manter o nome de um caso de Microsoft SQL Server.

{
    ... other properties ...

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

    ... other properties ...
}

Em toda a posição de recursos[SPFSDK][VMROLE] modelo, um parâmetro pode ser referenciado. Para fazer referência a um parâmetro, utilize uma sintaxe especial do identificador: [param.parameter_name]. O exemplo a seguir mostra como uma Extensão de Recursos [SPFSDK][VMROLE]. ExtensõesSettings [SPFSDK][VMROLE]. AplicaçãoProfile.WindowsApplicationProfile [SPFSDK][VMROLE]. SQLProfile [SPFSDK][VMROLE]. O objeto SQLDeployment utiliza o parâmetro anterior.

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

Agora que a extensão do recurso está configurada, pode fornecer um valor para o parâmetro através do VirtualMachineRole.A propriedade de Parâmetros De Configuração de Recursos [SPFSDK][VMROLE]object's ParameterValues.

{
    "Version" : "1.0.0.0",

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

Tipos de Parâmetro

As seguintes secções representam os parâmetros disponíveis:

  • String

  • int

  • Booleano

  • Credencial

  • SecureString

String

  • Valor
    Qualquer valor de corda.

  • Exemplo da declaração

    "ResourceParameters" : [ 
        {
            "Name" : "ComputerNamePattern",
            "Type" : "String",
            "Description" : "Computer Name Pattern"
        }
    ]
    
  • Exemplo de configuração

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

int

  • Valor
    Qualquer valor inteiro.

  • Exemplo da declaração

    "ResourceParameters" : [ 
        {
            "Name" : "DefaultInstanceCount",
            "Type" : "Int",
            "Description" : "Default number of instances"
        }
    ]
    
  • Exemplo de configuração

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

Booleano

  • Valor
    verdadeiro ou falso.

  • Exemplo da declaração

    "ResourceParameters" : [ 
        {
            "Name" : "EnableTCP",
            "Type" : "Boolean",
            "Description" : "When True, enables TCP"
        }
    ]
    
  • Exemplo de configuração

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

Credencial

  • Valor
    Um nome de utilizador e uma combinação de palavra-passe no formato utilizador:password .

  • Exemplo da declaração

    "ResourceParameters" : [ 
        {
            "Name" : "JoinDomainCreds",
            "Type" : "Credential",
            "Description" : "The credentials to join the domain",
        }
    ]
    
  • Exemplo de configuração

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

SecureString

  • Valor
    Qualquer valor de corda. Se GET, devolve o valor de cadeia de __**___

  • Exemplo da declaração

    "ResourceParameters" : [ 
        {
            "Name" : "CreditCard",
            "Type" : "SecureString",
            "Description" : "Credit card number",
        }
    ]
    
  • Exemplo de configuração

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

Consulte também

VM Role JSON Reference [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
Configuration de Recursos [SPFSDK][VMROLE]