com.pulumi.azure.apimanagement.OpenIdConnectProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.apimanagement;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.apimanagement.OpenIdConnectProviderArgs;
import com.pulumi.azure.apimanagement.inputs.OpenIdConnectProviderState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages an OpenID Connect Provider within a API Management Service.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.apimanagement.Service;
* import com.pulumi.azure.apimanagement.ServiceArgs;
* import com.pulumi.azure.apimanagement.OpenIdConnectProvider;
* import com.pulumi.azure.apimanagement.OpenIdConnectProviderArgs;
* 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 }{{@code
* public static void main(String[] args) }{{@code
* Pulumi.run(App::stack);
* }}{@code
*
* public static void stack(Context ctx) }{{@code
* var example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
*
* var exampleService = new Service("exampleService", ServiceArgs.builder()
* .name("example-apim")
* .location(example.location())
* .resourceGroupName(example.name())
* .publisherName("My Company")
* .publisherEmail("company}{@literal @}{@code exmaple.com")
* .skuName("Developer_1")
* .build());
*
* var exampleOpenIdConnectProvider = new OpenIdConnectProvider("exampleOpenIdConnectProvider", OpenIdConnectProviderArgs.builder()
* .name("example-provider")
* .apiManagementName(exampleService.name())
* .resourceGroupName(example.name())
* .clientId("00001111-2222-3333-4444-555566667777")
* .clientSecret("00001111-423egvwdcsjx-00001111")
* .displayName("Example Provider")
* .metadataEndpoint("https://example.com/example")
* .build());
*
* }}{@code
* }}{@code
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* API Management OpenID Connect Providers can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:apimanagement/openIdConnectProvider:OpenIdConnectProvider example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/openidConnectProviders/provider1
* ```
*
*/
@ResourceType(type="azure:apimanagement/openIdConnectProvider:OpenIdConnectProvider")
public class OpenIdConnectProvider extends com.pulumi.resources.CustomResource {
/**
* The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
*
*/
@Export(name="apiManagementName", refs={String.class}, tree="[0]")
private Output apiManagementName;
/**
* @return The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
*
*/
public Output apiManagementName() {
return this.apiManagementName;
}
/**
* The Client ID used for the Client Application.
*
*/
@Export(name="clientId", refs={String.class}, tree="[0]")
private Output clientId;
/**
* @return The Client ID used for the Client Application.
*
*/
public Output clientId() {
return this.clientId;
}
/**
* The Client Secret used for the Client Application.
*
*/
@Export(name="clientSecret", refs={String.class}, tree="[0]")
private Output clientSecret;
/**
* @return The Client Secret used for the Client Application.
*
*/
public Output clientSecret() {
return this.clientSecret;
}
/**
* A description of this OpenID Connect Provider.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> description;
/**
* @return A description of this OpenID Connect Provider.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* A user-friendly name for this OpenID Connect Provider.
*
*/
@Export(name="displayName", refs={String.class}, tree="[0]")
private Output displayName;
/**
* @return A user-friendly name for this OpenID Connect Provider.
*
*/
public Output displayName() {
return this.displayName;
}
/**
* The URI of the Metadata endpoint.
*
*/
@Export(name="metadataEndpoint", refs={String.class}, tree="[0]")
private Output metadataEndpoint;
/**
* @return The URI of the Metadata endpoint.
*
*/
public Output metadataEndpoint() {
return this.metadataEndpoint;
}
/**
* the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
*
*/
public Output name() {
return this.name;
}
/**
* The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public OpenIdConnectProvider(java.lang.String name) {
this(name, OpenIdConnectProviderArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public OpenIdConnectProvider(java.lang.String name, OpenIdConnectProviderArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public OpenIdConnectProvider(java.lang.String name, OpenIdConnectProviderArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:apimanagement/openIdConnectProvider:OpenIdConnectProvider", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private OpenIdConnectProvider(java.lang.String name, Output id, @Nullable OpenIdConnectProviderState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:apimanagement/openIdConnectProvider:OpenIdConnectProvider", name, state, makeResourceOptions(options, id), false);
}
private static OpenIdConnectProviderArgs makeArgs(OpenIdConnectProviderArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? OpenIdConnectProviderArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.additionalSecretOutputs(List.of(
"clientId",
"clientSecret"
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static OpenIdConnectProvider get(java.lang.String name, Output id, @Nullable OpenIdConnectProviderState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new OpenIdConnectProvider(name, id, state, options);
}
}