Share via

Microsoft.ApiManagement サービス/グループ 2022-04-01-preview

  • [アーティクル]

Bicep リソース定義

サービス/グループ のリソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/groups@2022-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

プロパティ値

service/groups

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: service
properties グループの作成操作に指定されたプロパティ。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名前 説明 値
description グループの説明。 string
displayName [グループ名]: string (必須)
externalId 外部グループの識別子。このプロパティには、Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}の場合など、外部 ID プロバイダーからのグループの ID が含まれます。それ以外の場合、値は null です。 string
type [グループの種類]。 'custom'
'external'
'system'

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

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

Template 説明
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する

Azure にデプロイする		 このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します

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

サービス/グループ のリソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/groups",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalId": "string",
    "type": "string"
  }
}

プロパティ値

service/groups

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

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
properties グループの作成操作に指定されたプロパティ。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名前 説明 値
description グループの説明。 string
displayName [グループ名]: string (必須)
externalId 外部グループの識別子。このプロパティには、Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}の場合など、外部 ID プロバイダーのグループの ID が含まれます。それ以外の場合は値が null です。 string
type [グループの種類]。 'custom'
'external'
'system'

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

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

Template 説明
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する

Azure にデプロイする		 このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します

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

サービス/グループ リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/groups@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  })
}

プロパティ値

service/groups

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/groups@2022-04-01-preview"
name リソース名 string (必須)

文字制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties グループの作成操作に指定されたプロパティ。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名前 説明 値
description グループの説明。 string
displayName [グループ名]: string (必須)
externalId 外部グループの識別子。このプロパティには、Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}の場合など、外部 ID プロバイダーのグループの ID が含まれます。それ以外の場合は値が null です。 string
type [グループの種類]。 "custom"
"external"
"system"