Put, propriété
Permet de créer ou mettre à jour une propriété Service Fabric.
Crée ou met à jour la propriété Service Fabric spécifiée sous un nom donné.
Requête
Méthode | URI de requête |
---|---|
PUT | /Names/{nameId}/$/GetProperty?api-version=6.0&timeout={timeout} |
Paramètres
Nom | Type | Obligatoire | Emplacement |
---|---|---|---|
nameId |
string | Oui | Chemin d’accès |
api-version |
string | Oui | Requête |
timeout |
entier (int64) | Non | Requête |
PropertyDescription |
PropertyDescription | Oui | body |
nameId
Type : chaîne
Obligatoire : Oui
Nom Service Fabric sans le schéma d’URI 'fabric:'.
api-version
Type : chaîne
Obligatoire : Oui
Par défaut : 6.0
Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 6.0 ».
La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Il s’agit de la dernière version prise en charge de l’API. Si une version d’API inférieure est transmise, la réponse retournée peut être différente de celle documentée dans cette spécification.
En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0, mais si le runtime est 6.1, afin de faciliter l’écriture des clients, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera en fonction de la version 6.0 documentée.
timeout
Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1
Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.
PropertyDescription
Type : PropertyDescription
Obligatoire : Oui
Décrit la propriété Service Fabric à créer.
Réponses
Code d’état HTTP | Description | Schéma de réponse |
---|---|---|
200 (OK) | Une réponse réussie signifie que la propriété a été créée ou mise à jour. |
|
Tous les autres codes status | Réponse d’erreur détaillée. |
FabricError |
Exemples
Put, propriété
Cet exemple montre comment créer ou mettre à jour une propriété Service Fabric sous un nom donné.
Requête
PUT http://localhost:19080/Names/samples/apps/CalculatorApp/$/GetProperty?api-version=6.0
Corps
{
"PropertyName": "AppData",
"Value": {
"Kind": "Binary",
"Data": [
"0",
"1",
"2",
"3",
"4",
"5"
]
}
}
Réponse 200
Corps
Le corps de la réponse est vide.
Put, propriété personnalisée
Cet exemple montre comment créer ou mettre à jour une propriété Service Fabric sous un nom donné avec un type personnalisé.
Requête
PUT http://localhost:19080/Names/samples/apps/CalculatorApp/$/GetProperty?api-version=6.0
Corps
{
"PropertyName": "AppData",
"Value": {
"Kind": "String",
"Data": "1+2=3"
},
"CustomTypeId": "EquationType"
}
Réponse 200
Corps
Le corps de la réponse est vide.