AuthorizationArgs

data class AuthorizationArgs(val authorizationId: Output<String>? = null, val authorizationProviderId: Output<String>? = null, val authorizationType: Output<Either<String, AuthorizationType>>? = null, val error: Output<AuthorizationErrorArgs>? = null, val oAuth2GrantType: Output<Either<String, OAuth2GrantType>>? = null, val parameters: Output<Map<String, String>>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val status: Output<String>? = null) : ConvertibleToJava<AuthorizationArgs>

Authorization contract. Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01. Other available API versions: 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

ApiManagementCreateAuthorizationAADAuthCode

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var authorization = new AzureNative.ApiManagement.Authorization("authorization", new()
{
AuthorizationId = "authz2",
AuthorizationProviderId = "aadwithauthcode",
AuthorizationType = AzureNative.ApiManagement.AuthorizationType.OAuth2,
OAuth2GrantType = AzureNative.ApiManagement.OAuth2GrantType.AuthorizationCode,
ResourceGroupName = "rg1",
ServiceName = "apimService1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewAuthorization(ctx, "authorization", &apimanagement.AuthorizationArgs{
AuthorizationId: pulumi.String("authz2"),
AuthorizationProviderId: pulumi.String("aadwithauthcode"),
AuthorizationType: pulumi.String(apimanagement.AuthorizationTypeOAuth2),
OAuth2GrantType: pulumi.String(apimanagement.OAuth2GrantTypeAuthorizationCode),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Authorization;
import com.pulumi.azurenative.apimanagement.AuthorizationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var authorization = new Authorization("authorization", AuthorizationArgs.builder()
.authorizationId("authz2")
.authorizationProviderId("aadwithauthcode")
.authorizationType("OAuth2")
.oAuth2GrantType("AuthorizationCode")
.resourceGroupName("rg1")
.serviceName("apimService1")
.build());
}
}

ApiManagementCreateAuthorizationAADClientCred

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var authorization = new AzureNative.ApiManagement.Authorization("authorization", new()
{
AuthorizationId = "authz1",
AuthorizationProviderId = "aadwithclientcred",
AuthorizationType = AzureNative.ApiManagement.AuthorizationType.OAuth2,
OAuth2GrantType = AzureNative.ApiManagement.OAuth2GrantType.AuthorizationCode,
Parameters =
{
{ "clientId", "53790925-fdd3-4b80-bc7a-4c3aaf25801d" },
{ "clientSecret", "xxxxxxxxxxxxxxx~xxxxxxxxx" },
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewAuthorization(ctx, "authorization", &apimanagement.AuthorizationArgs{
AuthorizationId: pulumi.String("authz1"),
AuthorizationProviderId: pulumi.String("aadwithclientcred"),
AuthorizationType: pulumi.String(apimanagement.AuthorizationTypeOAuth2),
OAuth2GrantType: pulumi.String(apimanagement.OAuth2GrantTypeAuthorizationCode),
Parameters: pulumi.StringMap{
"clientId": pulumi.String("53790925-fdd3-4b80-bc7a-4c3aaf25801d"),
"clientSecret": pulumi.String("xxxxxxxxxxxxxxx~xxxxxxxxx"),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Authorization;
import com.pulumi.azurenative.apimanagement.AuthorizationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var authorization = new Authorization("authorization", AuthorizationArgs.builder()
.authorizationId("authz1")
.authorizationProviderId("aadwithclientcred")
.authorizationType("OAuth2")
.oAuth2GrantType("AuthorizationCode")
.parameters(Map.ofEntries(
Map.entry("clientId", "53790925-fdd3-4b80-bc7a-4c3aaf25801d"),
Map.entry("clientSecret", "xxxxxxxxxxxxxxx~xxxxxxxxx")
))
.resourceGroupName("rg1")
.serviceName("apimService1")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:Authorization authz1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}

Constructors

Link copied to clipboard
constructor(authorizationId: Output<String>? = null, authorizationProviderId: Output<String>? = null, authorizationType: Output<Either<String, AuthorizationType>>? = null, error: Output<AuthorizationErrorArgs>? = null, oAuth2GrantType: Output<Either<String, OAuth2GrantType>>? = null, parameters: Output<Map<String, String>>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, status: Output<String>? = null)

Properties

Link copied to clipboard
val authorizationId: Output<String>? = null

Identifier of the authorization.

Link copied to clipboard
val authorizationProviderId: Output<String>? = null

Identifier of the authorization provider.

Link copied to clipboard
val authorizationType: Output<Either<String, AuthorizationType>>? = null

Authorization type options

Link copied to clipboard
val error: Output<AuthorizationErrorArgs>? = null

Authorization error details.

Link copied to clipboard
val oAuth2GrantType: Output<Either<String, OAuth2GrantType>>? = null

OAuth2 grant type options

Link copied to clipboard
val parameters: Output<Map<String, String>>? = null

Authorization parameters

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the API Management service.

Link copied to clipboard
val status: Output<String>? = null

Status of the Authorization

Functions

Link copied to clipboard
open override fun toJava(): AuthorizationArgs