Datumfuncties voor ARM-sjablonen

Artikel
01/20/2024

In dit artikel worden de functies beschreven voor het werken met datums in uw Azure Resource Manager-sjabloon (ARM-sjabloon).

Tip

We raden Bicep aan omdat het dezelfde mogelijkheden biedt als ARM-sjablonen en de syntaxis gemakkelijker te gebruiken is. Zie datumfuncties voor meer informatie.

dateTimeAdd

dateTimeAdd(base, duration, [format])

Hiermee voegt u een tijdsduur toe aan een basiswaarde. ISO 8601-indeling wordt verwacht.

Gebruik in Bicep de functie dateTimeAdd .

Parameters

Parameter	Vereist	Type	Description
base	Ja	tekenreeks	De begindatum/tijd-waarde voor de optellen. Gebruik de ISO 8601-tijdstempelindeling.
duur	Ja	tekenreeks	De tijdwaarde die moet worden toegevoegd aan de basis. Dit kan een negatieve waarde zijn. Gebruik de ISO 8601-duurnotatie.
indeling	Nee	tekenreeks	De uitvoerindeling voor het resultaat van de datum/tijd. Als deze niet is opgegeven, wordt de notatie van de basiswaarde gebruikt. Gebruik tekenreeksen met standaardindeling of tekenreeksen met aangepaste notatie.

Retourwaarde

De datum/tijd-waarde die het resultaat is van het toevoegen van de duurwaarde aan de basiswaarde.

Opmerkingen

De dateTimeAdd functie neemt geen schrikkeljaren in overweging en P1Y moet worden geïnterpreteerd als P365D, terwijl P1M moet worden geïnterpreteerd als P30D. In de volgende json ziet u enkele voorbeelden:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "addOneYearNonLeap": {
      "type": "string",
      "value": "[dateTimeAdd('2023-01-01 00:00:00Z', 'P1Y')]"  //2024-01-01T00:00:00Z
    },
    "addOneYearLeap": {
      "type": "string",
      "value": "[dateTimeAdd('2024-01-01 00:00:00Z', 'P1Y')]"  //2024-12-31T00:00:00Z
    },
    "addOneMonthNonLeap": {
      "type": "string",
      "value": "[dateTimeAdd('2023-02-01 00:00:00Z', 'P1M')]"  //2023-03-03T00:00:00Z
    },
    "addOneMonthLeap": {
      "type": "string",
      "value": "[dateTimeAdd('2024-02-01 00:00:00Z', 'P1M')]"  //2024-03-02T00:00:00Z
    }
  }
}

In het voorgaande voorbeeld, gezien 2023 als een niet-schrikkeljaar, is het resultaat van het toevoegen van één jaar aan de eerste dag van het jaar 2024-01-01T00:00:00Z. Als u daarentegen één jaar toevoegt aan de begindag van 2024, een schrikkeljaar, resulteert dit in 2024-12-31T00:00:00Z, niet 2025-01-01T00:00:00Z, aangezien een schrikkeljaar 366 dagen omvat in plaats van 365 dagen. Bovendien wordt het onderscheid tussen schrikkeljaren en niet-schrikkeljaren duidelijk wanneer u één maand toevoegt aan de eerste dag van februari, wat leidt tot verschillende dag-van-de-maandresultaten.

Voorbeelden

In de volgende voorbeeldsjabloon ziet u verschillende manieren om tijdwaarden toe te voegen.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "baseTime": {
      "type": "string",
      "defaultValue": "[utcNow('u')]"
    }
  },
  "variables": {
    "add3Years": "[dateTimeAdd(parameters('baseTime'), 'P3Y')]",
    "subtract9Days": "[dateTimeAdd(parameters('baseTime'), '-P9D')]",
    "add1Hour": "[dateTimeAdd(parameters('baseTime'), 'PT1H')]"
  },
  "resources": [],
  "outputs": {
    "add3YearsOutput": {
      "value": "[variables('add3Years')]",
      "type": "string"
    },
    "subtract9DaysOutput": {
      "value": "[variables('subtract9Days')]",
      "type": "string"
    },
    "add1HourOutput": {
      "value": "[variables('add1Hour')]",
      "type": "string"
    }
  }
}

Wanneer de voorgaande sjabloon wordt geïmplementeerd met een basistijd van 2020-04-07 14:53:14Z, is de uitvoer:

