Microsoft.ApiManagement サービス/グループ 2021-08-01

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

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

プロパティ値

service/groups

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

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

文字制限: 1 ~ 80

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

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

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

GroupCreateParametersPropertiesOrGroupContractProper...

名前 形容 価値
形容 グループの説明。 糸
displayName グループ名。 string (必須)

制約：
最小長 = 1
最大長 = 300
externalId 外部グループの識別子。このプロパティには、Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}の場合など、外部 ID プロバイダーからのグループの ID が含まれます。それ以外の場合、値は null です。 糸
種類 グループの種類。 'custom'
'external'
'system'

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

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

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

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

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

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

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

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

リソースの形式

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

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

プロパティ値

service/groups

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

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

文字制限: 1 ~ 80

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

文字で始まり、英数字で終わる。
プロパティ グループの作成操作に指定されたプロパティ。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名前 形容 価値
形容 グループの説明。 糸
displayName グループ名。 string (必須)

制約：
最小長 = 1
最大長 = 300
externalId 外部グループの識別子。このプロパティには、Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}の場合など、外部 ID プロバイダーからのグループの ID が含まれます。それ以外の場合、値は null です。 糸
種類 グループの種類。 'custom'
'external'
'system'

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

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

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

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

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

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

  • リソース グループの

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

リソースの形式

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

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

プロパティ値

service/groups

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/groups@2021-08-01"
名前 リソース名 string (必須)

文字制限: 1 ~ 80

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

文字で始まり、英数字で終わる。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ グループの作成操作に指定されたプロパティ。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名前 形容 価値
形容 グループの説明。 糸
displayName グループ名。 string (必須)

制約：
最小長 = 1
最大長 = 300
externalId 外部グループの識別子。このプロパティには、Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}の場合など、外部 ID プロバイダーからのグループの ID が含まれます。それ以外の場合、値は null です。 糸
種類 グループの種類。 "custom"
"external"
"system"