次の方法で共有

Bicep の string 関数

  • [アーティクル]

この記事では、文字列を操作するための Bicep 関数について説明します。

base64

base64(inputString)

入力文字列の base64 表現を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
inputString はい string Base 64 形式として返す値。

戻り値

base64 形式を含む文字列。

例

次の例では、base64 関数を使用する方法を示します。

param stringData string = 'one, two, three'
param jsonFormattedData string = '{\'one\': \'a\', \'two\': \'b\'}'

var base64String = base64(stringData)
var base64Object = base64(jsonFormattedData)

output base64Output string = base64String
output toStringOutput string = base64ToString(base64String)
output toJsonOutput object = base64ToJson(base64Object)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
base64Output String b25lLCB0d28sIHRocmVl
toStringOutput String one, two, three
toJsonOutput Object {"one": "a", "two": "b"}

base64ToJson

base64ToJson(base64Value)

base64 形式を JSON オブジェクトに変換します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
base64Value はい string JSON オブジェクトに変換する base64 形式。

戻り値

JSON オブジェクト。

例

次の例では、base64ToJson 関数を使用して base64 値を変換します。

param stringData string = 'one, two, three'
param jsonFormattedData string = '{\'one\': \'a\', \'two\': \'b\'}'

var base64String = base64(stringData)
var base64Object = base64(jsonFormattedData)

output base64Output string = base64String
output toStringOutput string = base64ToString(base64String)
output toJsonOutput object = base64ToJson(base64Object)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
base64Output String b25lLCB0d28sIHRocmVl
toStringOutput String one, two, three
toJsonOutput Object {"one": "a", "two": "b"}

base64ToString

base64ToString(base64Value)

base64 形式を文字列に変換します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
base64Value はい string 文字列に変換する base64 形式。

戻り値

変換された base64 値の文字列。

例

次の例では、base64ToString 関数を使用して base64 値を変換します。

param stringData string = 'one, two, three'
param jsonFormattedData string = '{\'one\': \'a\', \'two\': \'b\'}'

var base64String = base64(stringData)
var base64Object = base64(jsonFormattedData)

output base64Output string = base64String
output toStringOutput string = base64ToString(base64String)
output toJsonOutput object = base64ToJson(base64Object)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
base64Output String b25lLCB0d28sIHRocmVl
toStringOutput String one, two, three
toJsonOutput Object {"one": "a", "two": "b"}

concat

concat(arg1, arg2, arg3, ...)

複数の文字列値を結合して連結された文字列を返します。または複数の配列を結合して連結された配列を返します。 読みやすさを向上させるには、concat() 関数の代わりに文字列補間を使用します。 ただし、複数行の文字列の置換など、場合によっては、concat() 関数または replace() 関数の使用にフォールバックする必要があります。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
arg1 はい 文字列または配列 連結の最初の文字列または配列。
その他の引数 いいえ 文字列または配列 連結する順番でのその他の文字列または配列。

この関数は、任意の数の引数を取ることができ、パラメーターに文字列または配列を使用できます。 ただし、パラメーターに配列と文字列の両方を指定することはできません。 文字列は、他の文字列とのみ連結されます。

戻り値

連結された値の文字列または配列。

例

次の例では、補間と concat() 関数の使用を比較しています。 2 つの出力は同じ値を返します。

param prefix string = 'prefix'

output concatOutput string = concat(prefix, 'And', uniqueString(resourceGroup().id))
output interpolationOutput string = '${prefix}And${uniqueString(resourceGroup().id)}'

前の例の出力と既定値は次のとおりです:

名前 Type 値
concatOutput String prefixAnd5yj4yjf5mbg72
interpolationOutput String prefixAnd5yj4yjf5mbg72

現在、複数行の文字列では、補間はサポートされていません。 次の例では、補間と concat() 関数の使用を比較しています。

var blocked = 'BLOCKED'

output concatOutput string = concat('''interpolation
is ''', blocked)
output interpolationOutput string = '''interpolation
is ${blocked}'''

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
concatOutput String interpolation\nis BLOCKED
interpolationOutput String interpolation\nis ${blocked}

contains

contains(container, itemToFind)

