다음을 통해 공유


매개 변수 및 형식 [SPFSDK][VMROLE]

 

적용 대상: Windows Azure Pack

매개 변수는 다양한 개체 속성에서 사용됩니다. 매개 변수는 이름, 지정된 형식 및 유용한 설명으로 설명됩니다. 속성에 매개 변수를 사용하려면 [param.parameter_name] 구문을 사용합니다. 식별된 매개 변수의 값은 해당 컨텍스트에 따라 개체를 읽거나 실행할 때 사용됩니다.

매개 변수

일반적으로 매개 변수에는 세 부분이 있습니다. 먼저 매개 변수는 ResourceDefinition [SPFSDK][VMROLE] 개체 또는 ResourceExtension [SPFSDK][VMROLE] 개체와 같이 어딘가에 선언됩니다. 둘째, 매개 변수의 값은 ResourceConfiguration [SPFSDK][VMROLE]과 같은 선언에서 외부에서 제공됩니다. 마지막으로 다른 개체 속성에서 매개 변수를 사용합니다.

선언

구문

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

속성

이름

유형

필수

기본값

Description

Name

String

없음

매개 변수의 이름입니다.

Type

String

없음

매개 변수의 유형입니다. 매개 변수 형식 섹션에서는 사용 가능한 매개 변수 형식에 대해 설명합니다.

Description

String

null

이 리소스 확장의 게시자 이름입니다.

사용량

다음 코드 예제에서는 ResourceExtension [SPFSDK][VMROLE] 개체에서 매개 변수를 선언하여 Microsoft SQL Server 인스턴스의 이름을 보유하는 방법을 보여 줍니다.

{
    ... other properties ...

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

    ... other properties ...
}

ResourceExtension [SPFSDK][VMROLE] 개체 모델 전체에서 매개 변수를 참조할 수 있습니다. 매개 변수를 참조하려면 특수 식별자 구문 [param.parameter_name]을 사용합니다. 다음 예제에서는 ResourceExtension [SPFSDK][VMROLE]을 보여 줍니다. ExtensionSettings [SPFSDK][VMROLE]. ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE]. SQLProfile [SPFSDK][VMROLE]. SQLDeployment 개체는 이전 매개 변수를 사용합니다.

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

이제 리소스 확장이 구성되었으므로 VirtualMachineRole을 통해 매개 변수에 대한 값을 제공할 수 있습니다. ResourceConfiguration [SPFSDK][VMROLE] 개체의 ParameterValues 속성입니다.

{
    "Version" : "1.0.0.0",

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

매개 변수 형식

다음 섹션에서는 사용 가능한 매개 변수 형식을 나타냅니다.

  • String

  • Int

  • 부울

  • 자격 증명

  • SecureString

String


  • 문자열 값

  • 선언 예제

    "ResourceParameters" : [ 
        {
            "Name" : "ComputerNamePattern",
            "Type" : "String",
            "Description" : "Computer Name Pattern"
        }
    ]
    
  • 구성 예

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

Int


  • 임의의 정수 값을 사용할 수 있습니다.

  • 선언 예제

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

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

부울


  • true 또는 false입니다.

  • 선언 예제

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

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

자격 증명


  • 사용자:암호 형식의 사용자 이름 및 암호 조합입니다.

  • 선언 예제

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

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

SecureString


  • 문자열 값 GET이면 __**__의 문자열 값을 반환합니다.

  • 선언 예제

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

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

참고 항목

VM 역할 JSON 참조 [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
ResourceConfiguration [SPFSDK][VMROLE]