Share via

Microsoft.ApiManagement サービス/テナント 2021-12-01-preview

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/tenant@2021-12-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    enabled: bool
    primaryKey: 'string'
    principalId: 'string'
    secondaryKey: 'string'
  }
}

プロパティ値

service/tenant

名前 説明 値
name リソース名

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

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: service
properties テナント アクセス情報の更新パラメーターのプロパティ。 AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

名前 説明 値
enabled 直接アクセスが有効になっているかどうかを判断します。 [bool]
primaryKey プライマリ アクセス キー。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string
principalId プリンシパル (ユーザー) 識別子。 string
secondaryKey セカンダリ アクセス キー。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string

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

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

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/tenant",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "enabled": "bool",
    "primaryKey": "string",
    "principalId": "string",
    "secondaryKey": "string"
  }
}

プロパティ値

service/tenant

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

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties テナント アクセス情報の更新パラメーターのプロパティ。 AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

名前 説明 値
enabled 直接アクセスが有効になっているかどうかを判断します。 [bool]
primaryKey プライマリ アクセス キー。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string
principalId プリンシパル (ユーザー) 識別子。 string
secondaryKey セカンダリ アクセス キー。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/tenant@2021-12-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      primaryKey = "string"
      principalId = "string"
      secondaryKey = "string"
    }
  })
}

プロパティ値

service/tenant

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/tenant@2021-12-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties テナント アクセス情報の更新パラメーターのプロパティ。 AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

名前 説明 値
enabled 直接アクセスが有効になっているかどうかを判断します。 [bool]
primaryKey プライマリ アクセス キー。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string
principalId プリンシパル (ユーザー) 識別子。 string
secondaryKey セカンダリ アクセス キー。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string