配列に値が含まれるかどうか、オブジェクトにキーが含まれるかどうか、または文字列に部分文字列が含まれるかどうかを確認します。 文字列比較では大文字・小文字を区別します。 ただし、オブジェクトにキーが含まれているかどうかをテストする場合、比較で大文字・小文字を区別しません。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
container はい 配列、オブジェクト、文字列 検索対象の値を含む値。
itemToFind はい 文字列または整数 検索対象の値。

戻り値

項目が見つかった場合は True。それ以外の場合は False。

例

次の例では、contains をさまざまな型で使用する方法を示します。

param stringToTest string = 'OneTwoThree'
param objectToTest object = {
  one: 'a'
  two: 'b'
  three: 'c'
}
param arrayToTest array = [
  'one'
  'two'
  'three'
]

output stringTrue bool = contains(stringToTest, 'e')
output stringFalse bool = contains(stringToTest, 'z')
output objectTrue bool = contains(objectToTest, 'one')
output objectFalse bool = contains(objectToTest, 'a')
output arrayTrue bool = contains(arrayToTest, 'three')
output arrayFalse bool = contains(arrayToTest, 'four')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
stringTrue Bool True
stringFalse Bool False
objectTrue Bool True
objectFalse Bool False
arrayTrue Bool True
arrayFalse Bool False

dataUri

dataUri(stringToConvert)

値をデータ URI に変換します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToConvert はい string データ URI に変換する値。

戻り値

データ URI として書式設定された文字列。

例

次の例では、値をデータ URI に変換し、データ URI を文字列に変換します。

param stringToTest string = 'Hello'
param dataFormattedString string = 'data:;base64,SGVsbG8sIFdvcmxkIQ=='

output dataUriOutput string = dataUri(stringToTest)
output toStringOutput string = dataUriToString(dataFormattedString)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
dataUriOutput String data:text/plain;charset=utf8;base64,SGVsbG8=
toStringOutput String Hello, World!

dataUriToString

dataUriToString(dataUriToConvert)

データ URI の形式で書式設定された値を文字列に変換します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
dataUriToConvert はい string 変換するデータ URI 値。

戻り値

変換後の値を含む文字列。

例

次の例では、値をデータ URI に変換し、データ URI を文字列に変換します。

param stringToTest string = 'Hello'
param dataFormattedString string = 'data:;base64,SGVsbG8sIFdvcmxkIQ=='

output dataUriOutput string = dataUri(stringToTest)
output toStringOutput string = dataUriToString(dataFormattedString)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
dataUriOutput String data:text/plain;charset=utf8;base64,SGVsbG8=
toStringOutput String Hello, World!

empty

empty(itemToTest)

配列、オブジェクト、または文字列が空か null かを判断します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
itemToTest はい 配列、オブジェクト、文字列 空または null であるかどうかを確認する値。

戻り値

値が空または null の場合は True を返します。それ以外の場合は False。

例

次の例では、配列、オブジェクト、および文字列が空かどうかを確認します。

param testArray array = []
param testObject object = {}
param testString string = ''
param testNullString string?

output arrayEmpty bool = empty(testArray)
output objectEmpty bool = empty(testObject)
output stringEmpty bool = empty(testString)
output stringNull bool = empty(testNullString)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
arrayEmpty Bool True
objectEmpty Bool True
stringEmpty Bool True
stringNull Bool True

endsWith

endsWith(stringToSearch, stringToFind)

文字列が特定の値で終わるかどうかを判断します。 比較では大文字と小文字は区別されません。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToSearch はい string 検索対象の項目を含む値。
stringToFind はい string 検索対象の値。

戻り値

True 文字列の最後の文字が値と一致する場合。それ以外の場合は False。

例

次の例は、startsWith 関数と endsWith 関数の使用方法を示しています。

output startsTrue bool = startsWith('abcdef', 'ab')
output startsCapTrue bool = startsWith('abcdef', 'A')
output startsFalse bool = startsWith('abcdef', 'e')
output endsTrue bool = endsWith('abcdef', 'ef')
output endsCapTrue bool = endsWith('abcdef', 'F')
output endsFalse bool = endsWith('abcdef', 'e')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
startsTrue Bool True
startsCapTrue Bool True
startsFalse Bool False
endsTrue Bool True
endsCapTrue Bool True
endsFalse Bool False

first

first(arg1)

