Microsoft.ApiManagement service/users 2022-08-01
- 最新の を
する - 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Bicep リソース定義
サービス/ユーザー リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/users リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/users@2022-08-01' = {
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
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 Bicepで子リソースの名前と種類 |
string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。 文字で始まり、英数字で終わる。 |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: サービス |
| プロパティ | ユーザー エンティティはコントラクト プロパティを作成します。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名前 | 形容 | 価値 |
|---|---|---|
| appType | ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 | 'developerPortal' 'portal' |
| 確認 | 新しく作成されたユーザーに送信される確認電子メールの種類を決定します。 | 'invite' 'signup' |
| 電子メール | アドレス。 空でなく、サービス インスタンス内で一意である必要があります。 | string (必須) 制約： 最小長 = 1 最大長 = 254 |
| firstName | 名前。 | string (必須) 制約： 最小長 = 1 最大長 = 100 |
| ids | ユーザー ID のコレクション。 | UserIdentityContract[] |
| lastName | 名字。 | string (必須) 制約： 最小長 = 1 最大長 = 100 |
| 手記 | 管理者によって設定されたユーザーに関する省略可能な注意事項。 | 糸 |
| パスワード | ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。 | 糸 |
| 状態 | アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。 既定の状態はアクティブです。 | 'active' 'blocked' 'deleted' 'pending' |
UserIdentityContract
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | プロバイダー内の識別子の値。 | 糸 |
| 供給者 | ID プロバイダー名。 | 糸 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
|
テンプレート を使用して API Management インスタンスとすべてのサブリソースを作成する Azure にデプロイする |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
ARM テンプレート リソース定義
サービス/ユーザー リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/users リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2022-08-01",
"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
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/service/users' |
| apiVersion | リソース API のバージョン | '2022-08-01' |
| 名前 | リソース名 JSON ARM テンプレートで子リソースの名前と型 |
string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。 文字で始まり、英数字で終わる。 |
| プロパティ | ユーザー エンティティはコントラクト プロパティを作成します。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名前 | 形容 | 価値 |
|---|---|---|
| appType | ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 | 'developerPortal' 'portal' |
| 確認 | 新しく作成されたユーザーに送信される確認電子メールの種類を決定します。 | 'invite' 'signup' |
| 電子メール | アドレス。 空でなく、サービス インスタンス内で一意である必要があります。 | string (必須) 制約： 最小長 = 1 最大長 = 254 |
| firstName | 名前。 | string (必須) 制約： 最小長 = 1 最大長 = 100 |
| ids | ユーザー ID のコレクション。 | UserIdentityContract[] |
| lastName | 名字。 | string (必須) 制約： 最小長 = 1 最大長 = 100 |
| 手記 | 管理者によって設定されたユーザーに関する省略可能な注意事項。 | 糸 |
| パスワード | ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。 | 糸 |
| 状態 | アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。 既定の状態はアクティブです。 | 'active' 'blocked' 'deleted' 'pending' |
UserIdentityContract
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | プロバイダー内の識別子の値。 | 糸 |
| 供給者 | ID プロバイダー名。 | 糸 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
|
テンプレート を使用して API Management インスタンスとすべてのサブリソースを作成する Azure にデプロイする |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
Terraform (AzAPI プロバイダー) リソース定義
サービス/ユーザー リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/users リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/users@2022-08-01"
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
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | "Microsoft.ApiManagement/service/users@2022-08-01" |
| 名前 | リソース名 | string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。 文字で始まり、英数字で終わる。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| プロパティ | ユーザー エンティティはコントラクト プロパティを作成します。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名前 | 形容 | 価値 |
|---|---|---|
| appType | ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 | "developerPortal" "portal" |
| 確認 | 新しく作成されたユーザーに送信される確認電子メールの種類を決定します。 | "invite" "signup" |
| 電子メール | アドレス。 空でなく、サービス インスタンス内で一意である必要があります。 | string (必須) 制約： 最小長 = 1 最大長 = 254 |
| firstName | 名前。 | string (必須) 制約： 最小長 = 1 最大長 = 100 |
| ids | ユーザー ID のコレクション。 | UserIdentityContract[] |
| lastName | 名字。 | string (必須) 制約： 最小長 = 1 最大長 = 100 |
| 手記 | 管理者によって設定されたユーザーに関する省略可能な注意事項。 | 糸 |
| パスワード | ユーザー パスワード。 値が指定されていない場合は、既定のパスワードが生成されます。 | 糸 |
| 状態 | アカウントの状態。 ユーザーがアクティブかどうかを指定します。 ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。 既定の状態はアクティブです。 | "active" "blocked" "削除済み" "保留中" |
UserIdentityContract
| 名前 | 形容 | 価値 |
|---|---|---|
| 身分証明書 | プロバイダー内の識別子の値。 | 糸 |
| 供給者 | ID プロバイダー名。 | 糸 |