com.pulumi.azure.iot.EndpointServicebusQueue 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.iot;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.iot.EndpointServicebusQueueArgs;
import com.pulumi.azure.iot.inputs.EndpointServicebusQueueState;
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 IotHub ServiceBus Queue Endpoint
*
* > **NOTE:** Endpoints can be defined either directly on the `azure.iot.IoTHub` resource, or using the `azurerm_iothub_endpoint_*` resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a `azurerm_iothub_endpoint_*` resource and another endpoint of a different type directly on the `azure.iot.IoTHub` resource is not supported.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* IoTHub ServiceBus Queue Endpoint can be imported using the `resource id`, e.g.
*
* g
*
* ```sh
* $ pulumi import azure:iot/endpointServicebusQueue:EndpointServicebusQueue servicebus_queue1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/endpoints/servicebusqueue_endpoint1
* ```
*
*/
@ResourceType(type="azure:iot/endpointServicebusQueue:EndpointServicebusQueue")
public class EndpointServicebusQueue extends com.pulumi.resources.CustomResource {
/**
* Type used to authenticate against the Service Bus Queue endpoint. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
*
*/
@Export(name="authenticationType", refs={String.class}, tree="[0]")
private Output authenticationType;
/**
* @return Type used to authenticate against the Service Bus Queue endpoint. Possible values are `keyBased` and `identityBased`. Defaults to `keyBased`.
*
*/
public Output> authenticationType() {
return Codegen.optional(this.authenticationType);
}
/**
* The connection string for the endpoint. This attribute can only be specified and is mandatory when `authentication_type` is `keyBased`.
*
*/
@Export(name="connectionString", refs={String.class}, tree="[0]")
private Output connectionString;
/**
* @return The connection string for the endpoint. This attribute can only be specified and is mandatory when `authentication_type` is `keyBased`.
*
*/
public Output> connectionString() {
return Codegen.optional(this.connectionString);
}
/**
* URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when `authentication_type` is `identityBased`.
*
*/
@Export(name="endpointUri", refs={String.class}, tree="[0]")
private Output endpointUri;
/**
* @return URI of the Service Bus endpoint. This attribute can only be specified and is mandatory when `authentication_type` is `identityBased`.
*
*/
public Output> endpointUri() {
return Codegen.optional(this.endpointUri);
}
/**
* Name of the Service Bus Queue. This attribute can only be specified and is mandatory when `authentication_type` is `identityBased`.
*
*/
@Export(name="entityPath", refs={String.class}, tree="[0]")
private Output entityPath;
/**
* @return Name of the Service Bus Queue. This attribute can only be specified and is mandatory when `authentication_type` is `identityBased`.
*
*/
public Output> entityPath() {
return Codegen.optional(this.entityPath);
}
/**
* ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
*
* > **NOTE:** `identity_id` can only be specified when `authentication_type` is `identityBased`. It must be one of the `identity_ids` of the Iot Hub. If not specified when `authentication_type` is `identityBased`, System Assigned Managed Identity of the Iot Hub will be used.
*
*/
@Export(name="identityId", refs={String.class}, tree="[0]")
private Output identityId;
/**
* @return ID of the User Managed Identity used to authenticate against the Service Bus Queue endpoint.
*
* > **NOTE:** `identity_id` can only be specified when `authentication_type` is `identityBased`. It must be one of the `identity_ids` of the Iot Hub. If not specified when `authentication_type` is `identityBased`, System Assigned Managed Identity of the Iot Hub will be used.
*
*/
public Output> identityId() {
return Codegen.optional(this.identityId);
}
/**
* The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
*
*/
@Export(name="iothubId", refs={String.class}, tree="[0]")
private Output iothubId;
/**
* @return The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
*
*/
public Output iothubId() {
return this.iothubId;
}
/**
* The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: `events`, `operationsMonitoringEvents`, `fileNotifications` and `$default`. 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 endpoint. The name must be unique across endpoint types. The following names are reserved: `events`, `operationsMonitoringEvents`, `fileNotifications` and `$default`. Changing this forces a new resource to be created.
*
*/
public Output name() {
return this.name;
}
/**
* The name of the resource group under which the Service Bus Queue has been created. 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 under which the Service Bus Queue has been created. 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 EndpointServicebusQueue(java.lang.String name) {
this(name, EndpointServicebusQueueArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public EndpointServicebusQueue(java.lang.String name, EndpointServicebusQueueArgs 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 EndpointServicebusQueue(java.lang.String name, EndpointServicebusQueueArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:iot/endpointServicebusQueue:EndpointServicebusQueue", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private EndpointServicebusQueue(java.lang.String name, Output id, @Nullable EndpointServicebusQueueState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:iot/endpointServicebusQueue:EndpointServicebusQueue", name, state, makeResourceOptions(options, id), false);
}
private static EndpointServicebusQueueArgs makeArgs(EndpointServicebusQueueArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? EndpointServicebusQueueArgs.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(
"connectionString"
))
.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 EndpointServicebusQueue get(java.lang.String name, Output id, @Nullable EndpointServicebusQueueState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new EndpointServicebusQueue(name, id, state, options);
}
}