文字列の最初の文字、または配列の最初の要素を返します。 空の文字列を指定すると、関数の結果は空の文字列になります。 空の配列の場合は、関数では null を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
arg1 はい 配列または文字列 最初の要素または文字を取得する値。

戻り値

文字列の最初の文字、または配列の最初の要素の型 (文字列、整数、配列、またはオブジェクト)。

例

次の例では、first 関数を配列および文字列と共に使用する方法を示します。

param arrayToTest array = [
  'one'
  'two'
  'three'
]

output arrayOutput string = first(arrayToTest)
output stringOutput string = first('One Two Three')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
arrayOutput String one
stringOutput String O

format

format(formatString, arg1, arg2, ...)

入力値から書式設定された文字列を作成します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
formatString はい string 複合の書式設定文字列。
arg1 はい 文字列、整数、またはブール値 書式設定された文字列に含める値。
残りの引数 いいえ 文字列、整数、またはブール値 書式設定された文字列に含める追加の値。

解説

この関数を使用して、Bicep ファイル内の文字列を書式設定します。 .NET 内のSystem.String.Format メソッドと同じ書式設定オプションを使用します。

例

次の例に、書式設定の関数を使用する方法を示します。

param greeting string = 'Hello'
param name string = 'User'
param numberToFormat int = 8175133
param objectToFormat object = { prop: 'value' }

output formatTest string = format('{0}, {1}. Formatted number: {2:N0}', greeting, name, numberToFormat)
output formatObject string = format('objectToFormat: {0}', objectToFormat)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
formatTest String Hello, User. Formatted number: 8,175,133
formatObject String objectToFormat: {'prop':'value'}

guid

guid(baseString, ...)

パラメーターとして指定した値に基づき、グローバル一意識別子の形式で値を作成します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
baseString はい string GUID を作成するためにハッシュ関数で使用される値。
必要に応じて追加のパラメーター いいえ string 文字列をいくつでも追加して、一意性のレベルを指定する値を作成できます。

解説

この関数は、グローバル一意識別子の形式で値を作成する必要がある場合に役立ちます。 結果の一意性のスコープを制限するパラメーターの値を指定します。 サブスクリプション、リソース グループ、またはデプロイのレベルで名前が一意であるかどうかを指定できます。

返される値はランダムな文字列ではなく、パラメーターに対するハッシュ関数の結果になります。 返される値は、36 文字です。 グローバルに一意ではありません。 パラメーターのそのハッシュ値に基づかない新しい GUID を作成するには、newGuid 関数を使用します。

Note

パラメーターの順序は、戻り値に影響します。 たとえば、次のように入力します。

guid('hello', 'world') および guid('world', 'hello')

は同じ値を返しません。

次の例は、guid を使用して、よく使用されるレベルで一意の値を作成する方法を示しています。

サブスクリプションのスコープで一意

guid(subscription().subscriptionId)

リソース グループのスコープで一意

guid(resourceGroup().id)

リソース グループのデプロイのスコープで一意

guid(resourceGroup().id, deployment().name)

guid 関数は RFC 4122 §4.3 からアルゴリズムを実装します。 元のソースは GuidUtility にありますが、一部変更が加えられています。

戻り値

グローバル一意識別子の形式の 36 文字を含む文字列。

例

次の例では、guid からの結果を返します。

output guidPerSubscription string = guid(subscription().subscriptionId)
output guidPerResourceGroup string = guid(resourceGroup().id)
output guidPerDeployment string = guid(resourceGroup().id, deployment().name)

indexOf

indexOf(stringToSearch, stringToFind)

文字列内の値の最初の位置を返します。 比較では大文字と小文字は区別されません。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToSearch はい string 検索対象の項目を含む値。
stringToFind はい string 検索対象の値。

戻り値

検索する項目の位置を表す整数。 値は 0 から始まります。 項目が見つからない場合は、-1 が返されます。

例

次の例は、indexOf 関数と lastIndexOf 関数の使用方法を示しています。

output firstT int = indexOf('test', 't')
output lastT int = lastIndexOf('test', 't')
output firstString int = indexOf('abcdef', 'CD')
output lastString int = lastIndexOf('abcdef', 'AB')
output notFound int = indexOf('abcdef', 'z')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
firstT int 0
lastT int 3
firstString int 2
lastString int 0
notFound int -1