Name	Type	Weergegeven als
add3YearsOutput	String	7-4-2023 2:53:14 uur
aftrekken vanDaysOutput	String	29-3-2020 2:53:14
add1HourOutput	String	7-4-2020 17:53:14

In de volgende voorbeeldsjabloon ziet u hoe u de begintijd voor een Automation-planning instelt.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "omsAutomationAccountName": {
      "type": "string",
      "defaultValue": "demoAutomation",
      "metadata": {
        "description": "Use an existing Automation account."
      }
    },
    "scheduleName": {
      "type": "string",
      "defaultValue": "demoSchedule1",
      "metadata": {
        "description": "Name of the new schedule."
      }
    },
    "baseTime": {
      "type": "string",
      "defaultValue": "[utcNow('u')]",
      "metadata": {
        "description": "Schedule will start one hour from this time."
      }
    }
  },
  "variables": {
    "startTime": "[dateTimeAdd(parameters('baseTime'), 'PT1H')]"
  },
  "resources": [
    ...
    {
      "type": "Microsoft.Automation/automationAccounts/schedules",
      "apiVersion": "2022-08-08",
      "name": "[concat(parameters('omsAutomationAccountName'), '/', parameters('scheduleName'))]",

      "properties": {
        "description": "Demo Scheduler",
        "startTime": "[variables('startTime')]",
        "interval": 1,
        "frequency": "Hour"
      }
    }
  ],
  "outputs": {
  }
}

dateTimeFromEpoch

dateTimeFromEpoch(epochTime)

Converteert een geheel getal in een tijdsperiode naar een ISO 8601-datum/tijd.

Gebruik in Bicep de functie dateTimeFromEpoch .

Parameters

Parameter	Vereist	Type	Description
epochTime	Ja	int	De tijdsperiode die moet worden geconverteerd naar een datum/tijd-tekenreeks.

Retourwaarde

Een ISO 8601-tekenreeks voor datum/tijd.

Opmerking

In het volgende voorbeeld ziet u uitvoerwaarden voor de tijdsperiodefuncties.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "convertedEpoch": {
      "type": "int",
      "defaultValue": "[dateTimeToEpoch(dateTimeAdd(utcNow(), 'P1Y'))]"
    }
  },
  "variables": {
    "convertedDatetime": "[dateTimeFromEpoch(parameters('convertedEpoch'))]"
  },
  "resources": [],
  "outputs": {
    "epochValue": {
      "type": "int",
      "value": "[parameters('convertedEpoch')]"
    },
    "datetimeValue": {
      "type": "string",
      "value": "[variables('convertedDatetime')]"
    }
  }
}

De uitvoer is:

Name	Type	Weergegeven als
datetimeValue	String	2023-05-02T15:16:13Z
epochValue	Int	1683040573

dateTimeToEpoch

dateTimeToEpoch(dateTime)

Converteert een ISO 8601-datum/tijd-tekenreeks naar een geheel getal in een periode.

Gebruik in Bicep de functie dateTimeToEpoch .

Parameters

Parameter	Vereist	Type	Description
dateTime	Ja	tekenreeks	De datum/tijd-tekenreeks die moet worden geconverteerd naar een tijdsperiode.

Retourwaarde

Een geheel getal dat het aantal seconden aangeeft van middernacht op 1 januari 1970.

Voorbeelden

In het volgende voorbeeld ziet u uitvoerwaarden voor de tijdsperiodefuncties.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "convertedEpoch": {
      "type": "int",
      "defaultValue": "[dateTimeToEpoch(dateTimeAdd(utcNow(), 'P1Y'))]"
    }
  },
  "variables": {
    "convertedDatetime": "[dateTimeFromEpoch(parameters('convertedEpoch'))]"
  },
  "resources": [],
  "outputs": {
    "epochValue": {
      "type": "int",
      "value": "[parameters('convertedEpoch')]"
    },
    "datetimeValue": {
      "type": "string",
      "value": "[variables('convertedDatetime')]"
    }
  }
}

De uitvoer is:

Name	Type	Weergegeven als
datetimeValue	String	2023-05-02T15:16:13Z
epochValue	Int	1683040573

