Colocar Propriedade
Cria ou atualiza uma propriedade do Service Fabric.
Cria ou atualiza a propriedade especificada do Service Fabric com um determinado nome.
Pedir
Método | URI do pedido |
---|---|
PUT | /Names/{nameId}/$/GetProperty?api-version=6.0&timeout={timeout} |
Parâmetros
Nome | Tipo | Necessário | Localização |
---|---|---|---|
nameId |
string | Yes | Caminho |
api-version |
string | Yes | Consulta |
timeout |
número inteiro (int64) | No | Consulta |
PropertyDescription |
PropertyDescription | Yes | Corpo |
nameId
Tipo: cadeia
Obrigatório: Sim
O nome do Service Fabric, sem o esquema URI "fabric:".
api-version
Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.0
A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de ser "6.0".
A versão da API REST do Service Fabric baseia-se na versão de runtime na qual a API foi introduzida ou foi alterada. O runtime do Service Fabric suporta mais do que uma versão da API. Esta é a versão suportada mais recente da API. Se for transmitida uma versão da API inferior, a resposta devolvida poderá ser diferente da documentada nesta especificação.
Além disso, o runtime aceita qualquer versão superior à versão suportada mais recente até à versão atual do runtime. Portanto, se a versão mais recente da API for 6.0, mas se o runtime for 6.1, para facilitar a escrita dos clientes, o runtime aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será conforme a versão documentada 6.0.
timeout
Tipo: número inteiro (int64)
Obrigatório: Não
Predefinição: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
O tempo limite do servidor para executar a operação em segundos. Este tempo limite especifica a duração de tempo que o cliente está disposto a aguardar pela conclusão da operação pedida. O valor predefinido para este parâmetro é 60 segundos.
PropertyDescription
Tipo: PropertyDescription
Obrigatório: Sim
Descreve a propriedade do Service Fabric a ser criada.
Respostas
Código de Estado HTTP | Description | Esquema de Resposta |
---|---|---|
200 (OK) | Uma resposta bem-sucedida significa que a propriedade foi criada ou atualizada. |
|
Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |
Exemplos
Colocar propriedade
Este exemplo mostra como criar ou atualizar uma propriedade do Service Fabric com um determinado nome.
Pedir
PUT http://localhost:19080/Names/samples/apps/CalculatorApp/$/GetProperty?api-version=6.0
Corpo
{
"PropertyName": "AppData",
"Value": {
"Kind": "Binary",
"Data": [
"0",
"1",
"2",
"3",
"4",
"5"
]
}
}
Resposta 200
Corpo
O corpo da resposta está vazio.
Colocar propriedade personalizada
Este exemplo mostra como criar ou atualizar uma propriedade do Service Fabric com um determinado nome com um tipo personalizado.
Pedir
PUT http://localhost:19080/Names/samples/apps/CalculatorApp/$/GetProperty?api-version=6.0
Corpo
{
"PropertyName": "AppData",
"Value": {
"Kind": "String",
"Data": "1+2=3"
},
"CustomTypeId": "EquationType"
}
Resposta 200
Corpo
O corpo da resposta está vazio.