join

join(inputArray, delimiter)

区切り記号を使用して区切って、文字列配列を 1 つの文字列に結合します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
inputArray はい 文字列の配列。 結合する文字列の配列。
delimiter はい 文字列の分割に使用する区切り記号。

戻り値

文字列。

例

次の例では、入力文字列配列をコンマまたはセミコロンで区切られた文字列に結合します。

var arrayString = [
  'one'
  'two'
  'three'
]

output firstOutput string = join(arrayString, ',')
output secondOutput string = join(arrayString, ';')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
firstOutput String "one,two,three"
secondOutput String "one;two;three"

この関数には、Bicep CLI バージョン 0.8.X 以上が必要です。

json

json(arg1)

有効な JSON 文字列を JSON データ型に変換します。 詳細については、JSON 関数を参照してください。

名前空間: sys。

last

last(arg1)

文字列の最後の文字、または配列の最後の要素を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
arg1 はい 配列または文字列 最後の要素または文字を取得する値。

戻り値

文字列の最後の文字、または配列の最後の要素の型 (文字列、整数、配列、またはオブジェクト)。

例

次の例では、last 関数を配列および文字列と共に使用する方法を示します。

param arrayToTest array = [
  'one'
  'two'
  'three'
]

output arrayOutput string = last(arrayToTest)
output stringOutput string = last('One Two Three')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
arrayOutput String three
stringOutput String e

lastIndexOf

lastIndexOf(stringToSearch, stringToFind)

文字列内の値の最後の位置を返します。 比較では大文字と小文字は区別されません。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToSearch はい string 検索対象の項目を含む値。
stringToFind はい string 検索対象の値。

戻り値

検索する項目の最後の位置を表す整数。 値は 0 から始まります。 項目が見つからない場合は、-1 が返されます。

例

次の例では、indexOf 関数および lastIndexOf 関数の使用方法を示します。

output firstT int = indexOf('test', 't')
output lastT int = lastIndexOf('test', 't')
output firstString int = indexOf('abcdef', 'CD')
output lastString int = lastIndexOf('abcdef', 'AB')
output notFound int = indexOf('abcdef', 'z')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
firstT int 0
lastT int 3
firstString int 2
lastString int 0
notFound int -1

length

length(string)

文字列内の文字、配列内の要素、またはオブジェクト内のルート レベル プロパティの数を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
arg1 はい array、string、または object 要素の数を取得するために使用する配列、文字の数を取得するために使用する文字列、またはルート レベル プロパティの数を取得するために使用するオブジェクト。

戻り値

整数。

例

次の例では、length を配列および文字列と共に使用する方法を示します。

param arrayToTest array = [
  'one'
  'two'
  'three'
]
param stringToTest string = 'One Two Three'
param objectToTest object = {
  propA: 'one'
  propB: 'two'
  propC: 'three'
  propD: {
    'propD-1': 'sub'
    'propD-2': 'sub'
  }
}

output arrayLength int = length(arrayToTest)
output stringLength int = length(stringToTest)
output objectLength int = length(objectToTest)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
arrayLength int 3
stringLength int 13
objectLength int 4

newGuid

newGuid()

グローバル一意識別子の形式の値を返します。 この関数は、パラメーターの既定値でのみ使用できます。

名前空間: sys。

解説

この関数は、パラメーターの既定値に対する式の中でのみ使用できます。 この関数を Bicep ファイルのその他の場所で使用すると、エラーが返されます。 Bicep ファイルの他の場所でこの関数を使用することは、呼び出しのたびに異なる値が返されるため、許可されていません。 同じパラメーターで同じ Bicep ファイルをデプロイしても、同じ結果が生成される保証はありません。

newGuid 関数は、パラメーターを受け取らない点が guid 関数と異なります。 guid では、同じパラメーターを使用して呼び出すと、毎回同じ識別子が返されます。 特定の環境に対して同じ GUID を確実に生成する必要がある場合は、guid を使用してください。 テスト環境へのリソースのデプロイなど、毎回異なる識別子が必要なときは、newGuid を使用してください。

newGuid 関数では、.NET Framework 内の Guid 構造を使用して、グローバル一意識別子が生成されます。

