Microsoft.ApiManagement サービス/users 2018-06-01-preview

• 最新の を する
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

プロパティ値

Microsoft.ApiManagement/service/users

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 パターン = ^[^*#&+:<>?]+$ (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	ユーザー エンティティはコントラクト プロパティを作成します。	UserCreateParameterPropertiesOrUserContractProperties の

UserCreateParameterPropertiesOrUserContractProperties

名前	形容	価値
確認	新しく作成されたユーザーに送信される確認電子メールの種類を決定します。	'invite' 'signup'
電子メール	アドレス。 空でなく、サービス インスタンス内で一意である必要があります。	糸 制約： 最小長 = 1 最大長 = 254 (必須)
firstName	名前。	糸 制約： 最小長 = 1 最大長 = 100 (必須)
ids	ユーザー ID のコレクション。	UserIdentityContract[]
lastName	名字。	糸 制約： 最小長 = 1 最大長 = 100 (必須)
手記	管理者によって設定されたユーザーに関する省略可能な注意事項。	糸
パスワード	ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。	糸
状態	アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。 既定の状態はアクティブです。	'active' 'blocked' 'deleted' 'pending'

UserIdentityContract

名前	形容	価値
身分証明書	プロバイダー内の識別子の値。	糸
供給者	ID プロバイダー名。	糸

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

プロパティ値

Microsoft.ApiManagement/service/users

名前	形容	価値
apiVersion	API のバージョン	'2018-06-01-preview'
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 パターン = ^[^*#&+:<>?]+$ (必須)
プロパティ	ユーザー エンティティはコントラクト プロパティを作成します。	UserCreateParameterPropertiesOrUserContractProperties の
種類	リソースの種類	'Microsoft.ApiManagement/service/users'

UserCreateParameterPropertiesOrUserContractProperties

名前	形容	価値
確認	新しく作成されたユーザーに送信される確認電子メールの種類を決定します。	'invite' 'signup'
電子メール	アドレス。 空でなく、サービス インスタンス内で一意である必要があります。	糸 制約： 最小長 = 1 最大長 = 254 (必須)
firstName	名前。	糸 制約： 最小長 = 1 最大長 = 100 (必須)
ids	ユーザー ID のコレクション。	UserIdentityContract[]
lastName	名字。	糸 制約： 最小長 = 1 最大長 = 100 (必須)
手記	管理者によって設定されたユーザーに関する省略可能な注意事項。	糸
パスワード	ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。	糸
状態	アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。 既定の状態はアクティブです。	'active' 'blocked' 'deleted' 'pending'

UserIdentityContract

名前	形容	価値
身分証明書	プロバイダー内の識別子の値。	糸
供給者	ID プロバイダー名。	糸

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

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

• リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2018-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

プロパティ値

Microsoft.ApiManagement/service/users

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 パターン = ^[^*#&+:<>?]+$ (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	ユーザー エンティティはコントラクト プロパティを作成します。	UserCreateParameterPropertiesOrUserContractProperties の
種類	リソースの種類	"Microsoft.ApiManagement/service/users@2018-06-01-preview"

UserCreateParameterPropertiesOrUserContractProperties

名前	形容	価値
確認	新しく作成されたユーザーに送信される確認電子メールの種類を決定します。	'invite' 'signup'
電子メール	アドレス。 空でなく、サービス インスタンス内で一意である必要があります。	糸 制約： 最小長 = 1 最大長 = 254 (必須)
firstName	名前。	糸 制約： 最小長 = 1 最大長 = 100 (必須)
ids	ユーザー ID のコレクション。	UserIdentityContract[]
lastName	名字。	糸 制約： 最小長 = 1 最大長 = 100 (必須)
手記	管理者によって設定されたユーザーに関する省略可能な注意事項。	糸
パスワード	ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。	糸
状態	アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。 既定の状態はアクティブです。	'active' 'blocked' 'deleted' 'pending'

UserIdentityContract

名前	形容	価値
身分証明書	プロバイダー内の識別子の値。	糸
供給者	ID プロバイダー名。	糸