Microsoft.ApiManagement サービス/users 2021-12-01-preview
Bicep リソース定義
サービス/ユーザー リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/users リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/users@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
appType: 'string'
confirmation: 'string'
email: 'string'
firstName: 'string'
identities: [
{
id: 'string'
provider: 'string'
}
]
lastName: 'string'
note: 'string'
password: 'string'
state: 'string'
}
}
プロパティ値
service/users
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: service |
| properties | ユーザー エンティティはコントラクト プロパティを作成します。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| appType | ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 | 'developerPortal' 'portal' |
| 確認 | 新しく作成されたユーザーに送信される確認電子メールの種類を決定します。 | 'invite' 'signup' |
| 電子メール アドレス。 空にしないでください。値は、サービス インスタンス内で一意である必要があります。 | string (必須) | |
| firstName | 名。 | string (必須) |
| ID | ユーザー ID のコレクション。 | UserIdentityContract[] |
| lastName | 姓。 | string (必須) |
| note | 管理者によって設定されたユーザーに関するオプションのメモ。 | string |
| password | ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。 | string |
| state | アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。 既定の状態は [アクティブ] です。 | 'active' 'blocked' 'deleted' '保留中' |
UserIdentityContract
| 名前 | 説明 | 値 |
|---|---|---|
| id | プロバイダー内の識別子の値。 | string |
| provider | ID プロバイダー名。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
ARM テンプレート リソース定義
サービス/ユーザー リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/users リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"appType": "string",
"confirmation": "string",
"email": "string",
"firstName": "string",
"identities": [
{
"id": "string",
"provider": "string"
}
],
"lastName": "string",
"note": "string",
"password": "string",
"state": "string"
}
}
プロパティ値
service/users
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ApiManagement/service/users' |
| apiVersion | リソース API のバージョン | '2021-12-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| properties | ユーザー エンティティはコントラクト プロパティを作成します。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| appType | ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 | 'developerPortal' 'portal' |
| 確認 | 新しく作成されたユーザーに送信される確認電子メールの種類を決定します。 | 'invite' 'signup' |
| 電子メール アドレス。 空にしないでください。値は、サービス インスタンス内で一意である必要があります。 | string (必須) | |
| firstName | 名。 | string (必須) |
| ID | ユーザー ID のコレクション。 | UserIdentityContract[] |
| lastName | 姓。 | string (必須) |
| note | 管理者によって設定されたユーザーに関するオプションのメモ。 | string |
| password | ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。 | string |
| state | アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。 既定の状態は [アクティブ] です。 | 'active' 'blocked' 'deleted' '保留中' |
UserIdentityContract
| 名前 | 説明 | 値 |
|---|---|---|
| id | プロバイダー内の識別子の値。 | string |
| provider | ID プロバイダー名。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
Terraform (AzAPI プロバイダー) リソース定義
サービス/ユーザー リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/users リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/users@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
appType = "string"
confirmation = "string"
email = "string"
firstName = "string"
identities = [
{
id = "string"
provider = "string"
}
]
lastName = "string"
note = "string"
password = "string"
state = "string"
}
})
}
プロパティ値
service/users
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ApiManagement/service/users@2021-12-01-preview" |
| name | リソース名 | string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| properties | ユーザー エンティティはコントラクト プロパティを作成します。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| appType | ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 | "developerPortal" "portal" |
| 確認 | 新しく作成されたユーザーに送信される確認電子メールの種類を決定します。 | "invite" "サインアップ" |
| 電子メール アドレス。 空にしないでください。値は、サービス インスタンス内で一意である必要があります。 | string (必須) | |
| firstName | 名。 | string (必須) |
| ID | ユーザー ID のコレクション。 | UserIdentityContract[] |
| lastName | 姓。 | string (必須) |
| note | 管理者によって設定されたユーザーに関するオプションのメモ。 | string |
| password | ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。 | string |
| state | アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされているユーザーは、開発者ポータルにサインインしたり、サブスクライブしている製品の API を呼び出したりできません。 既定の状態は [アクティブ] です。 | "アクティブ" "ブロック" "削除済み" "保留中" |
UserIdentityContract
| 名前 | 説明 | 値 |
|---|---|---|
| id | プロバイダー内の識別子の値。 | string |
| provider | ID プロバイダー名。 | string |