以前の正常なデプロイを再デプロイするオプションを使用し、以前のデプロイに newGuid を使用するパラメーターが含まれている場合、パラメーターは再評価されません。 代わりに、以前のデプロイのパラメーター値が、ロールバック デプロイで自動的に再利用されます。

テスト環境では、短時間だけ存在するリソースを繰り返しデプロイすることが必要な場合があります。 一意の名前を構築するのではなく、uniqueString で newGuid を使用して一意の名前を作成できます。

既定値に対する newGuid 関数に依存する Bicep ファイルを再デプロイするときは注意が必要です。 再デプロイを行うときに、パラメーターの値を指定しないと、関数が再評価されます。 新しいリソースを作成するのではなく、既存のリソースを更新する場合は、以前のデプロイのパラメーター値を渡します。

戻り値

グローバル一意識別子の形式の 36 文字を含む文字列。

例

次の例に、新しい識別子を使用するパラメーターを示します。

param guidValue string = newGuid()

output guidOutput string = guidValue

前の例からの出力はデプロイごとに変わりますが、次のようになります。

名前 Type 値
guidOutput string b76a51fc-bd72-4a77-b9a2-3c29e7d2e551

次の例では、newGuid 関数を使用して、ストレージ アカウントの一意の名前を作成します。 この Bicep ファイルは、ストレージ アカウントが短時間だけ存在し、再デプロイされないテスト環境に適しています。

param guidValue string = newGuid()

var storageName = 'storage${uniqueString(guidValue)}'

resource myStorage 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageName
  location: 'West US'
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {}
}

output nameOutput string = storageName

前の例からの出力はデプロイごとに変わりますが、次のようになります。

名前 Type 値
nameOutput string storagenziwvyru7uxie

padLeft

padLeft(valueToPad, totalLength, paddingCharacter)

指定された長さに到達するまで左側に文字を追加していくことで、右揃えの文字列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
valueToPad はい 文字列または整数 右揃えにする値。
totalLength はい INT 返される文字列の文字合計数。
paddingCharacter いいえ 1 文字 左余白の長さに到達するまで使用する文字。 既定値は空白です。

元の文字列が、埋め込まれる文字数よりも長い場合は、文字が追加されません。

戻り値

少なくとも指定した文字数の文字列。

例

次の例では、文字の合計数に達するまでゼロ文字を追加することで、ユーザー指定のパラメーター値を埋め込む方法を示します。

param testString string = '123'

output stringOutput string = padLeft(testString, 10, '0')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
stringOutput String 0000000123

replace

replace(originalString, oldString, newString)

ある文字列のすべてのインスタンスを別の文字列で置き換えた、新しい文字列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
originalString はい string 別の文字列で置き換えられる文字列の全インスタンスを含む値。
oldString はい string 元の文字列から削除する文字列。
newString はい string 削除された文字列の代わりに追加する文字列。

戻り値

文字が置き換えられた文字列。

例

次の例では、ユーザーが指定した文字列からすべてのダッシュを削除し、その文字列の部分を別の文字列に置き換える方法を示します。

param testString string = '123-123-1234'

output firstOutput string = replace(testString, '-', '')
output secondOutput string = replace(testString, '1234', 'xxxx')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
firstOutput String 1231231234
secondOutput String 123-123-xxxx

skip

skip(originalValue, numberToSkip)

指定した文字数の後にあるすべての文字を含む文字列を返します。または、指定した数の要素の後にあるすべての要素を含む配列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
originalValue はい 配列または文字列 スキップ対象の配列または文字列。
numberToSkip はい INT スキップする要素または文字の数。 この値が 0 以下である場合は、値内のすべての要素または文字が返されます。 配列または文字列の長さを超過している場合は、空の配列または文字列が返されます。

戻り値

配列または文字列。

例

次の例では、配列内の指定した数の要素と、文字列内の指定した数の文字をスキップします。

param testArray array = [
  'one'
  'two'
  'three'
]
param elementsToSkip int = 2
param testString string = 'one two three'
param charactersToSkip int = 4

output arrayOutput array = skip(testArray, elementsToSkip)
output stringOutput string = skip(testString, charactersToSkip)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
arrayOutput Array ["three"]
stringOutput String two three

split

split(inputString, delimiter)

