Microsoft.ApiManagement サービス/authorizationProviders/authorizations 2023-05-01-preview
Bicep リソース定義
service/authorizationProviders/authorizations リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/authorizationProviders/authorizations リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders/authorizations@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
authorizationType: 'OAuth2'
error: {
code: 'string'
message: 'string'
}
oauth2grantType: 'string'
parameters: {
{customized property}: 'string'
}
status: 'string'
}
}
プロパティ値
service/authorizationProviders/authorizations
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: authorizationProviders |
| properties | 承認コントラクトのプロパティ。 | AuthorizationContractProperties |
AuthorizationContractProperties
| 名前 | 説明 | 値 |
|---|---|---|
| authorizationType | 承認の種類のオプション | 'OAuth2' |
| error | 承認エラーの詳細。 | AuthorizationError |
| oauth2grantType | OAuth2 許可の種類のオプション | 'AuthorizationCode' 'ClientCredentials' |
| parameters | 承認パラメーター | AuthorizationContractPropertiesParameters |
| status | 承認の状態 | string |
AuthorizationError
| 名前 | 説明 | 値 |
|---|---|---|
| code | エラー コード | string |
| message | エラー メッセージ | string |
AuthorizationContractPropertiesParameters
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | string |
ARM テンプレート リソース定義
service/authorizationProviders/authorizations リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/authorizationProviders/authorizations リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"authorizationType": "OAuth2",
"error": {
"code": "string",
"message": "string"
},
"oauth2grantType": "string",
"parameters": {
"{customized property}": "string"
},
"status": "string"
}
}
プロパティ値
service/authorizationProviders/authorizations
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ApiManagement/service/authorizationProviders/authorizations' |
| apiVersion | リソース API のバージョン | '2023-05-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| properties | 承認コントラクトのプロパティ。 | AuthorizationContractProperties |
AuthorizationContractProperties
| 名前 | 説明 | 値 |
|---|---|---|
| authorizationType | 承認の種類のオプション | 'OAuth2' |
| error | 承認エラーの詳細。 | AuthorizationError |
| oauth2grantType | OAuth2 許可の種類のオプション | 'AuthorizationCode' 'ClientCredentials' |
| parameters | 承認パラメーター | AuthorizationContractPropertiesParameters |
| status | 承認の状態 | string |
AuthorizationError
| 名前 | 説明 | 値 |
|---|---|---|
| code | エラー コード | string |
| message | エラー メッセージ | string |
AuthorizationContractPropertiesParameters
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | string |
Terraform (AzAPI プロバイダー) リソース定義
service/authorizationProviders/authorizations リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/authorizationProviders/authorizations リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/authorizationProviders/authorizations@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
authorizationType = "OAuth2"
error = {
code = "string"
message = "string"
}
oauth2grantType = "string"
parameters = {
{customized property} = "string"
}
status = "string"
}
})
}
プロパティ値
service/authorizationProviders/authorizations
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ApiManagement/service/authorizationProviders/authorizations@2023-05-01-preview" |
| name | リソース名 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: authorizationProviders |
| properties | 承認コントラクトのプロパティ。 | AuthorizationContractProperties |
AuthorizationContractProperties
| 名前 | 説明 | 値 |
|---|---|---|
| authorizationType | 承認の種類のオプション | "OAuth2" |
| error | 承認エラーの詳細。 | AuthorizationError |
| oauth2grantType | OAuth2 許可の種類のオプション | "AuthorizationCode" "ClientCredentials" |
| parameters | 承認パラメーター | AuthorizationContractPropertiesParameters |
| status | 承認の状態 | string |
AuthorizationError
| 名前 | 説明 | 値 |
|---|---|---|
| code | エラー コード | string |
| message | エラー メッセージ | string |
AuthorizationContractPropertiesParameters
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | string |