In het volgende voorbeeld wordt de tijdsduurwaarde gebruikt om de vervaldatum voor een sleutel in een sleutelkluis in te stellen.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.5.6.12127",
      "templateHash": "16023511331197397029"
    }
  },
  "parameters": {
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "The location into which the resources should be deployed."
      }
    },
    "tenantId": {
      "type": "string",
      "defaultValue": "[subscription().tenantId]",
      "metadata": {
        "description": "The Tenant Id that should be used throughout the deployment."
      }
    },
    "userAssignedIdentityName": {
      "type": "string",
      "metadata": {
        "description": "The name of the existing User Assigned Identity."
      }
    },
    "userAssignedIdentityResourceGroupName": {
      "type": "string",
      "metadata": {
        "description": "The name of the resource group for the User Assigned Identity."
      }
    },
    "keyVaultName": {
      "type": "string",
      "defaultValue": "[format('vault-{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the Key Vault."
      }
    },
    "keyVaultKeyName": {
      "type": "string",
      "defaultValue": "cmkey",
      "metadata": {
        "description": "Name of the key in the Key Vault"
      }
    },
    "keyExpiration": {
      "type": "int",
      "defaultValue": "[dateTimeToEpoch(dateTimeAdd(utcNow(), 'P1Y'))]",
      "metadata": {
        "description": "Expiration time of the key"
      }
    },
    "storageAccountName": {
      "type": "string",
      "defaultValue": "[format('storage{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the Storage Account"
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.KeyVault/vaults",
      "apiVersion": "2021-10-01",
      "name": "[parameters('keyVaultName')]",
      "location": "[parameters('location')]",
      "properties": {
        "sku": {
          "name": "standard",
          "family": "A"
        },
        "enableSoftDelete": true,
        "enablePurgeProtection": true,
        "enabledForDiskEncryption": true,
        "tenantId": "[parameters('tenantId')]",
        "accessPolicies": [
          {
            "tenantId": "[parameters('tenantId')]",
            "permissions": {
              "keys": [
                "unwrapKey",
                "wrapKey",
                "get"
              ]
            },
            "objectId": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, parameters('userAssignedIdentityResourceGroupName')), 'Microsoft.ManagedIdentity/userAssignedIdentities', parameters('userAssignedIdentityName')), '2018-11-30').principalId]"
          }
        ]
      }
    },
    {
      "type": "Microsoft.KeyVault/vaults/keys",
      "apiVersion": "2021-10-01",
      "name": "[format('{0}/{1}', parameters('keyVaultName'), parameters('keyVaultKeyName'))]",
      "properties": {
        "attributes": {
          "enabled": true,
          "exp": "[parameters('keyExpiration')]"
        },
        "keySize": 4096,
        "kty": "RSA"
      },
      "dependsOn": [
        "[resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))]"
      ]
    },
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-04-01",
      "name": "[parameters('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "[format('{0}', extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, parameters('userAssignedIdentityResourceGroupName')), 'Microsoft.ManagedIdentity/userAssignedIdentities', parameters('userAssignedIdentityName')))]": {}
        }
      },
      "properties": {
        "accessTier": "Hot",
        "supportsHttpsTrafficOnly": true,
        "minimumTlsVersion": "TLS1_2",
        "encryption": {
          "identity": {
            "userAssignedIdentity": "[extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, parameters('userAssignedIdentityResourceGroupName')), 'Microsoft.ManagedIdentity/userAssignedIdentities', parameters('userAssignedIdentityName'))]"
          },
          "services": {
            "blob": {
              "enabled": true
            }
          },
          "keySource": "Microsoft.Keyvault",
          "keyvaultproperties": {
            "keyname": "[parameters('keyVaultKeyName')]",
            "keyvaulturi": "[if(endsWith(reference(resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))).vaultUri, '/'), substring(reference(resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))).vaultUri, 0, sub(length(reference(resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))).vaultUri), 1)), reference(resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))).vaultUri)]"
          }
        }
      },
      "dependsOn": [
        "[resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))]",
        "[resourceId('Microsoft.KeyVault/vaults/keys', parameters('keyVaultName'), parameters('keyVaultKeyName'))]"
      ]
    }
  ]
}

utcNow

utcNow(format)