指定された区切り記号で区切られた、入力文字列の部分文字列が格納されている、文字列の配列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
inputString はい string 分割する文字列。
delimiter はい 文字列または文字列の配列 文字列の分割に使用する区切り記号。

戻り値

文字列の配列。

例

次の例では、入力文字列をコンマで分割したり、コンマまたはセミコロンで分割したりします。

param firstString string = 'one,two,three'
param secondString string = 'one;two,three'

var delimiters = [
  ','
  ';'
]

output firstOutput array = split(firstString, ',')
output secondOutput array = split(secondString, delimiters)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
firstOutput Array ["one", "two", "three"]
secondOutput Array ["one", "two", "three"]

startsWith

startsWith(stringToSearch, stringToFind)

文字列が特定の値で始まるかどうかを判断します。 比較では大文字と小文字は区別されません。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToSearch はい string 検索対象の項目を含む値。
stringToFind はい string 検索対象の値。

戻り値

True 文字列の最初の文字が値と一致する場合。それ以外の場合は False。

例

次の例は、startsWith 関数と endsWith 関数の使用方法を示しています。

output startsTrue bool = startsWith('abcdef', 'ab')
output startsCapTrue bool = startsWith('abcdef', 'A')
output startsFalse bool = startsWith('abcdef', 'e')
output endsTrue bool = endsWith('abcdef', 'ef')
output endsCapTrue bool = endsWith('abcdef', 'F')
output endsFalse bool = endsWith('abcdef', 'e')

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
startsTrue Bool True
startsCapTrue Bool True
startsFalse Bool False
endsTrue Bool True
endsCapTrue Bool True
endsFalse Bool False

string

string(valueToConvert)

