Microsoft.ApiManagement サービス/apiVersionSets

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

プロパティ値

service/apiVersionSets

名前 説明 値
name リソース名

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

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: service
properties API VersionSet コントラクト プロパティ。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名前 説明 値
description API バージョン セットの説明。 string
displayName API バージョン セットの名前 string (必須)
versionHeaderName versioningScheme が に header設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。 string
versioningScheme API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。 'Header'
'Query'
'Segment' (必須)
versionQueryName versioningScheme が に query設定されている場合に API バージョンを示すクエリ パラメーターの名前。 string

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

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

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/apiVersionSets",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

プロパティ値

service/apiVersionSets

名前 説明 値
type リソースの種類 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion リソース API のバージョン '2023-05-01-preview'
name リソース名

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

ApiVersionSetContractProperties

名前 説明 値
description API バージョン セットの説明。 string
displayName API バージョン セットの名前 string (必須)
versionHeaderName versioningScheme が に header設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。 string
versioningScheme API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。 'Header'
'Query'
'Segment' (必須)
versionQueryName versioningScheme が に query設定されている場合に API バージョンを示すクエリ パラメーターの名前。 string

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apiVersionSets@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

プロパティ値

service/apiVersionSets

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/apiVersionSets@2023-05-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties API VersionSet コントラクト プロパティ。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名前 説明 値
description API バージョン セットの説明。 string
displayName API バージョン セットの名前 string (必須)
versionHeaderName versioningScheme が に header設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。 string
versioningScheme API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。 "ヘッダー"
"クエリ"
"Segment" (必須)
versionQueryName versioningScheme が に query設定されている場合に API バージョンを示すクエリ パラメーターの名前。 string