Exposer les paramètres de configuration de rôle comme variable d'environnement avec XPath

Article
10/16/2024

Important

Cloud Services (classique) est désormais déconseillé pour tous les clients à compter du 1er septembre 2024. Tous les déploiements en cours seront interrompus et désactivés par Microsoft, et les données seront définitivement perdues à compter d’octobre 2024. Les nouveaux déploiements doivent utiliser le nouveau modèle de déploiement basé sur Azure Resource Manager Azure Cloud Services (support étendu) .

Dans le fichier de définition de service du rôle Web ou du rôle de travail du service cloud, vous pouvez exposer les valeurs de configuration de l'exécution en tant que variables d'environnement. Les valeurs XPath suivantes sont prises en charge (qui correspondent aux valeurs de l'API).

Ces valeurs XPath sont également disponibles via la bibliothèque Microsoft.WindowsAzure.ServiceRuntime .

Application qui s'exécute dans l'émulateur

Indique que l'application s'exécute dans l'émulateur.

Type	Exemple
XPath	xpath="/RoleEnvironment/Deployment/@emulated"
Code	var x = RoleEnvironment.IsEmulated;

ID de déploiement

Récupère l'ID de déploiement de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/Deployment/@id"
Code	var deploymentId = RoleEnvironment.DeploymentId;

ID de rôle

Récupère l'ID de rôle actuel de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/@id"
Code	var id = RoleEnvironment.CurrentRoleInstance.Id;

Mettre à jour le domaine

Récupère le domaine de mise à jour de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/@updateDomain"
Code	var ud = RoleEnvironment.CurrentRoleInstance.UpdateDomain;

Domaine d'erreur

Récupère le domaine d’erreur de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/@faultDomain"
Code	var fd = RoleEnvironment.CurrentRoleInstance.FaultDomain;

Nom de rôle

Récupère le nom de rôle des instances.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/@roleName"
Code	var rname = RoleEnvironment.CurrentRoleInstance.Role.Name;

Paramètre de configuration

Récupère la valeur du paramètre de configuration spécifié.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/ConfigurationSettings/ConfigurationSetting[@name='Setting1']/@value"
Code	var setting = RoleEnvironment.GetConfigurationSettingValue("Setting1");

Chemin de stockage local

Récupère le chemin de stockage local de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/LocalResources/LocalResource[@name='LocalStore1']/@path"
Code	var localResourcePath = RoleEnvironment.GetLocalResource("LocalStore1").RootPath;

Taille du stockage local

Récupère la taille du stockage local de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/LocalResources/LocalResource[@name='LocalStore1']/@sizeInMB"
Code	var localResourceSizeInMB = RoleEnvironment.GetLocalResource("LocalStore1").MaximumSizeInMegabytes;

Protocole du point de terminaison

Récupère le protocole du point de terminaison de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/Endpoints/Endpoint[@name='Endpoint1']/@protocol"
Code	var prot = RoleEnvironment.CurrentRoleInstance.InstanceEndpoints["Endpoint1"].Protocol;

IP du point de terminaison

Récupère l'adresse IP du point de terminaison spécifié.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/Endpoints/Endpoint[@name='Endpoint1']/@address"
Code	var address = RoleEnvironment.CurrentRoleInstance.InstanceEndpoints["Endpoint1"].IPEndpoint.Address

Port du point de terminaison

Récupère le port du point de terminaison de l'instance.

Type	Exemple
XPath	xpath="/RoleEnvironment/CurrentInstance/Endpoints/Endpoint[@name='Endpoint1']/@port"
Code	var port = RoleEnvironment.CurrentRoleInstance.InstanceEndpoints["Endpoint1"].IPEndpoint.Port;

Exemple

Voici un exemple de Worker qui crée une tâche de démarrage avec une variable d’environnement nommée TestIsEmulated définie sur la valeur xpath @emulated.

<WorkerRole name="Role1">
    <ConfigurationSettings>
      <Setting name="Setting1" />
    </ConfigurationSettings>
    <LocalResources>
      <LocalStorage name="LocalStore1" sizeInMB="1024"/>
    </LocalResources>
    <Endpoints>
      <InternalEndpoint name="Endpoint1" protocol="tcp" />
    </Endpoints>
    <Startup>
      <Task commandLine="example.cmd inputParm">
        <Environment>
          <Variable name="TestConstant" value="Constant"/>
          <Variable name="TestEmptyValue" value=""/>
          <Variable name="TestIsEmulated">
            <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated"/>
          </Variable>
          ...
        </Environment>
      </Task>
    </Startup>
    <Runtime>
      <Environment>
        <Variable name="TestConstant" value="Constant"/>
        <Variable name="TestEmptyValue" value=""/>
        <Variable name="TestIsEmulated">
          <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated"/>
        </Variable>
        ...
      </Environment>
    </Runtime>
    ...
</WorkerRole>

Étapes suivantes

En savoir plus sur le fichier ServiceConfiguration.cscfg .

Créer un package ServicePackage.cspkg .

Activer le Bureau à distance pour un rôle.

Partager via