指定した値を文字列に変換します。 文字列は、そのまま返されます。 他の型は、同等の JSON 表現に変換されます。 文字列を JSON に変換する必要がある場合 (引用符またはエスケープなど) は、substring(string([value]), 1, length(string([value]) - 2) を使用できます。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
valueToConvert はい Any 文字列に変換する値。 オブジェクトと配列を含む、あらゆる種類の値を変換できます。

戻り値

変換された値の文字列。

例

次の例では、さまざまな型の値を文字列に変換する方法を示します。

param testObject object = {
  valueA: 10
  valueB: 'Example Text'
}
param testArray array = [
  '\'a\''
  '"b"'
  '\\c\\'
]
param testInt int = 5
param testString string = 'foo " \' \\'

output objectOutput string = string(testObject)
output arrayOutput string = string(testArray)
output intOutput string = string(testInt)
output stringOutput string = string(testString)
output stringEscapedOutput string = substring(string([testString]), 1, length(string([testString])) - 2)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
objectOutput String {"valueA":10,"valueB":"Example Text"}
arrayOutput String ["'a'","\"b\"","\\c\\"]
intOutput String 5
stringOutput String foo " ' \
stringEscapedOutput String "foo \" ' \\"

substring

substring(stringToParse, startIndex, length)

指定した文字位置から始まる指定された文字数分の部分文字列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToParse はい string 部分文字列の抽出元となる文字列。
startIndex いいえ INT 部分文字列の 0 から始まる開始文字位置。
length いいえ INT 部分文字列の文字数。 文字列内の場所を参照する必要があります。 0 以上である必要があります。 省略した場合、開始位置からの文字列の残りの部分が返されます。

戻り値

部分文字列。 または、長さが 0 の場合は空の文字列。

解説

この関数は、部分文字列が文字列の最後を超えるか、または長さが 0 未満のときは失敗します。 次の例は、"インデックス パラメーターと長さパラメーターは文字列内の場所を参照している必要があります。 インデックス パラメーター:'0'、長さパラメーター:'11'、文字列パラメーターの長さ:'10'。" というエラーで失敗します。

param inputString string = '1234567890'

var prefix = substring(inputString, 0, 11)

例

次の例では、パラメーターから部分文字列を抽出します。

param testString string = 'one two three'
output substringOutput string = substring(testString, 4, 3)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
substringOutput String two

take

take(originalValue, numberToTake)

文字列の先頭から指定した数の文字を含む文字列を、または配列の先頭から指定した数の要素を含む配列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
originalValue はい 配列または文字列 要素の取得元となる配列または文字列。
numberToTake はい INT 取得する要素または文字の数。 この値が 0 以下である場合、空の配列または文字列が返されます。 指定された配列または文字列の長さを超過している場合は、その配列または文字列のすべての要素が返されます。

戻り値

配列または文字列。

例

次の例では、指定した数の要素を配列から取得し、指定した数の文字を文字列から取得します。

param testArray array = [
  'one'
  'two'
  'three'
]
param elementsToTake int = 2
param testString string = 'one two three'
param charactersToTake int = 2

output arrayOutput array = take(testArray, elementsToTake)
output stringOutput string = take(testString, charactersToTake)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
arrayOutput Array ["one", "two"]
stringOutput String on

toLower

toLower(stringToChange)

指定された文字列を小文字に変換します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToChange はい string 小文字に変換する値。

戻り値

小文字に変換された文字列。

例

次の例では、パラメーター値を小文字と大文字に変換します。

param testString string = 'One Two Three'

output toLowerOutput string = toLower(testString)
output toUpperOutput string = toUpper(testString)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
toLowerOutput String one two three
toUpperOutput String ONE TWO THREE

toUpper

toUpper(stringToChange)

指定した文字列を大文字に変換します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToChange はい string 大文字に変換する値。

戻り値

大文字に変換された文字列。

例

次の例では、パラメーター値を小文字と大文字に変換します。

param testString string = 'One Two Three'

output toLowerOutput string = toLower(testString)
output toUpperOutput string = toUpper(testString)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
toLowerOutput String one two three
toUpperOutput String ONE TWO THREE

trim

trim(stringToTrim)

指定された文字列から先頭と末尾の空白文字をすべて削除します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToTrim はい string トリムする値。

戻り値

先頭および末尾の空白文字なし文字列です。

例

次の例では、パラメーターから空白文字を削除します。

param testString string = '    one two three   '

output return string = trim(testString)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
戻り値 String one two three

uniqueString

uniqueString(baseString, ...)

パラメーターとして渡された値に基づいて、決定論的ハッシュ文字列を作成します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
baseString はい string 一意の文字列を作成するためにハッシュ関数で使用される値。
必要に応じて追加のパラメーター いいえ string 文字列をいくつでも追加して、一意性のレベルを指定する値を作成できます。

解説

この関数は、リソースの一意の名前を作成する必要がある場合に便利です。 結果の一意性のスコープを制限するパラメーターの値を指定します。 サブスクリプション、リソース グループ、またはデプロイのレベルで名前が一意であるかどうかを指定できます。

返される値はランダムな文字列ではなく、ハッシュ関数の結果になります。 返される値は、13 文字です。 グローバルに一意ではありません。 命名規則にあるプレフィックスをこの値と組み合わせて、わかりやすい名前を作成することもできます。 次の例では、戻り値の形式を示します。 実際の値は、指定されたパラメーターによって異なります。

tcvhiyu5h2o5o

次の例は、uniqueString を使用して、よく使用されるレベルで一意の値を作成する方法を示しています。

サブスクリプションのスコープで一意

uniqueString(subscription().subscriptionId)

リソース グループのスコープで一意

uniqueString(resourceGroup().id)

リソース グループのデプロイのスコープで一意

uniqueString(resourceGroup().id, deployment().name)

次の例は、リソース グループに基づいてストレージ アカウントの一意の名前を作成する方法を示しています。 リソース グループ内では、名前は、同じ方法で作成されると一意ではなくなります。

resource mystorage 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: 'storage${uniqueString(resourceGroup().id)}'
  ...
}

Bicep ファイルをデプロイするたびに一意の新しい名前を作成する必要があり、リソースを更新しない場合は、utcNow 関数と共に uniqueString を使用できます。 この方法は、テスト環境で使用できます。 例については、「utcNow」をご覧ください。 utcNow 関数は、パラメーターの既定値の式内でのみ使用できることにご留意ください。

戻り値

13 文字が含まれる文字列。

例

次の例は、uniquestring から結果を返します。

output uniqueRG string = uniqueString(resourceGroup().id)
output uniqueDeploy string = uniqueString(resourceGroup().id, deployment().name)

uri

uri(baseUri, relativeUri)

