次の方法で共有


Microsoft.ApiManagement サービス/namedValues 2019-12-01-preview

Bicep リソース定義

service/namedValues リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/namedValues リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2019-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

プロパティ値

Microsoft.ApiManagement/service/namedValues

名前 形容 価値
名前 リソース名

制約:
最大長 = 256
パターン = ^[^*#&+:<>?]+$ (必須)
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: サービス
プロパティ PUT 操作の NamedValue エンティティ コントラクト プロパティ。 NamedValueCreateContractPropertiesOrNamedValueContractProperties

NamedValueCreateContractPropertiesOrNamedValueContractProperties

名前 形容 価値
displayName NamedValue の一意の名前。 文字、数字、ピリオド、ダッシュ、アンダースコアのみを含めることができます。

制約:
最小長 = 1
最大長 = 256
パターン = ^[A-Za-z0-9-._]+$ (必須)
秘密 値がシークレットであり、暗号化する必要があるかどうかを判断します。 既定値は false です。 bool
タグ 指定された場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 string[]
価値 NamedValue の値。 ポリシー式を含めることができます。 空白ではないか、空白のみで構成されている場合があります。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。

制約:
最小長 = 1
最大長 = 4096 (必須)

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル 形容
API Management の配信元 を使用した Front Door Standard/Premium の このテンプレートは、Front Door Premium と API Management インスタンスを作成し、NSG とグローバル API Management ポリシーを使用して、トラフィックが Front Door の配信元を通過したことを検証します。

ARM テンプレート リソース定義

service/namedValues リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/namedValues リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ApiManagement/service/namedValues",
  "apiVersion": "2019-12-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

プロパティ値

Microsoft.ApiManagement/service/namedValues

名前 形容 価値
apiVersion API のバージョン '2019-12-01-preview'
名前 リソース名

制約:
最大長 = 256
パターン = ^[^*#&+:<>?]+$ (必須)
プロパティ PUT 操作の NamedValue エンティティ コントラクト プロパティ。 NamedValueCreateContractPropertiesOrNamedValueContractProperties
種類 リソースの種類 'Microsoft.ApiManagement/service/namedValues'

NamedValueCreateContractPropertiesOrNamedValueContractProperties

名前 形容 価値
displayName NamedValue の一意の名前。 文字、数字、ピリオド、ダッシュ、アンダースコアのみを含めることができます。

制約:
最小長 = 1
最大長 = 256
パターン = ^[A-Za-z0-9-._]+$ (必須)
秘密 値がシークレットであり、暗号化する必要があるかどうかを判断します。 既定値は false です。 bool
タグ 指定された場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 string[]
価値 NamedValue の値。 ポリシー式を含めることができます。 空白ではないか、空白のみで構成されている場合があります。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。

制約:
最小長 = 1
最大長 = 4096 (必須)

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
API Management の配信元 を使用した Front Door Standard/Premium の

Azure
にデプロイする
このテンプレートは、Front Door Premium と API Management インスタンスを作成し、NSG とグローバル API Management ポリシーを使用して、トラフィックが Front Door の配信元を通過したことを検証します。

Terraform (AzAPI プロバイダー) リソース定義

service/namedValues リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/namedValues リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/namedValues@2019-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

プロパティ値

Microsoft.ApiManagement/service/namedValues

名前 形容 価値
名前 リソース名

制約:
最大長 = 256
パターン = ^[^*#&+:<>?]+$ (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ PUT 操作の NamedValue エンティティ コントラクト プロパティ。 NamedValueCreateContractPropertiesOrNamedValueContractProperties
種類 リソースの種類 "Microsoft.ApiManagement/service/namedValues@2019-12-01-preview"

NamedValueCreateContractPropertiesOrNamedValueContractProperties

名前 形容 価値
displayName NamedValue の一意の名前。 文字、数字、ピリオド、ダッシュ、アンダースコアのみを含めることができます。

制約:
最小長 = 1
最大長 = 256
パターン = ^[A-Za-z0-9-._]+$ (必須)
秘密 値がシークレットであり、暗号化する必要があるかどうかを判断します。 既定値は false です。 bool
タグ 指定された場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 string[]
価値 NamedValue の値。 ポリシー式を含めることができます。 空白ではないか、空白のみで構成されている場合があります。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。

制約:
最小長 = 1
最大長 = 4096 (必須)