Retourneert de huidige datum/tijd-waarde (UTC) in de opgegeven notatie. Als er geen indeling is opgegeven, wordt de ISO 8601(yyyyMMddTHHmmssZ)-indeling gebruikt. Deze functie kan alleen worden gebruikt in de standaardwaarde voor een parameter.

Gebruik in Bicep de functie utcNow .

Parameters

Parameter	Vereist	Type	Description
indeling	Nee	tekenreeks	De gecodeerde URI-waarde die moet worden geconverteerd naar een tekenreeks. Gebruik tekenreeksen met standaardindeling of tekenreeksen met aangepaste notatie.

Opmerkingen

U kunt deze functie alleen gebruiken in een expressie voor de standaardwaarde van een parameter. Als u deze functie ergens anders in een sjabloon gebruikt, wordt een fout geretourneerd. De functie is niet toegestaan in andere delen van de sjabloon, omdat deze elke keer dat deze wordt aangeroepen een andere waarde retourneert. Het implementeren van dezelfde sjabloon met dezelfde parameters zou niet betrouwbaar dezelfde resultaten opleveren.

Als u de optie gebruikt om een fout terug te draaien naar een eerdere geslaagde implementatie en de eerdere implementatie een parameter bevat die wordt gebruikt utcNow, wordt de parameter niet opnieuw geëvalueerd. In plaats daarvan wordt de parameterwaarde van de eerdere implementatie automatisch opnieuw gebruikt in de rollback-implementatie.

Wees voorzichtig met het opnieuw implementeren van een sjabloon die afhankelijk is van de utcNow functie voor een standaardwaarde. Wanneer u de parameter opnieuw implementeert en geen waarde opgeeft, wordt de functie opnieuw geëvalueerd. Als u een bestaande resource wilt bijwerken in plaats van een nieuwe resource te maken, geeft u de parameterwaarde van de eerdere implementatie door.

Retourwaarde

De huidige UTC-datum/tijd-waarde.

Voorbeelden

In de volgende voorbeeldsjabloon ziet u verschillende notaties voor de datum/tijd-waarde.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "utcValue": {
      "type": "string",
      "defaultValue": "[utcNow()]"
    },
    "utcShortValue": {
      "type": "string",
      "defaultValue": "[utcNow('d')]"
    },
    "utcCustomValue": {
      "type": "string",
      "defaultValue": "[utcNow('M d')]"
    }
  },
  "resources": [
  ],
  "outputs": {
    "utcOutput": {
      "type": "string",
      "value": "[parameters('utcValue')]"
    },
    "utcShortOutput": {
      "type": "string",
      "value": "[parameters('utcShortValue')]"
    },
    "utcCustomOutput": {
      "type": "string",
      "value": "[parameters('utcCustomValue')]"
    }
  }
}

De uitvoer van het vorige voorbeeld varieert voor elke implementatie, maar is vergelijkbaar met:

Name	Type	Weergegeven als
utcOutput	tekenreeks	20190305T175318Z
utcShortOutput	tekenreeks	03/05/2019
utcCustomOutput	tekenreeks	3 5

In het volgende voorbeeld ziet u hoe u een waarde van de functie gebruikt bij het instellen van een tagwaarde.

{
  "$schema": "https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "utcShort": {
      "type": "string",
      "defaultValue": "[utcNow('d')]"
    },
    "rgName": {
      "type": "string"
    }
  },
  "resources": [
    {
      "type": "Microsoft.Resources/resourceGroups",
      "apiVersion": "2021-04-01",
      "name": "[parameters('rgName')]",
      "location": "westeurope",
      "tags": {
        "createdDate": "[parameters('utcShort')]"
      },
      "properties": {}
    }
  ],
  "outputs": {
    "utcShortOutput": {
      "type": "string",
      "value": "[parameters('utcShort')]"
    }
  }
}

Volgende stappen

Zie De structuur en syntaxis van ARM-sjablonen begrijpen voor een beschrijving van de secties in een ARM-sjabloon.

Datumfuncties voor ARM-sjablonen

dateTimeAdd

Parameters

Retourwaarde

Opmerkingen

Voorbeelden

dateTimeFromEpoch

Parameters

Retourwaarde

Opmerking

dateTimeToEpoch

Parameters

Retourwaarde

Voorbeelden

utcNow

Parameters

Opmerkingen

Retourwaarde

Voorbeelden

Volgende stappen

Aanvullende resources