baseUri と relativeUri の文字列を組み合わせることにより、絶対 URI を作成します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
baseUri はい string ベース URI 文字列。 この表の後に記述されている、末尾のスラッシュ ("/") の処理に関する動作を注意して確認してください。
relativeUri はい string ベース URI 文字列に追加する相対 URI 文字列。

  • baseUri末尾のスラッシュで終わる場合、結果は単にbaseUri後にrelativeUriが続きます。 relativeUri先頭のスラッシュで始まる場合は、末尾のスラッシュと先頭のスラッシュが 1 つに結合されます。

  • baseUriが末尾のスラッシュで終わらない場合は、2 つのことが起こります。

    • baseUriにスラッシュがまったくない場合 (前面の "//" を除く)、結果は単純にbaseUriされ、その後にrelativeUriが続きます。

    • baseUriにスラッシュがあるが、スラッシュで終わらない場合、最後のスラッシュ以降のすべてがbaseUriから削除され、結果baseUri後にrelativeUriされます。

次に例をいくつか示します。

uri('http://contoso.org/firstpath', 'myscript.sh') -> http://contoso.org/myscript.sh
uri('http://contoso.org/firstpath/', 'myscript.sh') -> http://contoso.org/firstpath/myscript.sh
uri('http://contoso.org/firstpath/', '/myscript.sh') -> http://contoso.org/firstpath/myscript.sh
uri('http://contoso.org/firstpath/azuredeploy.json', 'myscript.sh') -> http://contoso.org/firstpath/myscript.sh
uri('http://contoso.org/firstpath/azuredeploy.json/', 'myscript.sh') -> http://contoso.org/firstpath/azuredeploy.json/myscript.sh

詳細については、 baseUri および relativeUri パラメーターは、 RFC 3986、セクション 5 で指定されているように解決されます。

戻り値

ベース値および相対値の絶対 URI を表す文字列。

例

次の例では、uri、uriComponent、および uriComponentToString を使用する方法を示します。

var uriFormat = uri('http://contoso.com/resources/', 'nested/azuredeploy.json')
var uriEncoded = uriComponent(uriFormat)

output uriOutput string = uriFormat
output componentOutput string = uriEncoded
output toStringOutput string = uriComponentToString(uriEncoded)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
uriOutput String http://contoso.com/resources/nested/azuredeploy.json
componentOutput String http%3A%2F%2Fcontoso.com%2Fresources%2Fnested%2Fazuredeploy.json
toStringOutput String http://contoso.com/resources/nested/azuredeploy.json

uriComponent

uricomponent(stringToEncode)

URI をエンコードします。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
stringToEncode はい string エンコード対象の値。

戻り値

URI エンコードされた値の文字列。

例

次の例では、uri、uriComponent、および uriComponentToString を使用する方法を示します。

var uriFormat = uri('http://contoso.com/resources/', 'nested/azuredeploy.json')
var uriEncoded = uriComponent(uriFormat)

output uriOutput string = uriFormat
output componentOutput string = uriEncoded
output toStringOutput string = uriComponentToString(uriEncoded)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
uriOutput String http://contoso.com/resources/nested/azuredeploy.json
componentOutput String http%3A%2F%2Fcontoso.com%2Fresources%2Fnested%2Fazuredeploy.json
toStringOutput String http://contoso.com/resources/nested/azuredeploy.json

uriComponentToString

uriComponentToString(uriEncodedString)

URI エンコードされた値の文字列を返します。

名前空間: sys。

パラメーター

パラメーター 必須 タイプ 説明
uriEncodedString はい string 文字列に変換する URI エンコードされた値。

戻り値

URI エンコードされた値のデコード済み文字列。

例

次の例では、uri、uriComponent、および uriComponentToString を使用する方法を示します。

var uriFormat = uri('http://contoso.com/resources/', 'nested/azuredeploy.json')
var uriEncoded = uriComponent(uriFormat)

output uriOutput string = uriFormat
output componentOutput string = uriEncoded
output toStringOutput string = uriComponentToString(uriEncoded)

既定値を使用した場合の前の例の出力は次のようになります。

名前 Type 値
uriOutput String http://contoso.com/resources/nested/azuredeploy.json
componentOutput String http%3A%2F%2Fcontoso.com%2Fresources%2Fnested%2Fazuredeploy.json
toStringOutput String http://contoso.com/resources/nested/azuredeploy.json

次のステップ