次の方法で共有

Microsoft.ApiManagement サービス/namedValues 2021-08-01

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

プロパティ値

service/namedValues

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

Bicepで子リソースの名前と種類 設定する方法を参照してください。		 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

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

NamedValueCreateContractPropertiesOrNamedValueContra...

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

制約：
最小長 = 1
最大長 = 256
パターン = ^[A-Za-z0-9-._]+$
keyVault namedValue の KeyVault の場所の詳細。 KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
秘密 値がシークレットであり、暗号化する必要があるかどうかを判断します。 既定値は false です。 bool
タグ 指定された場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 string[]

制約：
最大長 = 32
価値 NamedValue の値。 ポリシー式を含めることができます。 空白ではないか、空白のみで構成されている場合があります。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 糸

制約：
最大長 = 4096

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

名前 形容 価値
identityClientId SystemAssignedIdentity の場合は Null、UserAssignedIdentity のクライアント ID はキー コンテナー シークレットへのアクセスに使用されます。 糸
secretIdentifier シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 そのためには、API Management サービスを aka.ms/apimmsi で構成する必要があります 糸

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

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

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

Azure にデプロイする 		このテンプレートは、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": "2021-08-01",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

プロパティ値

service/namedValues

名前 形容 価値
種類 リソースの種類 'Microsoft.ApiManagement/service/namedValues'
apiVersion リソース API のバージョン '2021-08-01'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。		 string (必須)
プロパティ PUT 操作の NamedValue エンティティ コントラクト プロパティ。 NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

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

制約：
最小長 = 1
最大長 = 256
パターン = ^[A-Za-z0-9-._]+$
keyVault namedValue の KeyVault の場所の詳細。 KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
秘密 値がシークレットであり、暗号化する必要があるかどうかを判断します。 既定値は false です。 bool
タグ 指定された場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 string[]

制約：
最大長 = 32
価値 NamedValue の値。 ポリシー式を含めることができます。 空白ではないか、空白のみで構成されている場合があります。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 糸

制約：
最大長 = 4096

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

名前 形容 価値
identityClientId SystemAssignedIdentity の場合は Null、UserAssignedIdentity のクライアント ID はキー コンテナー シークレットへのアクセスに使用されます。 糸
secretIdentifier シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 そのためには、API Management サービスを aka.ms/apimmsi で構成する必要があります 糸

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

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

テンプレート 形容
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@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

プロパティ値

service/namedValues

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/namedValues@2021-08-01"
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ PUT 操作の NamedValue エンティティ コントラクト プロパティ。 NamedValueCreateContractPropertiesOrNamedValueContra...

NamedValueCreateContractPropertiesOrNamedValueContra...

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

制約：
最小長 = 1
最大長 = 256
パターン = ^[A-Za-z0-9-._]+$
keyVault namedValue の KeyVault の場所の詳細。 KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
秘密 値がシークレットであり、暗号化する必要があるかどうかを判断します。 既定値は false です。 bool
タグ 指定された場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。 string[]

制約：
最大長 = 32
価値 NamedValue の値。 ポリシー式を含めることができます。 空白ではないか、空白のみで構成されている場合があります。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 糸

制約：
最大長 = 4096

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

名前 形容 価値
identityClientId SystemAssignedIdentity の場合は Null、UserAssignedIdentity のクライアント ID はキー コンテナー シークレットへのアクセスに使用されます。 糸
secretIdentifier シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 そのためには、API Management サービスを aka.ms/apimmsi で構成する必要があります 糸